com.uc4.communication.requests

Class GetOutputDirectory.OutputDirectoryItem

java.lang.Object

com.uc4.communication.requests.GetOutputDirectory.OutputDirectoryItem

Enclosing class:

GetOutputDirectory

public static class GetOutputDirectory.OutputDirectoryItem
extends java.lang.Object

This class represents a single row in the Output directory. It contains information about a report (file name, type, report id).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayType() Returns the display text of this report.
java.lang.String	getFile() Returns the file name of this report or an empty String.
java.lang.String	getReportID() Returns the ID of this report.
boolean	isInUC4DB() Returns true if the report is stored in the UC4 database; false otherwise.
boolean	isOnAgent() Returns true if the report is stored in the filesystem where the Agent runs; false otherwise.
boolean	isRequiresLogin() Returns true if access to the report requires a login.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFile

public java.lang.String getFile()

Returns the file name of this report or an empty String.

Returns:

File name

getDisplayType

public java.lang.String getDisplayType()

Returns the display text of this report. For example "External Job output" or "Report"

Returns:

Display Text

getReportID

public java.lang.String getReportID()

Returns the ID of this report.

Returns:

Report ID

isOnAgent

public boolean isOnAgent()

Returns true if the report is stored in the filesystem where the Agent runs; false otherwise.

Returns:

Report on Agent side

isInUC4DB

public boolean isInUC4DB()

Returns true if the report is stored in the UC4 database; false otherwise.

Returns:

Report in UC4 Database

isRequiresLogin

public boolean isRequiresLogin()

Returns true if access to the report requires a login. The return value is false if the report is not protected by a login.

Returns:

Requires user's login