A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 

G

general() - Method in class com.uc4.api.objects.JobPlanTask
This methdo provides access to the "General" tab of a ProcessFlow task.
general() - Method in class com.uc4.communication.Settings
This method provides access to the general settings.
GeneralSettings - Class in com.uc4.communication
This class represents the general settings.
GeneralSettings.MagneticWindows - Enum in com.uc4.communication
Setting for magnetic windows.
GeneralSettings.ToolbarLabel - Enum in com.uc4.communication
Toolbar label location.
GenericStatistics - Class in com.uc4.communication.requests
Generic Statistics search.
GenericStatistics() - Constructor for class com.uc4.communication.requests.GenericStatistics
Constructs a GenericStatistics.
get(String) - Method in class com.uc4.api.objects.OCVPanel
Gets a value from by its unique name.
get(String) - Method in class com.uc4.api.objects.Variable
Returns the value for the given validity keyword.
get(String) - Method in class com.uc4.api.objects.VariableValues
Returns the value for a given key The method returns null if the key does not exist.
get(String) - Static method in enum com.uc4.communication.KickEventType
Converts a Kick type as String to a KickEventType.
get(String) - Method in class com.uc4.communication.requests.GetStaticVaraRows
Returns the value for the given validity keyword.
getAbapConnection() - Method in class com.uc4.api.objects.SAPAgentPanel
 
getAbendAction() - Method in class com.uc4.api.objects.SyncItem
Returns the action that should be carried out when the task ends abnormally.
getAbortCount() - Method in class com.uc4.api.TrafficLight
Returns the number of aborted tasks.
getAccess() - Method in class com.uc4.api.objects.UC4Object
Returns if this object is opened read only.
getAccess() - Method in class com.uc4.communication.requests.CheckAuthorizations.Candidate
Returns the access mode.
getAccessFile() - Method in class com.uc4.api.objects.DatabaseEventValue
 
getAccessFileName() - Method in class com.uc4.api.objects.AttributesSQL
Returns the file name of the Microsoft Access database.
getAccount() - Method in class com.uc4.api.objects.AttributesOS390
Returns the accounting Information on the Job.
getAction() - Method in class com.uc4.api.objects.SyncAction
Returns the name of the action.
getActivationState() - Method in class com.uc4.api.objects.ConsoleSAP.XIChannelFilter
 
getActivationTime() - Method in class com.uc4.api.AbstractTask
Returns the date and time of object activation.
GetActivitiesFilter - Class in com.uc4.communication.requests
Returns a list of objects types which can be used to filter tasks.
GetActivitiesFilter() - Constructor for class com.uc4.communication.requests.GetActivitiesFilter
 
getAcv() - Method in class com.uc4.api.Form
Returns the address for the communication.
getAdditonalParamter() - Method in class com.uc4.api.objects.ConsoleSAP.JavaEventHistoryFilter
 
getAdjustDays() - Method in class com.uc4.api.objects.RollCalendarCollision
Returns the number of days of adjustment.
getAdjustDays() - Method in class com.uc4.api.objects.RollCalendarKeyword
Returns the number of days of adjustment.
getAdjustmentCalendar() - Method in class com.uc4.api.objects.RollCalendarKeyword
Returns the name and keyword of the calendar which contains valid days for adjustment.
getAdjustSign() - Method in class com.uc4.api.objects.RollCalendarCollision
 
getAdjustSign() - Method in class com.uc4.api.objects.RollCalendarKeyword
 
getAgent() - Method in class com.uc4.api.AutoForecastItem
 
getAgent() - Method in class com.uc4.api.objects.CheckConnectionCondition
 
getAgent() - Method in class com.uc4.api.objects.CheckFileCondition
Returns the name of the Agent.
getAgent() - Method in class com.uc4.api.objects.CheckProcessCondition
 
getAgentByName(UC4HostName) - Method in class com.uc4.communication.requests.AgentList
Returns the AgentListItem for the specified name or null if not found.
GetAgentGroupMonitorProperties - Class in com.uc4.communication.requests
This class is used to get AgentGroup options of a RunID.
GetAgentGroupMonitorProperties(int) - Constructor for class com.uc4.communication.requests.GetAgentGroupMonitorProperties
Creates a request to read the AgentGroup monitor.
getAgentID() - Method in class com.uc4.api.objects.AttributesJMX
Returns the agent ID.
getAgentName() - Method in class com.uc4.api.objects.DatabaseEventValue
 
getAgentName() - Method in class com.uc4.communication.requests.GetAgentProperties
Returns the agents name
GetAgentProperties - Class in com.uc4.communication.requests
Returns the properties of an Agent.
GetAgentProperties(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetAgentProperties
Creates a new instance of the GetAgentProperties request.
getAgentProperty(String) - Method in class com.uc4.communication.requests.GetAgentProperties
Returns the value of an Agent property or null if the key was not found.
getAgentVersionFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the version filter.
getAlarmObject() - Method in class com.uc4.api.objects.JobPlanExternal
Returns the name of the alarm object.
getAlias() - Method in class com.uc4.api.objects.ExecuteObjectAction
Returns the alias or null if none is set.
getAlias() - Method in class com.uc4.api.objects.ExecuteRecurring
Returns the alias or null if it has not been set.
getAlias() - Method in class com.uc4.api.objects.JobPlanExternal
Returns the alias name of this task or null if no alias is set.
getAlias() - Method in class com.uc4.api.objects.ProcessFlowGeneral
Returns the alias name of this task or null if no alias is set.
getAlias() - Method in class com.uc4.api.objects.RunPathAction
Returns the alias.
getAlias() - Method in class com.uc4.communication.requests.GenericStatistics
Returns a filter for the alias.
getAlias() - Method in class com.uc4.communication.requests.GetExecuteOnce
Returns the alias of the object or an empty instance if not set.
getAlias() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the Alias of the task.
getAlias() - Method in class com.uc4.communication.requests.TaskList
Returns the alias.
getAllDocuNames() - Method in class com.uc4.api.objects.DocuContainer
 
getAllMessageBoxes() - Method in class com.uc4.communication.requests.XMLRequest
Returns a List of all MessageBoxes object if the server returns messages for this request.
getAllOnChangeResetElementIterator() - Method in class com.uc4.api.prompt.OnChangeResetElement
Returns a java.util.Iterator to get all OnChangeReset-children of this PromptElement and all related sub-children (=Recursive get).
getAllowedCharacters() - Method in exception com.uc4.api.InvalidUC4NameException
Returns the allowed characters.
getAlternativeCharacter() - Method in class com.uc4.api.objects.CodeTable
Returns the alternative character of this code table.
getAlternativeLogin() - Method in class com.uc4.api.objects.DatabaseConnection
 
getApplicationName() - Method in class com.uc4.api.objects.Deployment
Returns the name of the Application.
getApplicationName() - Method in class com.uc4.communication.requests.GetDeploymentProperties
Returns the name of the Application.
getApplicationName() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the name of the Application.
getArchive1() - Method in class com.uc4.api.AbstractTask
Returns the first archive key of this task.
getArchive1() - Method in class com.uc4.api.FolderListItem
Returns the first archive key of this object.
getArchive1() - Method in class com.uc4.api.objects.HostGroupItem
 
getArchive2() - Method in class com.uc4.api.AbstractTask
Returns the second archive key of this task.
getArchive2() - Method in class com.uc4.api.FolderListItem
Returns the seconds archive key of this object.
getArchive2() - Method in class com.uc4.api.objects.HostGroupItem
 
getArchiveKey1() - Method in class com.uc4.api.AbstractTask
Returns the first archive key of the object.
getArchiveKey1() - Method in class com.uc4.api.objects.Header
Returns the first archive key.
getArchiveKey1() - Method in class com.uc4.api.objects.XHeader
Returns the first archive key.
getArchiveKey1() - Method in class com.uc4.api.systemoverview.UserListItem
Returns the first archive key.
getArchiveKey1() - Method in class com.uc4.api.TaskFilter
Returns the current filter for the first archive key.
getArchiveKey1() - Method in class com.uc4.communication.requests.GenericStatistics
Returns the first archive key.
getArchiveKey1() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the value of the first archive key.
getArchiveKey1() - Method in class com.uc4.communication.requests.SearchIndex.Result
Returns the value of the first archive key.
getArchiveKey2() - Method in class com.uc4.api.AbstractTask
Returns the second archive key of the object.
getArchiveKey2() - Method in class com.uc4.api.objects.Header
Returns the second archive key.
getArchiveKey2() - Method in class com.uc4.api.objects.XHeader
Returns the second archive key.
getArchiveKey2() - Method in class com.uc4.api.systemoverview.UserListItem
Returns the second archive key.
getArchiveKey2() - Method in class com.uc4.api.TaskFilter
Returns the current filter for the second archive key.
getArchiveKey2() - Method in class com.uc4.communication.requests.GenericStatistics
Returns the second archive key.
getArchiveKey2() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the value of the second archive key.
getArchiveKey2() - Method in class com.uc4.communication.requests.SearchIndex.Result
Returns the value of the second archive key.
getArrayName() - Method in class com.uc4.api.objects.LoopDataSource
Returns the name of the Script Variable which is defined as an array.
getAsHost() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the application server if a direct connection has been used.
getAskForAlias() - Method in class com.uc4.communication.ProcessFlowSettings
Returns if the dialog "Add task" should be displayed when you add ProcessFlow tasks using the drag and drop function.
getAttachFile() - Method in class com.uc4.api.objects.NotificationSettings
 
getAttachReportsFrom() - Method in class com.uc4.api.objects.NotificationSettings
 
getAttribute(String) - Method in class com.uc4.api.objects.XMLDocuNode
 
getAttributeDefaultValue(String, String) - Method in class com.uc4.api.objects.XMLDocumentation
Returns the default value of an attribute.
getAttributeEnumValues(String, String) - Method in class com.uc4.api.objects.XMLDocumentation
Returns the enumeration values of a specified attribute.
getAttributeID() - Method in class com.uc4.api.SearchResultItem
Returns the internal usage id.
getAttributes() - Method in class com.uc4.api.objects.XMLDocuNode
Returns a Map of all attribute names and values which are defined for this element.
getAuthenticatedFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the authentication filter of the Agent.
getAuthorizations() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the rights assigned to the Agent.
getAverageLoad() - Method in class com.uc4.api.systemoverview.WorkloadItem
Returns the average load of this client in percent.
getB01() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the percentage of server process utilization over the last minute.
getB10() - Method in class com.uc4.api.systemoverview.ServerListItem
Percentage of server process utilization over the last 10 minutes.
getB60() - Method in class com.uc4.api.systemoverview.ServerListItem
Percentage of server process utilization over the last 60 minutes.
getBackgroundThread() - Method in class com.uc4.communication.Connection
 
getBackupDirectory() - Method in class com.uc4.api.objects.Rollback
Returns the backup directory or an empty String if not set.
getBackupObject() - Method in class com.uc4.api.objects.Rollback
Returns the UC4 Object for the backup or an empty instance if not set.
getBIExtendedMonitoring() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the status of the extended monitoring of Info Packages.
getBinaryContent() - Method in class com.uc4.communication.requests.DownloadBinary
Returns the file as ByteBuffer.
getBinaryContent() - Method in class com.uc4.communication.requests.ExportObject
Returns the file content as ByteBuffer.
getBinaryContent() - Method in class com.uc4.communication.requests.ExportWithReferences
Returns the export file content as ByteBuffer.
getBIRepeatChecks() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the number of checks repeated status checks if the extended Info Package monitoring has been set to REPEAT_CHECK.
getBIRepeatDataRequestChecks() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the number of runs for data request checks
getBlockCount() - Method in class com.uc4.api.TrafficLight
Returns the number of blocked tasks.
getCAKey() - Method in class com.uc4.communication.requests.NavigatorCATree.CustomAttributeLeaf
Returns the key of the Custom Attribute specified in the variable UC_CUSTOM_ATTRIBUTES.
getCalculatedFrom() - Method in class com.uc4.communication.requests.AutoForecastRange
Returns the start date and time of the Auto Forecast calculation or null if this request has not been sent.
getCalculatedTo() - Method in class com.uc4.communication.requests.AutoForecastRange
Returns the end date and time of the Auto Forecast calculation or null if this request has not been sent.
getCalendar() - Method in class com.uc4.api.objects.UserAttributes
Returns the authorization check according to the Calendar.
getCalendar() - Method in class com.uc4.communication.requests.NotificationMonitor.CallStatus
Returns the name of the calendar and its keyword.
getCalendarCondition() - Method in class com.uc4.api.objects.ExecuteRecurring
Returns the calendar condition which has been set using the method ExecuteRecurring.setCalendarCondition(TaskCalendar).
getCalendarCondition() - Method in interface com.uc4.api.objects.ICallOperatorCondition
Returns the Calendar condition or null if no calendar condition is set.
getCalendarCondition() - Method in class com.uc4.api.objects.Period
Deprecated.
getCalendarCondition() - Method in class com.uc4.api.objects.QueueExceptionCondition
Returns the CalendarCondition.
getCalendarCondition() - Method in class com.uc4.api.prompt.DateElement
 
getCalendarkeyword(UC4ObjectName) - Method in class com.uc4.api.objects.Calendar
Gets the specified calendar keyword from this calendar.
getCalendarView() - Method in class com.uc4.communication.TimeSettings
Returns the calendar view.
getCalls() - Method in class com.uc4.api.systemoverview.CacheListItem
Number of input buffer calls.
getCaption() - Method in class com.uc4.api.objects.CockpitControl
Return the caption.
getCaption() - Method in class com.uc4.api.objects.PromptDesigner
Returns the caption of this PromptSet.
getCaption() - Method in class com.uc4.api.prompt.CheckGroupElement
 
getCaption() - Method in class com.uc4.api.prompt.ComboElement
 
getCaption() - Method in class com.uc4.api.prompt.DateElement
 
getCaption() - Method in class com.uc4.api.prompt.LabelElement
Returns the caption of this label.
getCaption() - Method in class com.uc4.api.prompt.NumberElement
 
getCaption() - Method in interface com.uc4.api.prompt.PromptInterfaces.Caption
Return the Caption (Label) of the prompt
getCaption() - Method in class com.uc4.api.prompt.RadioGroupElement
 
getCaption() - Method in class com.uc4.api.prompt.TextElement
 
getCaption() - Method in class com.uc4.api.prompt.TimeElement
 
getCaption() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the caption of the task.
getCaption(String) - Method in class com.uc4.communication.requests.ReportTypeList
Returns the caption for the report type.
getCategory() - Method in class com.uc4.api.objects.ConsoleWindows
 
getCategory() - Method in class com.uc4.api.systemoverview.LicenseListItem
Returns the category description of the license (such as Production).
getCategory() - Method in class com.uc4.api.systemoverview.MessageListItem
 
GetCAUAgentVersions - Class in com.uc4.communication.requests
Returns an ordered list of available CAU versions for an agent platform, starting with the latest version.
GetCAUAgentVersions(String) - Constructor for class com.uc4.communication.requests.GetCAUAgentVersions
Construct the request with platform as parameter
getCauVersion() - Method in class com.uc4.api.AbstractTask
Returns the Version of the Agent.
GetChangeLog - Class in com.uc4.communication.requests
Returns a list of recent changes in the current client.
GetChangeLog() - Constructor for class com.uc4.communication.requests.GetChangeLog
Creates a new GetChangeLog request without filters (everything is returned).
GetChangeLog.Entry - Class in com.uc4.communication.requests
Represents a row in the result of the change list.
getChannel() - Method in class com.uc4.api.objects.ConsoleSAP.XIChannelFilter
 
getCharacter(int, int) - Method in class com.uc4.api.objects.CodeTable
Gets the character at the given position in the code table.
getCheckInterval() - Method in class com.uc4.communication.requests.GetAgentProperties
Returns the interval in seconds in which the Agent tries to contact the Automation Engine.
getChecksum() - Method in class com.uc4.api.objects.ResourceItem
Return the checksum of the resource.
getChecksum() - Method in class com.uc4.api.StorageItem
Returns checksum string of the resource content.
getChildCount() - Method in class com.uc4.api.objects.XMLDocuNode
Returns the number of Child elements.
getChildPostProcess() - Method in class com.uc4.api.objects.Job
Deprecated.
Will be removed in future version. Use getChildPostProcessScript() instead.
getChildPostProcess() - Method in class com.uc4.api.objects.PSRemoteTaskManager
Returns the content of the Child Post-Process tab.
getChildPostProcess() - Method in class com.uc4.api.objects.SAPQueueManager
Returns the content of the Child Post-Process tab.
getChildPostProcessScript() - Method in class com.uc4.api.objects.Job
Returns the content of the Child Post-Process Script.
getChildrenQueue() - Method in class com.uc4.api.objects.Group
Deprecated.
use attributes.getChildrenQueue of this group instead
getChildrenQueue() - Method in class com.uc4.api.objects.GroupAttributes
Returns the name of the Queue Object for children of this Group.
getChildrenQueue() - Method in class com.uc4.api.objects.JobPlanAttributes
Returns the name of the Queue Object for children of this ProcessFlow.
getChildrenQueue() - Method in class com.uc4.api.objects.ScheduleAttributes
Returns the name of the Queue Object for children of this Schedule.
getChildTasks() - Method in class com.uc4.api.ForecastTreeItem
 
getCITName() - Method in class com.uc4.api.objects.HostGroup
Returns the CIT Name for the CIT Host Group Type.
getClient() - Method in class com.uc4.api.AbstractTask
Deprecated.
Use getTaskClient() instead
getClient() - Method in interface com.uc4.api.objects.Authorizations.Entry
 
getClient() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the SAP client.
getClient() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
 
getClient() - Method in class com.uc4.api.systemoverview.AgentGroupListItem
Returns the client of the AgentGroup.
getClient() - Method in class com.uc4.api.systemoverview.CheckILMPartitionItem
Returns the client of the task.
getClient() - Method in class com.uc4.api.systemoverview.ClientListItem
Returns the number of the client.
getClient() - Method in class com.uc4.api.systemoverview.MQMemListItem
 
getClient() - Method in class com.uc4.api.systemoverview.UserListItem
Returns the client of the user.
getClient() - Method in class com.uc4.api.systemoverview.WorkloadItem
Returns the number of the client or -1 if this WorkloadItem represents the workload of all clients.
getClient() - Method in class com.uc4.communication.ConnectionAttributes
 
getClient() - Method in class com.uc4.communication.KickEvent
 
getClient() - Method in class com.uc4.communication.requests.GenericStatistics
Returns the client number.
getClient() - Method in class com.uc4.communication.requests.GroupMonitor
Returns the client of the group monitor.
getClient() - Method in class com.uc4.communication.requests.NavigatorAgentTree.AgentNode
Returns the corresponding client of the Agent.
getClientQueues() - Method in class com.uc4.api.TaskFilter
Gets the client queues.
getCodeName() - Method in class com.uc4.api.objects.JobAttributes
Returns the name of the CodeTable.
getCollisionCalendar() - Method in class com.uc4.api.objects.RollCalendarCollision
Returns the calendar object and keyword with which collisions may occur.
getColumnCount() - Method in class com.uc4.communication.requests.QueryData
Returns the number of columns or -1 if no table was returned.
getColumnNames() - Method in class com.uc4.communication.requests.PreviewAssignment
Returns a String array which contains the names of the columns.
getColumnNames() - Method in class com.uc4.communication.requests.PreviewVariable
Returns a String array which contains the names of the columns.
getColumnNames() - Method in class com.uc4.communication.requests.PromptInputHelp
Returns a String array which contains the names of the columns.
getColumnNames() - Method in class com.uc4.communication.requests.QueryData
Returns an array of columns of this row or null if no table was returned.
getColumns() - Method in class com.uc4.api.objects.BackendCommand
Returns the columns.
getColumnSeparator() - Method in class com.uc4.api.objects.AttributesSQL
Returns the character which is used to separate column values in the Job report.
getCommand() - Method in class com.uc4.api.objects.AttributesUnix
Returns the shell command.
getCommand() - Method in class com.uc4.api.objects.AttributesWin
Returns the program to be executed.
getCommand() - Method in class com.uc4.api.objects.BackendCommand
Returns the command.
getCommandParameters() - Method in class com.uc4.api.FormItemList
Return the map of Command Parameters in case command is true, else returns an empty map.
getCommentFlag() - Method in class com.uc4.communication.requests.TaskList
Returns commented flag.
GetComments - Class in com.uc4.communication.requests
Returns the comments of a task.
GetComments(int) - Constructor for class com.uc4.communication.requests.GetComments
Returns all comments for the specified task.
getComments() - Method in class com.uc4.communication.requests.GetComments
Returns the comments as String.
GetComments.Comment - Class in com.uc4.communication.requests
This class represents a single comment from one user.
getCompleteJobLog() - Method in class com.uc4.api.objects.AttributesOS390
Returns the complexity of job log 0 ...
getComponentName() - Method in class com.uc4.api.objects.Deployment
Returns the name of the component .
getComponentName() - Method in class com.uc4.communication.requests.GetDeploymentProperties
Returns the name of the component.
getComponentName() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the name of the component.
getComponentName() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the Component Name of the task.
GetComponentTemplates - Class in com.uc4.communication.requests
Creates a list of objects which are templates for Component Workflows of a specific component type.
GetComponentTemplates(String) - Constructor for class com.uc4.communication.requests.GetComponentTemplates
Creates a new GetComonentTemplates request.
GetComponentWorkflows - Class in com.uc4.communication.requests
Creates a list of existing Component Workflows for a specific application or all applications.
GetComponentWorkflows(String) - Constructor for class com.uc4.communication.requests.GetComponentWorkflows
Creates a new GetComponentWorkflows request.
getCompression() - Method in class com.uc4.api.objects.FileTransferSettings
Returns an integer containing compression setting.
getCompression() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the Compression type.
getCond() - Method in class com.uc4.api.objects.EventCalendarItem
 
getCondition() - Method in class com.uc4.api.objects.OutputScanFilter
Returns true if the filter should match or not match.
getConditions() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
Returns the value of the conditions column in the monitor.
getConnectedFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the filter for the connection status.
getConnection() - Method in class com.uc4.api.objects.AttributesSQL
Returns the name of the connection object.
getConnection() - Method in class com.uc4.api.objects.CheckConnectionCondition
 
getConnection() - Method in class com.uc4.api.objects.DynamicSQLVariable
Returns the name of the connection object.
getConnection() - Method in class com.uc4.api.objects.SecureSQLVariable
Returns the name of the connection object.
getConnectionName() - Method in class com.uc4.api.objects.RAConnection
Returns the technical name of the connection within the RA solution.
getConnections() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the number of connections to clients of communication processes.
getConnectionType() - Method in class com.uc4.api.objects.SAPConnection
 
getConnectProperties() - Method in class com.uc4.api.objects.DatabaseConnection
Returns an unmodifiable map which contains all connect properties.
getConnectStringValues() - Method in class com.uc4.api.objects.DatabaseConnection
Returns an unmodifiable map which contains all connect string values.
getConsumption() - Method in class com.uc4.api.objects.FileTransferAttributes
 
getConsumption() - Method in class com.uc4.api.objects.JobAttributes
 
getConsumption() - Method in class com.uc4.api.objects.QueueManagerAttributes
 
getConsumption() - Method in class com.uc4.api.Task
 
getContent() - Method in class com.uc4.api.objects.TextDocumentation
Returns the content of this text documentation.
getContentAsText() - Method in class com.uc4.communication.requests.DownloadBinary
Returns the content of a text file.
getContentAsText(String) - Method in class com.uc4.communication.requests.DownloadBinary
Returns the content of a text file using a specified line line seperator.
getContentLen() - Method in class com.uc4.communication.requests.UploadBinary
Returns the length of the upload-content.
getControl(int) - Method in class com.uc4.api.objects.CockpitDesign
Return the CockpitControl with the specified id.
getCount() - Method in class com.uc4.api.objects.CheckActivitiesCondition
 
getCount() - Method in class com.uc4.api.systemoverview.LicenseListItem
Returns the total number of licenses for the platform.
getCount() - Method in class com.uc4.communication.requests.GetDatabaseInfo.MQEntry
 
getCountDescription() - Method in class com.uc4.communication.requests.GetReplaceList
 
getCp() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the linked communication process.
getCp() - Method in class com.uc4.api.systemoverview.UserListItem
Returns the Communication process to which the user is connected.
getCpAddress() - Method in class com.uc4.communication.Connection
Returns the address of the communication process
getCPName() - Method in class com.uc4.communication.requests.GetCPProperties
Returns the CP name.
GetCPProperties - Class in com.uc4.communication.requests
Returns the trace options for a Communication Process using existing XREQ
GetCPProperties(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetCPProperties
Creates an instance of GetWPProperties
getCPPropertiesElement() - Method in class com.uc4.communication.requests.GetCPProperties
Returns the CP property element
getCPTraceElement() - Method in class com.uc4.communication.requests.GetCPProperties
Returns a value of the Server trace section
getCPTraceOptions() - Method in class com.uc4.communication.requests.GetCPProperties
Returns a CPTraceOptions Object
getCpu() - Method in class com.uc4.api.objects.AttributesNSK
Returns the number of the CPU on which the Job should run or -1 if the system should selects a CPU.
getCpuTime() - Method in class com.uc4.api.Task
Returns the consumed CPU time in seconds.
getCreated() - Method in class com.uc4.api.objects.Header
Indicates user, date and time regarding the creation of an object.
getCreated() - Method in class com.uc4.api.objects.XHeader
Indicates user, date and time regarding the creation of an object.
getCreatedByUser() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the name of the user who created the object.
getCreatedDate() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the date and time when the object was created.
getCurrentERT() - Method in class com.uc4.api.objects.EstimatedRuntime
Returns the current estimated runtime.
getCurrentPage() - Method in class com.uc4.communication.requests.Report
Returns the number of the current page or 0 if this request has not been sent.
getCurrentSize() - Method in class com.uc4.api.systemoverview.CacheListItem
Currently used cache size.
getCurrentState() - Method in class com.uc4.api.objects.SyncAttributes
Returns the name of the current state.
getCurrentState() - Method in class com.uc4.communication.requests.GetSyncMonitor
 
getCustomAttribute() - Method in class com.uc4.api.objects.CustomAttributeFilter
Returns the Custom Attribute.
getCustomField() - Method in class com.uc4.api.objects.PromptElement
Returns the custom field of this Prompt Element.
getDashboard() - Method in class com.uc4.api.objects.Dashboard
Gets the content of the Dashboard tab.
getDatabase() - Method in class com.uc4.api.objects.DatabaseEventValue
 
GetDatabaseInfo - Class in com.uc4.communication.requests
Reads information about the UC4 Database.
GetDatabaseInfo() - Constructor for class com.uc4.communication.requests.GetDatabaseInfo
 
GetDatabaseInfo.MQEntry - Class in com.uc4.communication.requests
This class stores information about a message queue table.
getDatabaseName() - Method in class com.uc4.api.objects.AttributesSQL
Returns the name of the database on the specified database server.
getDatabaseServer() - Method in class com.uc4.api.objects.AttributesSQL
Returns the name and port of the database server.
getDataReference() - Method in class com.uc4.api.prompt.CheckGroupElement
 
getDataReference() - Method in class com.uc4.api.prompt.ComboElement
 
getDataReference() - Method in class com.uc4.api.prompt.DateElement
 
getDataReference() - Method in class com.uc4.api.prompt.NumberElement
 
getDataReference() - Method in interface com.uc4.api.prompt.PromptInterfaces.DataReference
 
getDataReference() - Method in class com.uc4.api.prompt.RadioGroupElement
 
getDataReference() - Method in class com.uc4.api.prompt.TextElement
 
getDataReference() - Method in class com.uc4.api.prompt.TimeElement
 
getDate() - Method in class com.uc4.api.DateTime
Returns the date as String.
getDate() - Method in class com.uc4.communication.AsyncMessage
Returns the date for this message.
getDateFormat() - Method in class com.uc4.api.objects.VariableAttributes
Returns the output format of a date.
getDateFrom() - Method in class com.uc4.communication.requests.QueryAutoforecast
 
getDateModified() - Method in class com.uc4.api.FolderListItem
Returns the date of the last modification.
getDateRangeRuns() - Method in class com.uc4.api.objects.ExecuteRecurring
 
getDateRangeRuns() - Method in class com.uc4.api.objects.Period
Deprecated.
getDateTo() - Method in class com.uc4.communication.requests.QueryAutoforecast
 
getDay() - Method in class com.uc4.api.DateTime
Returns the day of month of this DateTime object.
getDayOffset() - Method in class com.uc4.api.objects.CheckHistoryCondition
Returns the offset in days.
getDayOffset() - Method in class com.uc4.api.objects.ScheduleTask
Returns the number of days which should are added to the start time.
getDayOffset() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
Returns the number of days (calendar days serve as a basis) which must have passed after the start of the period.
getDays() - Method in class com.uc4.api.objects.MaximumRuntime
Returns the number of days when the task must be finished.
getDays() - Method in class com.uc4.api.objects.ReEvaluateAtAction
Return the number of days which are added the next evaluation time.
getDaysAfterJobPlanActivation() - Method in class com.uc4.api.objects.JobPlanCheckpoint
Deprecated.
Returns the number of days as of JobPlan activation.
getDaysAfterJobPlanActivation() - Method in class com.uc4.api.objects.JobPlanEarliest
Returns the number of days which should be added to the current date as of activation to get the earliest start time.
getDaysAfterJobPlanActivation() - Method in class com.uc4.api.objects.ProcessFlowGeneral
Returns the number of days as of JobPlan activation.
getDbmsName() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getDbmsVersion() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getDbName() - Method in class com.uc4.api.objects.DatabaseConnection
Returns the name of the database.
getDbName() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getDbPort() - Method in class com.uc4.api.objects.DatabaseConnection
 
getDbServer() - Method in class com.uc4.api.objects.DatabaseConnection
Returns the host name of the database server.
getDBType() - Method in class com.uc4.api.objects.DatabaseConnection
Returns the database type.
getDbType() - Method in class com.uc4.api.systemoverview.ILMPartitionItem
Returns the vendor id of the database.
getDeactivate() - Method in class com.uc4.api.objects.EventAttributes
Returns the deactivate condition for this Job.
getDeactivate() - Method in class com.uc4.api.objects.FileTransferAttributes
Returns the deactivate condition for this Job.
getDeactivate() - Method in class com.uc4.api.objects.GroupAttributes
Returns the deactivate condition for this Job.
getDeactivate() - Method in class com.uc4.api.objects.JobAttributes
Returns the deactivate condition for this Job.
getDeactivate() - Method in class com.uc4.api.objects.JobPlanAttributes
Returns the deactivate condition for this JobPlan.
getDeactivate() - Method in class com.uc4.api.objects.NotificationAttributes
Returns the deactivate condition for this Job.
getDeactivate() - Method in class com.uc4.api.objects.ScriptAttributes
Returns the deactivate condition for this Job.
getDefaultJobPlanElse() - Method in class com.uc4.communication.ConnectionAttributes
Returns the default JobPlan task ELSE Action.
getDefaultLogin() - Method in class com.uc4.api.objects.UserAttributes
Returns the Login object for the database access of Variable objects with the source "SQL".
getDefaultLogin() - Method in class com.uc4.communication.ERPFormsSettings
Returns the Login object that should be used by default in the "Form" tab of PeopleSoft jobs in order to connect to the Enterprise Business Solution.
getDelay() - Method in class com.uc4.api.objects.DeactivateCondition
Returns the delay for deactivation.
getDeliver() - Method in class com.uc4.api.objects.AttributesSAP
Returns the report send status:
getDepartment() - Method in class com.uc4.communication.ConnectionAttributes
 
getDeploymentDependency() - Method in class com.uc4.api.objects.ProcessFlowGeneral
Returns the dependency of the component process worflow.
GetDeploymentProperties - Class in com.uc4.communication.requests
read the deployment properties (Deployment Tab) after the task was activated (EH).
GetDeploymentProperties(int) - Constructor for class com.uc4.communication.requests.GetDeploymentProperties
Constructs a GetDeploymentProperties using the specified RunID.
GetDeployObjectProperties - Class in com.uc4.communication.requests
Returns the name of an Application Release Automation ProcessFlow based on the Application and Workflow name.
GetDeployObjectProperties(String, String) - Constructor for class com.uc4.communication.requests.GetDeployObjectProperties
Creates a new ARAProperties.
getDescription() - Method in interface com.uc4.api.objects.Authorizations.Entry
Returns the number of client followed by the description.
getDescription() - Method in class com.uc4.api.objects.LocaAttributes
Returns the description value of this Loca - Object.
getDescription() - Method in class com.uc4.api.objects.QueueExceptionCondition
 
getDescription() - Method in class com.uc4.api.objects.SyncState
Returns the description of the state.
getDescription() - Method in class com.uc4.api.systemoverview.HostTraceOptions.HostTraceFlag
get the trace flag description
getDescription() - Method in class com.uc4.api.Template
Returns the description of the template.
getDescription() - Method in class com.uc4.api.TraceOptions.TraceFlag
get the trace flag description
getDestination() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the Destination
getDestinationCodeTable() - Method in class com.uc4.api.objects.FileTransferSettings
 
getDestinationFile() - Method in class com.uc4.api.objects.FileTransferSettings
 
getDestinationFileAttributes() - Method in class com.uc4.api.objects.FileTransferSettings
 
getDestinationHost() - Method in class com.uc4.api.objects.FileTransferSettings
 
getDestinationHost() - Method in class com.uc4.communication.requests.GenericStatistics
Returns the selected destination host.
getDestinationLogin() - Method in class com.uc4.api.objects.FileTransferSettings
 
getDetails() - Method in class com.uc4.api.DetailGroup
Returns the details of this group in the same order as sent by the server.
getDetailTab() - Method in class com.uc4.api.DetailGroup
Returns the name of the tab.
getDirectory() - Method in class com.uc4.api.objects.FileListVariable
Returns the directory which is used to get a file list.
getDisplayMessageID() - Method in class com.uc4.api.objects.AbortAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.BlockAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.CancelProcessFlowAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.ChangeQueueAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.CheckActivitiesCondition
 
getDisplayMessageID() - Method in class com.uc4.api.objects.CheckConnectionCondition
 
getDisplayMessageID() - Method in class com.uc4.api.objects.CheckFileCondition
 
getDisplayMessageID() - Method in class com.uc4.api.objects.CheckHistoryCondition
 
getDisplayMessageID() - Method in class com.uc4.api.objects.CheckProcessCondition
 
getDisplayMessageID() - Method in class com.uc4.api.objects.ClearVariableAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.ConditionOrAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.CurrentQueueCondition
 
getDisplayMessageID() - Method in class com.uc4.api.objects.CurrentTimeCondition
 
getDisplayMessageID() - Method in class com.uc4.api.objects.ExecuteObjectAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.ModifyStateAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.PublishValueAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.ReEvaluateAtAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.ReEvaluateInAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.RestartTaskAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.ReturnCodeCondition
 
getDisplayMessageID() - Method in class com.uc4.api.objects.RollbackAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.RunPathAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.RunTaskAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.SetValueAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.SetVariableAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.SkipTaskAction
 
getDisplayMessageID() - Method in class com.uc4.api.objects.StatusCondition
 
getDisplayMessageID() - Method in class com.uc4.api.objects.TimeSinceActivationCondition
 
getDisplayMessageID() - Method in class com.uc4.api.objects.UserDefinedCondition
 
getDisplayType() - Method in class com.uc4.communication.requests.GetOutputDirectory.OutputDirectoryItem
Returns the display text of this report.
getDistinguishedName() - Method in class com.uc4.api.objects.UserAttributes
Returns the distinguished name of this user.
getDistinguishedName() - Method in class com.uc4.communication.requests.SynchronizeLDAP
Returns the distinguished name of the user.
getDriverName() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getDriverVersion() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getDSTSavings() - Method in class com.uc4.api.objects.TimeZoneAttributes
Returns the difference between normal time and daylight saving time (DST) in minutes.
GetDynamicComboList - Class in com.uc4.communication.requests
Returns a list of elements for a combo element, radio list or checklist in a PromptSet.
GetDynamicComboList(String, UC4ObjectName, int, TaskPromptSetContent...) - Constructor for class com.uc4.communication.requests.GetDynamicComboList
Creates a new GetDynamicComboList request in order to get the list of values of a dynamic ComboElement in a prompt.
GetDynamicComboList(String, UC4ObjectName, UC4Object, TaskPromptSetContent...) - Constructor for class com.uc4.communication.requests.GetDynamicComboList
Creates a new GetDynamicComboList request in order to get the list of values of a dynamic ComboElement in a prompt.
GetDynamicComboList(String, UC4ObjectName, ITaskItem, TaskPromptSetContent...) - Constructor for class com.uc4.communication.requests.GetDynamicComboList
Creates a new GetDynamicComboList request in order to get the list of values of a dynamic ComboElement in a prompt.
getECCPlugIns() - Static method in class com.uc4.communication.requests.GetStorageItems
Create new object which points to storage with all ECC PlugIns.
getElementIDs() - Method in class com.uc4.api.objects.PromptSetDefinition
Returns an array of Prompt element IDs.
getElseAction() - Method in class com.uc4.api.objects.SyncItem
Returns the task handling if neither Start Action, Abend Action nor End Action can be processed.
getElseAction() - Method in class com.uc4.communication.ProcessFlowSettings
Returns the default else action when tasks are added to a Process Flow.
getElseExecute() - Method in class com.uc4.api.objects.JobPlanDependencies
Returns the object that should be executed when a defined condition does not occur.
getElseExecute() - Method in class com.uc4.api.objects.QueueManagerAttributes
Returns the object name of the object that is executed when a task ends with a Return Code greater than the max expected return code.
getElseExecute() - Method in class com.uc4.communication.ProcessFlowSettings
Returns the default name of the UC4 Object which should be executed as ELSE action when a task are added to a Process Flow.
getEmail() - Method in interface com.uc4.api.objects.ICallOperatorCondition
Returns an e-mail address or null if a User or UserGroup has been set.
getEmail() - Method in class com.uc4.communication.requests.SynchronizeLDAP
Returns the email address of the user or null if this request has not been sent.
getEmail1() - Method in class com.uc4.api.objects.UserAttributes
Returns the first Email address of this user.
getEmail2() - Method in class com.uc4.api.objects.UserAttributes
Returns the second Email address of this user.
getEmailRecipientFulfillment() - Method in class com.uc4.api.objects.SloFulfillment
Returns the recipient of e-mails on fulfillment.
getEmailRecipientViolation() - Method in class com.uc4.api.objects.SloFulfillment
Returns the recipient of e-mails on violation.
getEncoding() - Method in class com.uc4.communication.ConnectionAttributes
Returns the encoding used for communication between API and CP.
getEncoding() - Method in class com.uc4.communication.requests.CreateSession
Returns the encoding of the XML messages.
getEnd() - Method in class com.uc4.api.systemoverview.ILMHistoryItem
Returns the time up to when data records have been stored in the partition.
getEndAction() - Method in class com.uc4.api.objects.SyncItem
Returns the action that should be carried out when the task ends.
getEndDST() - Method in class com.uc4.api.objects.TimeZoneAttributes
Returns the TimeChangeRule when the daylight saving time (DST) ends.
getEndMonth() - Method in class com.uc4.api.objects.MonthlyCalendarKeyword
Returns the number of the end month of the monthly interval.
getEndTask() - Method in class com.uc4.api.objects.JobPlan
Returns the END-task of this JobPlan.
getEndTask() - Method in class com.uc4.api.objects.WorkflowIF
Returns the END task of an IF.
getEndTask() - Method in class com.uc4.api.objects.WorkflowLoop
Returns the END task of this FOR EACH workflow.
getEndTask() - Method in class com.uc4.communication.requests.JobPlanMonitor
Returns the end task.
getEndTime() - Method in class com.uc4.api.AbstractTask
Returns the date and time of object end.
getEndTime() - Method in class com.uc4.api.systemoverview.CheckILMPartitionItem
Returns the date and time of object end.
getEndWeek() - Method in class com.uc4.api.objects.WeeklyCalendarKeyword
Returns the end week for the interval.
getEnterParameter() - Method in class com.uc4.api.objects.AttributesBS2000
Returns enter parameters of this BS2000 Job.
getEnterpriseServer() - Method in class com.uc4.api.objects.AttributesSiebel
Returns the name of the Enterprise Server.
getEntryName() - Method in class com.uc4.communication.requests.UploadBinary
Return the entryName used for the Data to transfer.
getErrorMessageNumber() - Method in class com.uc4.api.objects.CalendarKeyword
Returns the number of the error message or 0 if there is no error in this calendar keyword.
getErrorText() - Method in class com.uc4.api.objects.CalendarKeyword
Returns the text of the error message or null if there is no error in this calendar keyword.
getErtUsage(int) - Static method in enum com.uc4.api.objects.ErtUsage
Gets the ERT usage Enum Value.
getErtUsage(String) - Method in class com.uc4.api.objects.ObjectValues
Returns the ertUsage for a given validity keyword The method returns ErtUsage.NONE if the validity keyword does not exist.
getErtUsage(String) - Method in class com.uc4.api.objects.TaskValues
Returns the ErtUsage value for a given validity keyword The method returns ErtUsage.NONE if the validity keyword does not exist.
getErtUsageKeyValues() - Static method in enum com.uc4.api.objects.ErtUsage
Gets the Read Only Map of ERT usage.
getEscalation() - Method in class com.uc4.communication.requests.ActiveNotifications.Entry
Returns the date and time on which the Notification escalates.
getEscalation() - Method in class com.uc4.communication.requests.NotificationMonitor
Returns the date and time on which the Notification escalates.
getEscalationCallOperator() - Method in class com.uc4.api.objects.NotificationAttributes
Returns the escalation Notification.
getEscalationMinutes() - Method in class com.uc4.api.objects.NotificationAttributes
Returns the time limit in minutes.
getEstimatedEnd() - Method in class com.uc4.api.AutoForecastItem
 
getEstimatedEnd() - Method in class com.uc4.api.ForecastItem
 
getEstimatedEnd() - Method in class com.uc4.api.ForecastTreeItem
 
getEstimatedRuntime(int) - Method in class com.uc4.communication.requests.GetLastRuntimes
This method returns one of 25 estimated runtimes measured in seconds.
getEstimatedRuntime() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the estimated runtime in seconds.
getEstimatedRunTime() - Method in class com.uc4.communication.requests.JobPlanMonitor
Returns the estimated runtime in seconds.
getEstimatedRunTime() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the estimated runtime in seconds.
getEventID() - Method in class com.uc4.api.objects.ConsoleWindows.ConsoleWindowsFilter
 
getEventID() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
 
getEventParameter() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
 
getEventProcess() - Method in class com.uc4.api.objects.ConsoleEvent
Returns the content of the "!Process" tab.
getEventProcess() - Method in class com.uc4.api.objects.DatabaseEvent
Returns the content of the "!Process" tab.
getEventProcess() - Method in class com.uc4.api.objects.FileEvent
Returns the content of the "!Process" tab.
getEventProcess() - Method in class com.uc4.api.objects.TimeEvent
Returns the content of the "!Process" tab.
getEventType() - Method in class com.uc4.api.objects.ConsoleSAP.JavaEventHistoryFilter
 
getExceptionCount() - Method in class com.uc4.api.objects.QueueAttributes
 
getExecObject() - Method in class com.uc4.api.objects.DynamicExecVariable
Gets the executable object name.
getExecute() - Method in class com.uc4.api.objects.JobPlanCheckpoint
Deprecated.
Returns the name of the object that is to be started when the checkpoint has been exceeded.
getExecute() - Method in class com.uc4.api.objects.ProcessFlowGeneral
Returns the name of the object that is to be started when the checkpoint has been exceeded.
getExecuteObject() - Method in class com.uc4.api.objects.OutputScanFilter
Returns the name of the Automation Engine object which should be executed if the filter matches.
getExecuteObject() - Method in class com.uc4.api.objects.Runtime
Returns the object which is executed when the runtime exceeds or falls below the specified limits.
getExecuteObject() - Method in class com.uc4.api.objects.TaskResult
Returns the object that is to be started when the specified status is not reached.
getExecuteObject() - Method in class com.uc4.api.objects.TaskRuntime
Returns the object which is executed when the runtime exceeds or falls below the specified limits.
GetExecuteOnce - Class in com.uc4.communication.requests
Reads the settings of a task that is or will be started with "Execute -> Once..."
GetExecuteOnce(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetExecuteOnce
Reads the default settings for a task that will be scheduled.
GetExecuteOnce(int) - Constructor for class com.uc4.communication.requests.GetExecuteOnce
Reads the settings of a task which has already been started.
GetExecutePeriod - Class in com.uc4.communication.requests
Reads Properties of a periodical Task.
GetExecutePeriod(int) - Constructor for class com.uc4.communication.requests.GetExecutePeriod
Constructs a new GetExecutePeriod request.
GetExecutePeriod(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetExecutePeriod
Constructs a new GetExecutePeriod request.
getExecuteRecurring() - Method in class com.uc4.api.objects.Period
This method will return the ExecuteRecurring details.
getExecuteRecurring() - Method in class com.uc4.communication.requests.GetExecutePeriod
Returns ExecuteRecurring of the periodical task.
getExecuteTestOption() - Method in class com.uc4.communication.requests.GetRestartInformation
Returns Execute Test Options.
getExecutionDateTime() - Method in class com.uc4.communication.requests.GetExecuteOnce
Returns the scheduled start time if the task does not start immediately.
getExecutionInterval() - Method in class com.uc4.api.objects.ExecuteRecurring
 
getExecutionInterval() - Method in class com.uc4.api.objects.Period
Deprecated.
getExpandedRunIds() - Method in class com.uc4.communication.requests.TaskList
Gets the expanded RunIds.
getExpectedStatus() - Method in class com.uc4.api.objects.JobPlanExternal
Returns the status expected for the external task's end of execution.
getExpectedStatus() - Method in class com.uc4.api.objects.SloFulfillment
 
getExpireDate() - Method in class com.uc4.api.systemoverview.LicenseListItem
Returns the date on which the license will expire.
getExportException() - Method in class com.uc4.communication.requests.ExportObject
Returns the Exception that occured during the export or null if the export was successful.
getExportException() - Method in class com.uc4.communication.requests.ExportWithReferences
Returns the Exception that occured during the export or null if the export was successful.
getExportMessages() - Method in class com.uc4.communication.requests.ExportWithReferences
Returns export messages.
getExtendedReports() - Method in class com.uc4.api.objects.EventAttributes
Returns the setting for extended reports.
getExtendedReports() - Method in class com.uc4.api.objects.FileTransferAttributes
Returns the setting for extended reports.
getExtendedReports() - Method in class com.uc4.api.objects.GroupAttributes
Returns the setting for extended reports.
getExtendedReports() - Method in class com.uc4.api.objects.JobAttributes
Returns the setting for extended reports.
getExtendedReports() - Method in class com.uc4.api.objects.JobPlanAttributes
Returns the setting for extended reports.
getExtendedReports() - Method in class com.uc4.api.objects.NotificationAttributes
Returns the setting for extended reports.
getExtendedReports() - Method in class com.uc4.api.objects.QueueManagerAttributes
Returns the setting for extended reports.
getExtendedReports() - Method in class com.uc4.api.objects.ScheduleAttributes
Returns the setting for extended reports.
getExtendedReports() - Method in class com.uc4.api.objects.ScriptAttributes
Returns the setting for extended reports.
getExternalParent() - Method in class com.uc4.api.objects.JobPlanExternal
Returns the parent of the external task.
getExternalParent() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the name of the external parent or an empty UC4ObjectName.
getFailedCount() - Method in class com.uc4.communication.requests.SetHostAuthorizations
 
getFavoritesFolder() - Method in class com.uc4.communication.requests.FolderTree
Returns an IFolder object which represents the "Favorites Folder".
getFile() - Method in class com.uc4.api.objects.CheckFileCondition
Returns the name of the file.
getFile() - Method in class com.uc4.api.systemoverview.ExitListItem
 
getFile() - Method in class com.uc4.communication.requests.GetOutputDirectory.OutputDirectoryItem
Returns the file name of this report or an empty String.
getFileData() - Method in class com.uc4.api.objects.OutputFiles
Returns an unmodifiable map which contains output files data.
getFileException() - Method in class com.uc4.communication.requests.UploadBinary
Returns the Exception that occured during the reading of the inputFile or null if it was successful.
getFileExistsAction() - Method in class com.uc4.api.objects.FileTransferSettings
Returns an integer which indicates the behavior in case of an existing destination file.
getFileGroupTableSpace() - Method in class com.uc4.api.systemoverview.ILMHistoryItem
Returns the name of the filegroup (MS SQL Server) or the tablespace (Oracle).
getFileGroupTableSpace() - Method in class com.uc4.api.systemoverview.ILMPartitionItem
Returns the name of the filegroup (MS SQL Server) or the tablespace (Oracle).
getFileIOException() - Method in class com.uc4.communication.requests.DownloadBinary
Returns the Exception that occured during the writing of the outputfile or null if it was successful.
getFileName() - Method in class com.uc4.api.objects.AttributesOS390
Returns the name of the dataset or member.
getFilename() - Method in class com.uc4.api.objects.ResourceItem
Return the filename of the resource.
getFileName() - Method in class com.uc4.api.StorageItem
Returns file name represented by the resource.
getFileNameDestination() - Method in class com.uc4.api.objects.UserRight
Returns the filter for file names.
getFileNameSource() - Method in class com.uc4.api.objects.UserRight
Returns the filter for file names.
getFileTransferSetting() - Method in class com.uc4.communication.requests.GetRestartInformation
Returns File Transfer Restart.
getFileTransferSetting() - Method in class com.uc4.communication.requests.RestartTask
Returns the file transfer restart setting.
getFileType() - Method in class com.uc4.api.objects.FileSystem
Returns the file type.
getFileType() - Method in class com.uc4.api.objects.ResourceItem
Return the type of the resource.
getFilter() - Method in class com.uc4.api.objects.CustomAttributeFilter
Returns specified filter.
getFilterName() - Method in class com.uc4.api.objects.OutputScanFilter
Name of the filter object.
getFilterText() - Method in class com.uc4.api.objects.OutputFilter.Entry
Returns the filter text.
getFirstName() - Method in class com.uc4.api.objects.UserAttributes
 
getFirstName() - Method in class com.uc4.api.systemoverview.UserListItem
Returns the User's first name.
getFirstName() - Method in class com.uc4.communication.requests.GetChangeLog.Entry
Returns the first name of the user who did the change.
getFirstName() - Method in class com.uc4.communication.requests.SynchronizeLDAP
Returns the first name of the user or null if this request has not been sent.
getFirstTaskByName(String) - Method in class com.uc4.api.objects.JobPlan
Returns the first task in the JobPlan monitor which has the specified object name.
getFirstTaskByName(String) - Method in class com.uc4.communication.requests.JobPlanMonitor
Returns the first task in the JobPlan monitor which has the specified object name.
getFirstWeekOfYear() - Method in class com.uc4.communication.TimeSettings
Returns the display settings for the first week.
getFixedValue() - Method in class com.uc4.api.objects.EstimatedRuntime
Returns the fixed value in seconds.
getFixedValue() - Method in class com.uc4.api.objects.MinimumRuntime
Returns the fixed value in seconds.
getFlags() - Method in class com.uc4.api.systemoverview.HostTraceOptions
 
getFolder() - Method in class com.uc4.api.SearchResultItem
Returns the folder in which this object can be found.
getFolder() - Method in class com.uc4.communication.requests.CreateObject
Returns the IFolder where the object should be created.
getFolder(String) - Method in class com.uc4.communication.requests.FolderTree
Returns the folder for the given path or null if the folder was not found.
getFolderByID(String) - Method in class com.uc4.communication.requests.FolderTree
Returns an folder object with the specified ID or null if not found.
getFolderID() - Method in class com.uc4.api.FolderListItem
Returns the Folder ID.
getFolderID() - Method in interface com.uc4.api.ITransportable
 
getFolderID() - Method in class com.uc4.api.SearchResultItem
 
getFontSize() - Method in class com.uc4.communication.FontSettings
Returns the size in which the caption should be displayed in the UserInterface.
getForecastState() - Method in class com.uc4.api.objects.Runtime
Returns the status, which should be returned by this task when making a forecast.
getFormat() - Method in class com.uc4.communication.TimeSettings
Returns the display time format.
getFormTitle() - Method in class com.uc4.api.Form
Returns the title of this form.
getFrom() - Method in class com.uc4.api.objects.EventCalendarItem
 
getFrom() - Method in class com.uc4.api.objects.QueueExceptionCondition
Returns the start of the validity period.
getFromDate() - Method in class com.uc4.communication.requests.GenericStatistics
Returns the from date for the selection.
getFromDate() - Method in class com.uc4.communication.requests.SearchObject
Returns the begin of the date range.
getGapInterval() - Method in class com.uc4.api.objects.ExecuteRecurring
 
getGapInterval() - Method in class com.uc4.api.objects.Period
Deprecated.
getGatewayHost() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the Gateway Host.
getGatewayServer() - Method in class com.uc4.api.objects.AttributesSiebel
Returns the network address of the Siebel Gateway computer.
getGatewayService() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the Gateway Service.
getGenericJdbcConnectString() - Method in class com.uc4.api.objects.DatabaseConnection
Returns the JDBC connect string if "Generic JDBC" is selected as database type.
getGroup() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the GROUP.
getGroup() - Method in class com.uc4.communication.MessageSettings
Returns the name of the user group if own messages are selected (EverythingInClient is set to false).
GetGroupMonitorProperties - Class in com.uc4.communication.requests
This class is used to get Group options of a RunID.
GetGroupMonitorProperties(int) - Constructor for class com.uc4.communication.requests.GetGroupMonitorProperties
Creates a request to read the Group monitor.
getGrp() - Method in class com.uc4.api.objects.UserRight
Returns the authorization group or -1 if NOT is selected.
getHardware() - Method in class com.uc4.api.objects.AgentAssignmentFilter.Item
 
getHardware() - Method in class com.uc4.api.objects.HostGroupItem
 
getHardware() - Method in class com.uc4.api.StorageItem
Returns the hardware type attribute.
getHardware() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the computer's hardware information (i.e.
getHardwareFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the Hardware filter.
getHeight() - Method in class com.uc4.api.objects.CockpitControl
Returns the height of the CockpitControl.
getHeight() - Method in class com.uc4.api.objects.CockpitDesign
Returns the height of the cockpit form.
getHeight() - Method in class com.uc4.api.TaskPromptSetName
Returns the height of the window in the User Interface.
getHirarchicalParent() - Method in class com.uc4.api.Task
Returns the RunID of the of hirarchical parent.
getHitRatio() - Method in class com.uc4.api.systemoverview.CacheListItem
Hits of the primary work processIt is responsible for the execution of Automation Engine internal tasks and work processes.
getHits() - Method in class com.uc4.api.systemoverview.CacheListItem
Number of entries found in the cache.
getHoldCount() - Method in class com.uc4.api.systemoverview.QueueListItem
 
getHomeFolder() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the path to the folder where the Objects exists or null if the object does not exist or this request has not been sent.
getHomeFolderId() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the OH_IDNR of the objects home folder.
getHost() - Method in class com.uc4.api.AbstractTask
Returns the name of the destination Agent.
getHost() - Method in class com.uc4.api.ForecastTreeItem
 
getHost() - Method in class com.uc4.api.objects.BackendVariable
Returns the name of the Host.
getHost() - Method in class com.uc4.api.objects.FileListVariable
Returns the name of the Host.
getHost() - Method in class com.uc4.api.objects.FileSystem
Returns the name of the Agent for this FileEvent.
getHost() - Method in class com.uc4.api.objects.JobAttributes
Returns the name of the Agent for this job.
getHost() - Method in class com.uc4.api.objects.LoginDefinition
Returns the name of the Agent or a generic host name.
getHost() - Method in class com.uc4.api.objects.OutputScan
Returns the name of the Agent which is used for external file scans.
getHost() - Method in class com.uc4.api.objects.QueueManagerAttributes
Returns the name of the Agent for this job.
getHost() - Method in class com.uc4.api.objects.UserRight
Returns the filter for Agent names.
getHost() - Method in class com.uc4.api.systemoverview.UserListItem
Returns the host name of the client.
getHost() - Method in class com.uc4.api.TaskFilter
Returns the selected hostname.
getHost() - Method in class com.uc4.communication.requests.QueryAutoforecast
 
getHost() - Method in class com.uc4.communication.requests.TaskList
Gets the host.
getHostAttrTypes() - Method in class com.uc4.api.TaskFilter
Gets the host attribute types.
getHostDestination() - Method in class com.uc4.api.objects.UserRight
Returns the filter for Agent names.
getHostDetailElement() - Method in class com.uc4.communication.requests.GetAgentProperties
Returns a value of the HostDetail section
getHostGroupType() - Method in class com.uc4.api.objects.HostGroup
Returns the Job type of all hosts in this HostGroup.
getHostGroupType() - Method in class com.uc4.communication.requests.GetAgentGroupMonitorProperties
Returns the Job type of all hosts in this HostGroup.
getHostName() - Method in class com.uc4.api.objects.ConsoleEventSetting
 
getHostName() - Method in class com.uc4.api.objects.JobPlanTask
Returns the hostName for the JobPlan task if exist otherwise will return null
getHostName() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the name of the computer on which the server process is running.
getHostname() - Method in class com.uc4.communication.requests.SetHostAuthorizations.ModificationStatus
 
getHostPropertiesElement() - Method in class com.uc4.communication.requests.GetAgentProperties
Returns the host property element
getHostTraceElement() - Method in class com.uc4.communication.requests.GetAgentProperties
Returns a value of the HostDetail section
getHostTraceOptions() - Method in class com.uc4.communication.requests.GetAgentProperties
Returns a HostTraceOptions Object
getHostType() - Method in class com.uc4.api.objects.AgentAssignmentFilter.Item
 
getHostType() - Method in class com.uc4.api.objects.FileSystem
Returns the Host type value
getHostType() - Method in class com.uc4.api.objects.JobAttributes
Returns the host typ of this job.
getHostType() - Method in class com.uc4.api.objects.LoginDefinition
Returns the host type.
getHostType() - Method in class com.uc4.api.objects.QueueManagerAttributes
Method to fetch the host type.
getHostType() - Method in class com.uc4.api.StorageItem
Returns the host type attribute.
getHour() - Method in class com.uc4.api.DateTime
Returns the hour of the day.
getHour() - Method in class com.uc4.api.objects.TimeZoneAttributes.TimeChangeRule
Gets the hour of the day at which the time change takes place.
getHours() - Method in class com.uc4.api.Time
Returns the hours as short.
getHw() - Method in class com.uc4.api.objects.ResourceItem
Return the HW (from PlatformSwHwType) of the resource.
getHw() - Method in enum com.uc4.api.PlatformSwHwType
Return the HW.
getIcon() - Method in class com.uc4.api.SearchResultItem
Returns the name of the platform icon if the object type is JOBS.
getIcon() - Method in class com.uc4.api.systemoverview.ILMPartitionItem
Returns the name of the icon in the User Interface.
getIcon() - Method in class com.uc4.api.systemoverview.MessageListItem
 
getIcon() - Method in class com.uc4.communication.requests.NotificationMonitor.CallStatus
Returns the name of the icon of the recipient.
getId() - Method in class com.uc4.api.FolderListItem
Returns the ID of this object.
getId() - Method in class com.uc4.api.ForecastItem
 
getId() - Method in class com.uc4.api.ForecastTreeItem
 
getId() - Method in class com.uc4.api.FormItemLabel
 
getId() - Method in class com.uc4.api.FormItemList
 
getId() - Method in class com.uc4.api.FormItemNumber
 
getId() - Method in class com.uc4.api.FormItemText
 
getId() - Method in interface com.uc4.api.IFormItem
Returns the internal ID of this field.
getId() - Method in interface com.uc4.api.ITransportable
 
getId() - Method in class com.uc4.api.objects.AbortAction
 
getId() - Method in interface com.uc4.api.objects.Action
 
getId() - Method in class com.uc4.api.objects.BlockAction
 
getId() - Method in class com.uc4.api.objects.CancelProcessFlowAction
 
getId() - Method in class com.uc4.api.objects.ChangeQueueAction
 
getId() - Method in class com.uc4.api.objects.CheckActivitiesCondition
 
getId() - Method in class com.uc4.api.objects.CheckConnectionCondition
 
getId() - Method in class com.uc4.api.objects.CheckFileCondition
 
getId() - Method in class com.uc4.api.objects.CheckHistoryCondition
 
getId() - Method in class com.uc4.api.objects.CheckProcessCondition
 
getId() - Method in class com.uc4.api.objects.ClearVariableAction
 
getId() - Method in class com.uc4.api.objects.CockpitControl
Returns the Id of the CockpitControl element.
getId() - Method in interface com.uc4.api.objects.Condition
 
getId() - Method in class com.uc4.api.objects.ConditionOrAction
 
getId() - Method in class com.uc4.api.objects.ConsoleSAP.EventHistoryFilter
 
getId() - Method in class com.uc4.api.objects.CurrentQueueCondition
 
getId() - Method in class com.uc4.api.objects.CurrentTimeCondition
 
getId() - Method in enum com.uc4.api.objects.ErtUsage
Gets the id for ERT Usage
getId() - Method in class com.uc4.api.objects.ExecuteObjectAction
 
getId() - Method in interface com.uc4.api.objects.IFolder
Returns the ID of the folder.
getId() - Method in class com.uc4.api.objects.ModifyStateAction
 
getId() - Method in class com.uc4.api.objects.PromptSetDefinition
 
getId() - Method in class com.uc4.api.objects.PublishValueAction
 
getId() - Method in class com.uc4.api.objects.ReEvaluateAtAction
 
getId() - Method in class com.uc4.api.objects.ReEvaluateInAction
 
getId() - Method in class com.uc4.api.objects.RestartTaskAction
 
getId() - Method in class com.uc4.api.objects.ReturnCodeCondition
 
getId() - Method in class com.uc4.api.objects.RollbackAction
 
getId() - Method in class com.uc4.api.objects.RunPathAction
 
getId() - Method in class com.uc4.api.objects.RunTaskAction
 
getId() - Method in class com.uc4.api.objects.SetValueAction
 
getId() - Method in class com.uc4.api.objects.SetVariableAction
 
getId() - Method in class com.uc4.api.objects.SkipTaskAction
 
getId() - Method in class com.uc4.api.objects.StatusCondition
 
getId() - Method in class com.uc4.api.objects.TimeSinceActivationCondition
 
getId() - Method in class com.uc4.api.objects.UserDefinedCondition
 
getID() - Method in enum com.uc4.api.objects.UserPrivileges.Privilege
 
getId() - Method in class com.uc4.api.objects.ValidityKeywordType
Returns the ID of the scope.
getId() - Method in class com.uc4.api.QuickSearchItem
Returns the ID of this object.
getId() - Method in class com.uc4.api.SearchResultItem
 
getID() - Method in class com.uc4.api.systemoverview.AgentAssignmentListItem
 
getId() - Method in class com.uc4.api.systemoverview.AgentGroupListItem
 
getId() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the ID of the Agent.
getId() - Method in class com.uc4.api.systemoverview.ClientListItem
ID of the client.
getId() - Method in class com.uc4.api.systemoverview.ILMPartitionItem
 
getId() - Method in class com.uc4.api.systemoverview.MQMemListItem
 
getId() - Method in class com.uc4.api.systemoverview.QueueListItem
 
getId() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the ID of this server process.
getID() - Method in class com.uc4.api.systemoverview.UserListItem
 
getId() - Method in class com.uc4.api.VersionControlListItem
 
getId() - Method in class com.uc4.communication.CreateFolder
Returns the IDNR of the new object
getId() - Method in class com.uc4.communication.requests.CalendarList.CalendarListItem
Returns the ID of this CALE object.
getID() - Method in class com.uc4.communication.requests.DuplicateObject
Returns the ID (OH_IDNR) of the created object.
getID() - Method in class com.uc4.communication.requests.GetObjectProperties
Get the internal object oh_idnr
getId() - Method in class com.uc4.communication.requests.NavigatorAgentTree.AgentNode
Returns the intern id of the AgentNode.
getId() - Method in class com.uc4.communication.requests.NavigatorCATree.CustomAttributeNode
Returns the intern id of the CustomAttributeNode.
getId() - Method in class com.uc4.communication.requests.NavigatorQueueTree.QueueNode
Returns the intern id of the QueueNode.
getId() - Method in class com.uc4.communication.requests.NavigatorZDUTree.ZDUNode
 
getId() - Method in class com.uc4.communication.requests.SearchIndex.Result
Gets the object OH_Idnr.
getIdent() - Method in class com.uc4.api.objects.AttributesGCOS8
Returns the name for the $ IDENT statement.
getIdnr() - Method in class com.uc4.api.AutoForecastItem
 
getIdnr() - Method in class com.uc4.api.Form
Returns the ID of the Request.
getIdnr() - Method in interface com.uc4.api.objects.ITaskItem
Returns the ID of this or ScheduleTask task.
getIdnr() - Method in class com.uc4.api.objects.JobPlanTask
 
getIdnr() - Method in class com.uc4.api.objects.ResourceItem
Returns the ID of the ResourceItem.
getIdnr() - Method in class com.uc4.api.objects.ScheduleTask
 
getIdnr() - Method in class com.uc4.api.objects.UC4Object
Returns the ID of the object.
getIdnr() - Method in class com.uc4.api.Template
Returns the ID of the template.
getIdType() - Method in class com.uc4.api.systemoverview.MQMemListItem
 
getIgnoreDiffMinRuns() - Method in class com.uc4.api.objects.EstimatedRuntime
Returns the number of past runs, which should be taken into account despite deviations.
getIgnoreDiffPercent() - Method in class com.uc4.api.objects.EstimatedRuntime
Returns the number of past runs, which should be taken into account despite deviations.
getImportMessages() - Method in class com.uc4.communication.requests.ImportObject
Returns import messages.
getImportRequest(IFolder, boolean, boolean) - Method in class com.uc4.communication.requests.ExportObject
Creates an ImportObject request from the export.
getInCalendar() - Method in class com.uc4.api.objects.RollCalendarCollision
Returns the calendar keyword whose area may be used when moving days.
getIncludeJob() - Method in class com.uc4.api.objects.AttributesGCOS8
Returns the path and name of a file containing a Job.
getIndex() - Method in class com.uc4.api.systemoverview.HostTraceOptions.HostTraceFlag
get the trace flag indext
getIndex() - Method in class com.uc4.api.TraceOptions.TraceFlag
get the trace flag index
getInherit() - Method in class com.uc4.api.objects.OutputScan
Returns an enum which describes if the scan should affect child jobs.
getInheritFromParent() - Method in class com.uc4.api.objects.ObjectValues
Returns an integer which describes how variable values are inherited from its parent.
getInheritFromParent() - Method in class com.uc4.api.objects.TaskValues
Returns an integer which describes how variable values are inherited from its parent.
getInitialContextFactory() - Method in class com.uc4.api.objects.AttributesJMX
Returns the initial context factory.
getInitialDataVersion() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getInputCheck() - Method in class com.uc4.api.FormItemText
Returns a String containing the term that determines how the user input should be checked.
getInputMsg() - Method in class com.uc4.api.systemoverview.MQMemListItem
 
getInputPriority() - Method in class com.uc4.api.objects.AttributesMPE
Returns the input priority (INPRI).
getInsert() - Method in class com.uc4.api.MessageBox
Returns the insert of this message.
getInsert() - Method in class com.uc4.api.TranslatedMessage
Returns the insert of this message.
getInsert() - Method in class com.uc4.communication.AsyncMessage
Returns the message insert for this message.
getInt(String) - Method in class com.uc4.api.objects.OCVPanel
Gets a value by its name and converts the result to an integer.
getIntAccount() - Method in class com.uc4.api.AbstractTask
Returns the used account of the object.
getIntAccount() - Method in class com.uc4.api.objects.EventAttributes
Returns the internal account assigned to this Job.
getIntAccount() - Method in class com.uc4.api.objects.FileTransferAttributes
Returns the internal account assigned to this Job.
getIntAccount() - Method in class com.uc4.api.objects.JobAttributes
Returns the internal account assigned to this Job.
getIntAccount() - Method in class com.uc4.api.objects.JobPlanAttributes
Returns the internal account assigned to this JobPlan.
getIntAccount() - Method in class com.uc4.api.objects.NotificationAttributes
Returns the internal account assigned to this Notification.
getIntAccount() - Method in class com.uc4.api.objects.QueueManagerAttributes
Returns the internal account assigned to this Job.
getIntAccount() - Method in class com.uc4.api.objects.ScheduleAttributes
Returns the internal account assigned to this job.
getIntAccount() - Method in class com.uc4.api.objects.ScriptAttributes
Returns the internal account assigned to this Script.
getInterval(String) - Method in class com.uc4.api.objects.LocaAttributes
Gets the Interval from given key.
getIntervalEndDate() - Method in class com.uc4.api.objects.YearlyCalendarKeyword
Returns the end date of the interval.
getIntervalEndDay() - Method in class com.uc4.api.objects.MonthlyCalendarKeyword
Returns the end day of the interval.
getIntervalEveryDay() - Method in class com.uc4.api.objects.MonthlyCalendarKeyword
Returns the interval in days.
getIntervalEveryDay() - Method in class com.uc4.api.objects.YearlyCalendarKeyword
Returns the interval in days.
getIntervalListSize() - Method in class com.uc4.api.objects.LocaAttributes
Returns the size of interval hashmap of this Loca - Object .
getIntervalStartDate() - Method in class com.uc4.api.objects.YearlyCalendarKeyword
Returns the start date of the interval.
getIntervalStartDay() - Method in class com.uc4.api.objects.MonthlyCalendarKeyword
Returns the start day of the interval.
getInvalidName() - Method in exception com.uc4.api.InvalidUC4NameException
Returns the invalid name.
getIpAddress() - Method in class com.uc4.api.objects.AgentAssignmentFilter.Item
 
getIpAddress() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the Agent's TCP/IP address.
getIpAddress() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the TCP/IP address of the server process.
getIPakChange() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the IPak Change parameter.
getItemList() - Method in class com.uc4.api.prompt.CheckGroupElement
When a Prompt is executed (see request TaskPromptSetContent) this method returns a list of valid items.
getItemList() - Method in class com.uc4.api.prompt.ComboElement
When a Prompt is executed (see request TaskPromptSetContent) this method returns a list of valid items.
getItemList() - Method in interface com.uc4.api.prompt.PromptInterfaces.ItemList
When a Prompt is executed (see request TaskPromptSetContent) this method returns a list of valid items.
getItemList() - Method in class com.uc4.api.prompt.RadioGroupElement
When a Prompt is executed (see request TaskPromptSetContent) this method returns a list of valid items.
getItems() - Method in class com.uc4.api.systemoverview.CacheListItem
Number of all cache entries.
getJavaConnection() - Method in class com.uc4.api.objects.SAPAgentPanel
 
getJclVariant() - Method in class com.uc4.api.systemoverview.AgentGroupListItem
Returns the JCL variant of the host group.
getJclVariant() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the JCL (Job Control Language) variant.
getJndiName() - Method in class com.uc4.api.objects.AttributesJMX
Returns the JNDI Name.
getJobclass() - Method in class com.uc4.api.objects.AttributesBS2000
Returns the specification of the Job's class.
getJobClass() - Method in class com.uc4.api.objects.AttributesOS390
Returns the Job class in which the Job should run.
getJobClass() - Method in class com.uc4.api.objects.AttributesSAP
Returns the selected Job class.
getJobCount() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
 
getJobDescription() - Method in class com.uc4.api.objects.AttributesOS400
Returns the name of the Job description used for this Job in the form Library/Job description.
getJobGroup() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
 
getJobName() - Method in class com.uc4.api.objects.AttributesMPE
Returns the job name.
getJobName() - Method in class com.uc4.api.objects.AttributesOS390
Returns the name of the Job in the system.
getJobName() - Method in class com.uc4.api.objects.AttributesOS400
Returns the Job name.
getJobName() - Method in class com.uc4.api.objects.AttributesSAP
Returns the Job name.
getJobName() - Method in class com.uc4.api.objects.AttributesVMS
Returns the name under which a Job should be executed.
getJobName() - Method in class com.uc4.api.objects.ConsoleOS390.ConsoleOS390Filter
Returns the filter for a job name.
getJobName() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
 
getJobParameters() - Method in class com.uc4.api.objects.AttributesOS390
Returns additional job parameters, for example "TIME=1440".
getJobPlanTask() - Method in class com.uc4.communication.requests.AddJobPlanTask
Returns a JobPlan Task or null if the task was not found.
getJobQueue() - Method in class com.uc4.api.objects.AttributesOS400
Returns the name of the Job queue in which the this Job has been put.
getKeepAlive() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the interval in which the server queries the Agent to test if the Agent is alive.
getKerberosToken() - Method in class com.uc4.communication.ConnectionAttributes
Returns the kerberos token.
getKey() - Method in class com.uc4.api.objects.AttributesOA
Returns the responsibility key for the Oracle user.
getKey() - Method in class com.uc4.api.objects.ClearVariableAction
 
getKey() - Method in class com.uc4.api.objects.CockpitControlDataSource
Returns the used key of the data source variable.
getKey() - Method in class com.uc4.api.objects.SetVariableAction
 
getKey() - Method in class com.uc4.api.systemoverview.ExitListItem
 
getKey() - Method in class com.uc4.api.systemoverview.MQMemListItem
 
getKey() - Method in class com.uc4.communication.requests.ExportAuthenticationPackage
 
getKey() - Method in class com.uc4.communication.requests.ExportCompanyKey
 
getKeyword() - Method in class com.uc4.api.objects.CalendarCondition
Returns the calendar keyword.
getKeywordAsString() - Method in class com.uc4.api.objects.CalendarCondition
This method returns the keyword as String.
getKickEventType() - Method in class com.uc4.communication.KickEvent
 
getKicks() - Method in class com.uc4.communication.ConnectionAttributes
This connection is registered to receive the kick messages returned by this procedure.
getKicks() - Method in class com.uc4.communication.SSOConfiguration
This connection is registered to receive the kick messages returned by this procedure.
getLabel() - Method in class com.uc4.api.FormItemLabel
 
getLabel() - Method in class com.uc4.api.FormItemList
 
getLabel() - Method in class com.uc4.api.FormItemNumber
 
getLabel() - Method in class com.uc4.api.FormItemText
 
getLabel() - Method in interface com.uc4.api.IFormItem
Returns the label of the field.
getLanguage() - Method in class com.uc4.api.objects.AttributesSAP
Returns the selected language.
getLanguage() - Method in class com.uc4.api.objects.AttributesSiebel
Returns the login language.
getLanguage() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the logon language.
getLanguage() - Method in class com.uc4.api.systemoverview.UserListItem
Returns the language selected at last user logon.
getLanguage() - Method in class com.uc4.communication.ConnectionAttributes
 
getLastCheck() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the time of last check or null if this host is not active.
getLastLogoff() - Method in class com.uc4.api.systemoverview.AgentListItem
 
getLastMessage() - Method in class com.uc4.api.ForecastItem
 
getLastModified() - Method in class com.uc4.api.objects.Header
Indicates user, date and time regarding the most recent modification of the object.
getLastModified() - Method in class com.uc4.api.objects.XHeader
Indicates user, date and time regarding the most recent modification of the object.
getLastModifiedByUser() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the name of the user that has done the last modification in the object.
getLastModifiedDate() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the time stamp when the object was last modified.
getLastName() - Method in class com.uc4.api.objects.UserAttributes
 
getLastName() - Method in class com.uc4.api.systemoverview.UserListItem
Returns User's last name.
getLastName() - Method in class com.uc4.communication.requests.GetChangeLog.Entry
Returns the last name of the user who did the change.
getLastName() - Method in class com.uc4.communication.requests.SynchronizeLDAP
Returns the last name of the user or null if this request has not been sent.
getLastRestartPoint() - Method in class com.uc4.communication.requests.GetRestartInformation
Returns the last restart point.
getLastRuns() - Method in class com.uc4.api.objects.EstimatedRuntime
Returns the number of past runs which are taken into account when calculating the ERT.
getLastRunsPercent() - Method in class com.uc4.api.objects.EstimatedRuntime
Returns the value in percent for an upward correction or the ERT.
GetLastRuntimes - Class in com.uc4.communication.requests
Returns real runtimes (RRT) and estimated runtimes (ERT) of the last 25 runs of an activatable object.
GetLastRuntimes(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetLastRuntimes
Creates a new request to get the last 25 RRTs and ERTs.
GetLastRuntimes(int) - Constructor for class com.uc4.communication.requests.GetLastRuntimes
Creates a new request to get the last 25 RRTs and ERTs.
getLastSession() - Method in class com.uc4.api.systemoverview.UserListItem
Date and time of the last logon or null.
getLastTimeCnt() - Method in class com.uc4.api.TaskFilter
Returns the count for the last Activation.
getLastUsed() - Method in class com.uc4.api.objects.Header
Indicates user, date and time regarding the most recent use of the object.
getLastUsed() - Method in class com.uc4.api.objects.XHeader
Indicates user, date and time regarding the most recent use of the object.
getLatestEndDays() - Method in class com.uc4.api.objects.JobPlanDependencies
Returns the number of days for the latest end time of this task.
getLatestEndTime() - Method in class com.uc4.api.objects.JobPlanDependencies
Returns the Time for the latest end of this task.
getLatestEndTime() - Method in class com.uc4.api.objects.SloFulfillment
 
getLatestStartDays() - Method in class com.uc4.api.objects.JobPlanDependencies
Returns the number of days for the latest start time of this task.
getLatestStartTime() - Method in class com.uc4.api.objects.JobPlanDependencies
Returns the Time for the latest start of this task.
getLatestStartTime() - Method in class com.uc4.api.objects.SloFulfillment
 
getLeft() - Method in class com.uc4.api.objects.CockpitControl
Returns the distance to the left.
getLicenseCategory() - Method in class com.uc4.api.objects.AgentAssignmentFilter.Item
Returns the name of the license category which has been assigned to the Agent.
getLicenseCategory() - Method in class com.uc4.api.objects.HostAttributes
Returns the License Category that is to be used by the Agent.
getLicenseCategory() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the name of the license category assigned to the Agent.
getLicenseCategoryFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the license category filter.
getLicenseClass() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the Agent's license class.
getLicenseClass() - Method in class com.uc4.api.systemoverview.LicenseListItem
Returns the license class that complies with the acquired license and hardware and software.
getLicenseClassFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the license class filter.
getLinkedToServiceManagerFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the service manager link filter.
getLnr() - Method in interface com.uc4.api.objects.ITaskItem
Returns number containing the order of activation.
getLnr() - Method in class com.uc4.api.objects.JobPlanTask
 
getLnr() - Method in class com.uc4.api.objects.ScheduleTask
 
getLnr() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the activation order number of this task.
getLoadAt(int) - Method in class com.uc4.api.systemoverview.WorkloadItem
Returns the workload of this client in percent at the specified time.
getLocaMessage(String) - Method in class com.uc4.api.objects.LocaMessages
Get a LocaMessageItem with an given MessageNummber.
getLogicalDateTime() - Method in class com.uc4.communication.requests.GetExecuteOnce
 
getLogicalStart() - Method in class com.uc4.api.AutoForecastItem
 
getLogicalStart() - Method in class com.uc4.api.ForecastItem
 
getLogicalStart() - Method in class com.uc4.api.ForecastTreeItem
 
getLogin() - Method in class com.uc4.api.AutoForecastItem
 
getLogin() - Method in class com.uc4.api.objects.BackendVariable
Returns the name of the LOGIN object.
getLogin() - Method in class com.uc4.api.objects.CheckFileCondition
Returns the name of the Login object.
getLogin() - Method in class com.uc4.api.objects.CheckProcessCondition
 
getLogin() - Method in class com.uc4.api.objects.DynamicSQLVariable
 
getLogin() - Method in class com.uc4.api.objects.FileListVariable
Returns the name of the LOGIN object.
getLogin() - Method in class com.uc4.api.objects.FileSystem
Returns the name of the login object assigned "FileSystem" tab of an file event object.
getLogin() - Method in class com.uc4.api.objects.JobAttributes
Returns the name of the login object assigned to this job.
getLogin() - Method in class com.uc4.api.objects.OutputScan
Returns the name of the login object which is used for external file scans.
getLogin() - Method in class com.uc4.api.objects.SAPConnectionHTTP
Returns the Login
getLogin() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the Login
getLogin() - Method in class com.uc4.api.objects.SecureSQLVariable
 
getLogin() - Method in class com.uc4.api.objects.UserRight
Returns the filter for names of Login objects.
getLogin() - Method in class com.uc4.communication.requests.QueryAutoforecast
 
getLoginDestination() - Method in class com.uc4.api.objects.UserRight
Returns the filter for names of Login objects.
getLoginInfo() - Method in class com.uc4.api.objects.LoginDefinition
Returns the login information.
getLoginName() - Method in class com.uc4.api.objects.ConsoleSAP
 
getLoginObject() - Method in class com.uc4.api.objects.DatabaseEventValue
 
getLongDescription() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
 
getMagneticArea() - Method in class com.uc4.communication.GeneralSettings
Returns the magnetic area in pixels.
getMagneticWindows() - Method in class com.uc4.communication.GeneralSettings
Returns the magnetic scope of the windows that are shown in the UserInterface.
getMail1() - Method in class com.uc4.api.systemoverview.UserListItem
Returns user's first email address.
getMail2() - Method in class com.uc4.api.systemoverview.UserListItem
Returns user's second email address.
getMax() - Method in class com.uc4.api.objects.CockpitThresholds
Returns the maximal value.
getMaxCharacters() - Method in class com.uc4.api.objects.AttributesSQL
Returns the max.
getMaxConnectionCount() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the maximum number of concurrent RFC connections to the SAP system.
getMaxCPU() - Method in class com.uc4.api.objects.AttributesBS2000
Returns the maximum CPU time (in seconds) that is available for the Job.
getMaxFileTransfer() - Method in class com.uc4.communication.requests.GetAgentProperties
Returns the maximum number of FileTransfers, -1 if the Agent is not active or the setting is unlimited.
getMaxFileTransferResources() - Method in class com.uc4.api.systemoverview.AgentListItem
 
getMaximum() - Method in class com.uc4.api.FormItemNumber
Returns the maximum value which is allowed as input.
getMaximumDate() - Method in class com.uc4.api.objects.VariableAttributes
Returns the maximum date or null if not set.
getMaximumLength() - Method in class com.uc4.api.objects.VariableAttributes
Returns the maximum number of characters for the first value in variable.
getMaximumNumber() - Method in class com.uc4.api.objects.VariableAttributes
Returns the maximum number.
getMaximumTime() - Method in class com.uc4.api.objects.VariableAttributes
Returns the maximum time or null if not set.
getMaximumTimestamp() - Method in class com.uc4.api.objects.VariableAttributes
Returns the maximum timestamp or null if not set.
getMaximumValue() - Method in class com.uc4.api.prompt.DateElement
Deprecated.
use getMaxValue instead
getMaximumValue() - Method in class com.uc4.api.prompt.NumberElement
Deprecated.
use getMaxValue() instead
getMaximumValue() - Method in class com.uc4.api.prompt.TimeElement
Deprecated.
use getMaxValue instead
getMaximumValue() - Method in class com.uc4.api.prompt.TimeStampElement
Returns the maximum value.
getMaxJobResources() - Method in class com.uc4.api.systemoverview.AgentListItem
 
getMaxJobs() - Method in class com.uc4.communication.requests.GetAgentProperties
Returns the maximum number of Jobs or -1 if the Agent is not active or the setting is unlimited.
getMaxLength() - Method in class com.uc4.api.FormItemNumber
Returns the maximum number of allowed digits.
getMaxLength() - Method in class com.uc4.api.FormItemText
Returns the maximum number of allowed characters.
getMaxLength() - Method in exception com.uc4.api.InvalidUC4NameException
Returns the maximal allowed length of the name or zero if no restriction is set.
getMaxLength() - Method in class com.uc4.api.prompt.TextElement
 
getMaxNumber() - Method in class com.uc4.communication.MessageSettings
Returns the maximum number of messages in the Message Window.
getMaxParallel() - Method in class com.uc4.api.objects.Group
Deprecated.
use attributes.maxParallel of this group instead
getMaxParallel() - Method in class com.uc4.api.objects.GroupAttributes
Returns the maximum number of executable objects which are allowed to run simultaneously in a Group.
getMaxParallel() - Method in class com.uc4.api.objects.QueueManagerAttributes
 
getMaxParallelJobs() - Method in class com.uc4.api.objects.HostGroup
Returns the maximum number of parallel tasks when the execution mode is set to ALL.
getMaxParallelJobs() - Method in class com.uc4.communication.requests.GetAgentGroupMonitorProperties
Returns the maximum number of parallel tasks when the execution mode is set to ALL.
getMaxParallelJobs() - Method in class com.uc4.communication.requests.GetGroupMonitorProperties
Returns the maximum number of parallel tasks
getMaxParallelSessions() - Method in class com.uc4.api.objects.UserAttributes
Returns the maximum number of parallel login sessions a user may have.
getMaxParallelTasks() - Method in class com.uc4.communication.requests.GroupMonitor
Returns the maximum parallel tasks in group
getMaxParallelTransfers() - Method in class com.uc4.api.objects.FileTransferSettings
 
getMaxReportBlocks() - Method in class com.uc4.communication.requests.GetAgentProperties
Returns the maximum number of report blocks; -1 if the Agent is not active.
getMaxRetCode() - Method in class com.uc4.api.objects.Runtime
Returns the maximum Return Code for the normal end of a task.
getMaxRows() - Method in class com.uc4.api.objects.AttributesSQL
Returns the max.
getMaxRunID() - Method in class com.uc4.api.systemoverview.ILMHistoryItem
Returns the largest RunID of the partition.
getMaxRunID() - Method in class com.uc4.api.systemoverview.ILMPartitionItem
Returns the largest RunID of the partition.
getMaxSingleObjectRecords() - Method in class com.uc4.communication.StatisticsSettings
Returns the maximum number of statistical data that should be shown in an object's statistical overview.
getMaxSlots() - Method in class com.uc4.api.objects.QueueAttributes
 
getMaxSlots() - Method in class com.uc4.api.objects.QueueExceptionCondition
 
getMaxSlots() - Method in class com.uc4.api.systemoverview.QueueListItem
 
getMaxSlots() - Method in class com.uc4.communication.requests.GetModifyQueue
returns the max slots value for queue
getMaxStoreImportSize() - Method in class com.uc4.communication.GeneralSettings
Returns the maximum size in bytes for binary uploads (STORE objects).
getMaxTraceSize() - Method in class com.uc4.api.systemoverview.HostTraceOptions
 
getMaxTraceSize() - Method in class com.uc4.api.TraceOptions
get the maximum trace size in MB
getMaxTraceSize() - Method in class com.uc4.communication.requests.GetAgentProperties
returns the max trace size parameter
getMaxTraceSize() - Method in class com.uc4.communication.requests.GetCPProperties
returns the max trace size parameter
getMaxTraceSize() - Method in class com.uc4.communication.requests.GetWPProperties
returns the max trace size parameter
getMaxValue() - Method in class com.uc4.api.prompt.DateElement
 
getMaxValue() - Method in class com.uc4.api.prompt.NumberElement
Returns the maximum value.
getMaxValue() - Method in interface com.uc4.api.prompt.PromptInterfaces.Constraints
maximum value @nullable
getMaxValue() - Method in class com.uc4.api.prompt.TimeElement
 
getMemberListSize() - Method in class com.uc4.api.objects.UserAssignment
 
getMemberListSize() - Method in class com.uc4.api.objects.UserGroupAssignment
 
getMessage() - Method in exception com.uc4.api.InvalidUC4NameException
 
getMessage() - Method in class com.uc4.api.objects.NotificationSettings
Returns the message of this Notification.
getMessage() - Method in class com.uc4.api.systemoverview.MessageListItem
 
getMessage() - Method in class com.uc4.communication.requests.ActiveNotifications.Entry
Returns the message text of this notification.
getMessage() - Method in class com.uc4.communication.requests.GetChangeLog.Entry
Returns the message text.
getMessage() - Method in class com.uc4.communication.requests.NotificationMonitor
Returns the message text of this notification.
getMessage() - Method in class com.uc4.communication.requests.SetHostAuthorizations.ModificationStatus
 
getMessageBox() - Method in class com.uc4.communication.requests.XMLRequest
Returns a MessageBox object if the server returns a message for this request.
getMessageClassesReport() - Method in class com.uc4.api.objects.AttributesOS390
 
getMessageCount() - Method in class com.uc4.api.objects.LocaMessages
Returns the size of message hashmap of this Loca - Object.
getMessageDump() - Method in class com.uc4.communication.requests.ShowQuarantineMessage
Returns the message.
getMessageFilter() - Method in class com.uc4.api.objects.ConsoleOS390.ConsoleOS390Filter
Returns the filter for the console output.
getMessageFilter() - Method in class com.uc4.api.objects.ConsoleOS400.ConsoleOS400Filter
 
getMessageFilter() - Method in class com.uc4.api.objects.ConsoleWindows.ConsoleWindowsFilter
 
getMessageID() - Method in class com.uc4.api.objects.ConsoleOS400.ConsoleOS400Filter
 
getMessageId() - Method in class com.uc4.api.objects.LocaMessageItem
 
getMessageInsert() - Method in class com.uc4.api.objects.PromptElement
This method returns a message insert for the message number returned by getMessageNumber.
getMessageInsert() - Method in class com.uc4.api.TaskFilter
Returns the remote status message insert filter.
getMessageInsert() - Method in class com.uc4.communication.requests.ExecuteObject
This method returns a message insert for the message number returned by getMessageNumber.
getMessageInsert() - Method in class com.uc4.communication.requests.ExecuteObjects.ExecuteObjectsResponse
This method returns a message insert for the message number returned by getMessageNumber.
getMessageNumber() - Method in class com.uc4.api.objects.PromptElement
This method returns a message number in case a Prompt is executed but its value is not valid.
getMessageNumber() - Method in class com.uc4.api.systemoverview.QuarantineListItem
Returns the number of the message.
getMessageNumber() - Method in class com.uc4.api.TaskFilter
Returns the remote status message number filter.
getMessageNumber() - Method in class com.uc4.communication.requests.ExecuteObject
This method returns a message number in case that the execution failed.
getMessageNumber() - Method in class com.uc4.communication.requests.ExecuteObjects.ExecuteObjectsResponse
This method returns a message number in case that the execution failed.
getMessageQueues() - Method in class com.uc4.communication.requests.GetDatabaseInfo
Returns an array of message queues.
getMessages() - Method in class com.uc4.communication.ActivationProtocol
Returns messages of the activation protocol.
getMessageServer() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the Message Server.
getMessageText() - Method in class com.uc4.api.StatisticSearchItem
Returns the message text for HOST, USER and SERVER objects.
getMessageText() - Method in class com.uc4.communication.requests.ExecuteObject
Returns the error message translated in the language of the user.
getMessageText() - Method in class com.uc4.communication.requests.ExecuteObjects.ExecuteObjectsResponse
Returns the error message translated in the language of the user.
getMessageTxtMap() - Method in class com.uc4.api.objects.LocaMessageItem
Returns the text-map of this Message item - Object.
getMessageType() - Method in class com.uc4.api.objects.ConsoleOS400
 
getMessageType() - Method in class com.uc4.api.systemoverview.MessageListItem
 
getMib() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the Agent's MIB information.
getMibFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the MIB filter.
getMibInfo() - Method in class com.uc4.api.objects.Client
Returns the MIB Info.
getMibInfo() - Method in class com.uc4.api.systemoverview.ClientListItem
Returns MIB information of the client.
getMibMonitor() - Method in class com.uc4.api.systemoverview.ClientListItem
Displays whether the client is subject to SNMP monitoring.
getMin() - Method in class com.uc4.api.objects.CockpitThresholds
Returns the minimal value.
getMinActivityRefresh() - Method in class com.uc4.api.objects.UserAttributes
Returns the User-specific minimum interval in seconds for refreshing activities (display refresh).
getMinimum() - Method in class com.uc4.api.FormItemNumber
Returns the minimum value which is allowed as input.
getMinimumDate() - Method in class com.uc4.api.objects.VariableAttributes
Returns the minimum date or null if not set.
getMinimumNumber() - Method in class com.uc4.api.objects.VariableAttributes
Returns the minimum number.
getMinimumTime() - Method in class com.uc4.api.objects.VariableAttributes
Returns the minimum time or null if not set.
getMinimumTimestamp() - Method in class com.uc4.api.objects.VariableAttributes
Returns the minimum timestamp or null if not set.
getMinimumValue() - Method in class com.uc4.api.prompt.DateElement
Deprecated.
use getMinValue instead
getMinimumValue() - Method in class com.uc4.api.prompt.NumberElement
Deprecated.
Use getMinValue() instead
getMinimumValue() - Method in class com.uc4.api.prompt.TimeElement
Deprecated.
use getMinValue instead
getMinimumValue() - Method in class com.uc4.api.prompt.TimeStampElement
Returns the minimum value.
getMinRunID() - Method in class com.uc4.api.systemoverview.ILMHistoryItem
Returns the smallest RunID of the partition.
getMinRunID() - Method in class com.uc4.api.systemoverview.ILMPartitionItem
Returns the smallest RunID of the partition.
getMinute() - Method in class com.uc4.api.DateTime
Returns the minute.
getMinute() - Method in class com.uc4.api.objects.TimeZoneAttributes.TimeChangeRule
Gets the number of minutes after the hour at which the time change takes place.
getMinutes() - Method in class com.uc4.api.objects.ReEvaluateInAction
 
getMinutes() - Method in class com.uc4.api.objects.RestartTaskAction
Returns the number of minutes or -1 if the parameter has not been set.
getMinutes() - Method in class com.uc4.api.Time
Returns the minutes as short.
getMinValue() - Method in class com.uc4.api.prompt.DateElement
 
getMinValue() - Method in class com.uc4.api.prompt.NumberElement
Returns the minimum value.
getMinValue() - Method in interface com.uc4.api.prompt.PromptInterfaces.Constraints
minimum value @nullable
getMinValue() - Method in class com.uc4.api.prompt.TimeElement
 
getMLSId() - Method in enum com.uc4.api.objects.ErtUsage
Gets the MLS id against ERT Usage
getModCnt() - Method in class com.uc4.api.ServiceLevelObjectiveListItem
Provides the modification counter for the SLO object.
getMode() - Method in class com.uc4.api.systemoverview.AgentGroupListItem
Returns the mode of the host group.
getModifiationDate() - Method in class com.uc4.api.ServiceLevelObjectiveListItem
Provides the date of the last modification of this SLO Object.
getModificationCount() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the number of modifications on this object.
getModificationFlag() - Method in class com.uc4.api.StatisticSearchItem
 
getModificationFlag() - Method in class com.uc4.api.Task
Returns the value of the modification flag column.
getModified() - Method in class com.uc4.api.SearchResultItem
Returns the date and time of the last modification.
getModifiedBy() - Method in class com.uc4.api.VersionControlListItem
Returns the name of the UC4 user which has modified the object.
getModifiedBy() - Method in class com.uc4.communication.requests.GetSyncMonitor
Returns the user or task that modified this sync.
getModifiedDate() - Method in class com.uc4.api.StorageItem
Returns the modified date of the file in local time zone of the user who uploaded the file.
getModifiedDate() - Method in class com.uc4.api.VersionControlListItem
 
getModifiedDate() - Method in class com.uc4.communication.requests.GetSyncMonitor
Returns the last modification time of this SYNC.
getModifyFlag() - Method in class com.uc4.communication.requests.TaskList
Returns modify flag.
GetModifyQueue - Class in com.uc4.communication.requests
Class to fetch the modify queue data for a particular Queue.
GetModifyQueue(String) - Constructor for class com.uc4.communication.requests.GetModifyQueue
Creates a new GetModifyQueue request object.
getMonitor() - Method in class com.uc4.communication.requests.ModifyProcessFlowMonitor
Returns an updated ProcessFlow monitor after this request has been executed.
getMonitor() - Method in class com.uc4.communication.requests.OpenProcessFlowModification
Returns the monitor of the ProcessFlow or null if this request has not been executed successfully.
getMonth() - Method in class com.uc4.api.DateTime
Returns the month of this DateTime object.
getMonth() - Method in class com.uc4.api.objects.TimeZoneAttributes.TimeChangeRule
Gets the month of a particular year in which the time change is made.
getMqdwp() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getMqjwp() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getMqmem() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getMQmemType1() - Method in class com.uc4.api.systemoverview.MQMemListItem
 
getMQmemType2() - Method in class com.uc4.api.systemoverview.MQMemListItem
 
getMqowp() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getMqpwp() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getMqrwp() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getMqSetActive() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the name of the message queue set for new message.
getMqSetOwn() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the name of the message queue set that is used by this server.
getMqwp() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getMsgClass() - Method in class com.uc4.api.objects.AttributesOS390
Returns the Job log's message class.
getMsgInsert() - Method in class com.uc4.communication.requests.TaskList
Returns remote status insert.
getMsgLevel() - Method in class com.uc4.api.objects.AttributesOS390
Returns the trace option for the job log.
getMsgLongTxt(LocaMessageItem.Language) - Method in class com.uc4.api.objects.LocaMessageItem
Returns the long text of an languages.
getMsgNumber() - Method in class com.uc4.communication.requests.TaskList
Returns remote status number.
getMsgTxt(LocaMessageItem.Language) - Method in class com.uc4.api.objects.LocaMessageItem
Returns the message of an languages.
getMultiSelectSeparator() - Method in class com.uc4.api.prompt.CheckGroupElement
Returns the mulit select separator character.
getMultiSelectSeparator() - Method in interface com.uc4.api.prompt.PromptInterfaces.MultiSelect
Returns the mulit select separator character.
getMultiSelectSeparator() - Method in class com.uc4.api.prompt.TextElement
Returns the mulit select separator character.
getName() - Method in class com.uc4.api.AbstractTask
Returns the name of the object.
getName() - Method in class com.uc4.api.AutoForecastItem
 
getName() - Method in class com.uc4.api.ComponentWorkflowObjectName
Returns the object name of the template.
getName() - Method in class com.uc4.api.DetailGroup
Returns the name of this group.
getName() - Method in class com.uc4.api.FolderListItem
Returns the name of this object.
getName() - Method in class com.uc4.api.ForecastItem
 
getName() - Method in class com.uc4.api.ForecastTreeItem
 
getName() - Method in interface com.uc4.api.ITransportable
 
getName() - Method in interface com.uc4.api.ITreeItem
Returns the name of this ITreeItem.
getName() - Method in class com.uc4.api.objects.AbstractDocumentation
 
getName() - Method in class com.uc4.api.objects.AgentAssignmentFilter.Item
 
getName() - Method in class com.uc4.api.objects.CalendarCondition
Returns the name of the Calendar.
getName() - Method in class com.uc4.api.objects.CalendarKeyword
Returns the name of the Calendar Keyword.
getName() - Method in class com.uc4.api.objects.CheckActivitiesCondition
 
getName() - Method in class com.uc4.api.objects.CheckHistoryCondition
 
getName() - Method in class com.uc4.api.objects.CustomAttribute
Returns the name of the Custom Attribute.
getName() - Method in class com.uc4.api.objects.ExecuteObjectAction
 
getName() - Method in class com.uc4.api.objects.ExecuteRecurring
Returns the name or null if it has not been set.
getName() - Method in class com.uc4.api.objects.HostGroupItem
 
getName() - Method in interface com.uc4.api.objects.IFolder
Returns the name of the folder.
getName() - Method in class com.uc4.api.objects.ObjectRight
Returns the UC4UserName (User) or UC4ObjectName (UserGroup) for the ObjectRight.
getName() - Method in class com.uc4.api.objects.PromptSetDefinition
 
getName() - Method in class com.uc4.api.objects.ResourceItem
Return the name of the resource.
getName() - Method in class com.uc4.api.objects.ServerAttributes
Returns the name in the Service Manager.
getName() - Method in class com.uc4.api.objects.SetValueAction
 
getName() - Method in class com.uc4.api.objects.SloSelection.Beneficiary
Returns the name of the Beneficiary.
getName() - Method in class com.uc4.api.objects.TaskState
Returns the name of the task state.
getName() - Method in class com.uc4.api.objects.UC4Object
Returns the name of the object.
getName() - Method in class com.uc4.api.objects.UserRight
Returns the filter for object name and folder path.
getName() - Method in class com.uc4.api.QuickSearchItem
Returns the name of the object.
getName() - Method in class com.uc4.api.SearchResultItem
Returns the name of the object.
getName() - Method in class com.uc4.api.ServiceLevelObjectiveListItem
Provides the name of the SLO object.
getName() - Method in class com.uc4.api.StorageItem
Returns name of the resource.
getName() - Method in class com.uc4.api.systemoverview.AgentAssignmentListItem
Returns the name of the Agent assignment.
getName() - Method in class com.uc4.api.systemoverview.AgentGroupListItem
Returns the name of the host group.
getName() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the name of the Agent.
getName() - Method in class com.uc4.api.systemoverview.CacheListItem
Area of the Server input buffer: SCRIPT - for Script VARA - for UC4 Variable MQMEM - for message queues ODOC and XREQ - for UserInterfaces USER - for users who use an Automation Engine system.
getName() - Method in class com.uc4.api.systemoverview.CheckILMPartitionItem
Returns the name of the object.
getName() - Method in class com.uc4.api.systemoverview.ExitListItem
 
getName() - Method in class com.uc4.api.systemoverview.QueueListItem
 
getName() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the Server process name.
getName() - Method in class com.uc4.api.systemoverview.UserListItem
Returns the name of the user.
getName() - Method in class com.uc4.api.TaskPromptSetName
Returns the name of the Prompt Set.
getName() - Method in class com.uc4.api.UC4ObjectName
Returns the name or an empty string if the name is not set.
getName() - Method in class com.uc4.communication.ActivationProtocol
 
getName() - Method in class com.uc4.communication.requests.ActiveNotifications.Entry
Returns the name of the Notification object.
getName() - Method in class com.uc4.communication.requests.CalendarList.CalendarListItem
Returns the name of this CALE object.
getName() - Method in class com.uc4.communication.requests.CheckAuthorizations.Candidate
Returns the name of the Object.
getName() - Method in class com.uc4.communication.requests.CreateObject
Returns the name of the object.
getName() - Method in class com.uc4.communication.requests.GetDatabaseInfo.MQEntry
 
getName() - Method in class com.uc4.communication.requests.GetDeployObjectProperties
Returns the name of the UC4 JOBP Object.
getName() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the name of the Object.
getName() - Method in class com.uc4.communication.requests.GetSessionTZ
Returns the name of the Session TimeZone.
getName() - Method in class com.uc4.communication.requests.GroupMonitor.Task
 
getName() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
 
getName() - Method in class com.uc4.communication.requests.NavigatorAgentTree.AgentNode
 
getName() - Method in class com.uc4.communication.requests.NavigatorCATree.CustomAttributeNode
 
getName() - Method in class com.uc4.communication.requests.NavigatorQueueTree.QueueNode
 
getName() - Method in class com.uc4.communication.requests.NavigatorStatusTree.StatusNode
 
getName() - Method in class com.uc4.communication.requests.NavigatorZDUTree.ZDUNode
 
getName() - Method in class com.uc4.communication.requests.QueryAutoforecast
 
getName() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
 
getName() - Method in class com.uc4.communication.requests.SearchIndex.Result
Gets the object name.
getName() - Method in class com.uc4.communication.requests.SearchObject
Returns the object name filter.
getNameFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the name filter of the Agent.
getNDay() - Method in class com.uc4.api.objects.TimeZoneAttributes.TimeChangeRule
Gets the predetermined weekday(for example, the 2nd or 3rd Wednesday) of the month the time change take place.
getNetArea() - Method in class com.uc4.api.systemoverview.AgentListItem
 
getNetArea() - Method in class com.uc4.api.systemoverview.ServerListItem
 
getNetAreaFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the Net area filter.
getNewOperator() - Method in class com.uc4.api.objects.SyncAction
Returns the operator which modifies the new value.
getNewState() - Method in class com.uc4.api.objects.SyncAction
Returns the name of the new state.
getNewValue() - Method in class com.uc4.api.objects.SyncAction
Returns the new value.
getNextCheck() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
Returns the timestamp of the next check.
getNextStart() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
Returns the timstamp of the next start.
getNMonth() - Method in class com.uc4.api.objects.MonthlyCalendarKeyword
Returns the period in month.
getNodeName() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
Method to fetch the SAP node name.
getNodeName() - Method in class com.uc4.api.objects.XMLDocuNode
Returns the name of this node.
getNoFolder() - Method in class com.uc4.communication.requests.FolderTree
Returns an IFolder object which represents the "No Folder".
getNoMemberListSize() - Method in class com.uc4.api.objects.UserAssignment
 
getNoMemberListSize() - Method in class com.uc4.api.objects.UserGroupAssignment
 
getNotificationType() - Method in class com.uc4.communication.requests.NotificationMonitor
Returns the type of the notification independent of the logon languge.
getNotify() - Method in class com.uc4.api.objects.AttributesOS390
Returns a notify on OS/390.
getNumber() - Method in class com.uc4.api.MessageBox
Returns the number of this message.
getNumber() - Method in class com.uc4.api.objects.ForecastTaskState
Gets the return code of this status.
getNumber() - Method in class com.uc4.api.systemoverview.ILMHistoryItem
Returns the running number of the partition.
getNumber() - Method in class com.uc4.api.systemoverview.ILMPartitionItem
Returns the running number of the partition.
getNumber() - Method in class com.uc4.api.TranslatedMessage
Returns the number of this message.
getNumber() - Method in class com.uc4.communication.AsyncMessage
Returns the number of this message.
getNumberFormat() - Method in class com.uc4.api.objects.VariableAttributes
Returns the number format for variable values with the type number.
getNumberOfActivities() - Method in class com.uc4.api.systemoverview.ClientListItem
Number of tasks currently being executed.
getNumberOfAgentDetails() - Method in class com.uc4.communication.requests.GetAgentProperties
Returns the number of detail entries.
getNumberOfClients() - Method in class com.uc4.api.systemoverview.AgentListItem
 
getNumberOfFalseTasks() - Method in class com.uc4.api.objects.WorkflowIF
Returns the number of tasks in the false branch.
getNumberOfObjects() - Method in class com.uc4.api.systemoverview.ClientListItem
Number of objects created in the client.
getNumberOfPages() - Method in class com.uc4.communication.requests.Report
Returns the number of pages for this report 0 if this request has not been sent.
getNumberOfSettings() - Method in class com.uc4.api.objects.Client
Returns the number of entries in the UC_CLIENT_SETTINGS variable.
getNumberOfTrueTasks() - Method in class com.uc4.api.objects.WorkflowIF
Returns the number of tasks in the true branch.
getNumberOfUsers() - Method in class com.uc4.api.systemoverview.ClientListItem
Number of users that are currently logged-on.
getNumberOfWPDetails() - Method in class com.uc4.communication.requests.GetWPProperties
Returns the number of detail entries.
getNWeek() - Method in class com.uc4.api.objects.WeeklyCalendarKeyword
Returns the interval in weeks.
getNYear() - Method in class com.uc4.api.objects.YearlyCalendarKeyword
Returns the interval in years.
getObjectAuthorizations() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the ObjectAuthorizations for the UC4 Object.
GetObjectDocu - Class in com.uc4.communication.requests
Provides read only access to the documentation of an UC4 object.
GetObjectDocu(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetObjectDocu
 
getObjectName() - Method in class com.uc4.api.TaskFilter
Returns the filter for the object name.
getObjectName() - Method in class com.uc4.communication.requests.GetChangeLog.Entry
Returns the name of the object.
GetObjectProperties - Class in com.uc4.communication.requests
Returns information about an UC4 object.
GetObjectProperties(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetObjectProperties
Creates a new Request to get information about an UC4 object.
GetObjectProperties(int) - Constructor for class com.uc4.communication.requests.GetObjectProperties
Creates a new Request to get information about an UC4 object.
getObjectSubType() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the SubType of the Object.
getObjectType() - Method in class com.uc4.api.AutoForecastItem
 
getObjectType() - Method in class com.uc4.api.FolderListItem
Returns the language independent type of the Object.
getObjectType() - Method in class com.uc4.api.ForecastItem
 
getObjectType() - Method in class com.uc4.api.ForecastTreeItem
 
getObjectType() - Method in interface com.uc4.api.ITransportable
 
getObjectType() - Method in class com.uc4.api.QuickSearchItem
Returns the language independent type of the object.
getObjectType() - Method in class com.uc4.api.SearchResultItem
 
getObjectType() - Method in class com.uc4.api.VersionControlListItem
 
getObjectType() - Method in class com.uc4.communication.requests.CheckAuthorizations.Candidate
Returns the object Type.
getObjectType() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the type of the UC4 Object or an empty String if the object does not exist.
getObjectType() - Method in class com.uc4.communication.requests.GroupMonitor.Task
Returns the type of the Object.
getObjectType() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the type of the Object.
getObjectType() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
Returns the type of the Object.
getOdbcConnectString() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getOdbcVersion() - Method in class com.uc4.communication.requests.GetDatabaseInfo
 
getOffset() - Method in class com.uc4.api.objects.RollCalendarCollision
Deprecated.
use getAdjustSign() and getAdjustSign() instead
getOffsetUTCHours() - Method in class com.uc4.api.objects.TimeZoneAttributes
Returns the difference to UTC in hours.
getOffsetUTCMinutes() - Method in class com.uc4.api.objects.TimeZoneAttributes
Returns the difference to UTC in minutes.
getOkState() - Method in class com.uc4.api.objects.TaskResult
Gets the task status which should be reached.
getOkStateExecute() - Method in class com.uc4.api.objects.JobPlanAttributes
Returns the object that is executed when a task does not have the expected end status.
getOkStateExecute() - Method in class com.uc4.api.objects.ScheduleAttributes
Returns the object that is executed when a task does not have the expected end status.
getOkStateForTasks() - Method in class com.uc4.api.objects.JobPlanAttributes
Returns the end status that is expected for the subordinated tasks of the JobPlan.
getOkStateForTasks() - Method in class com.uc4.api.objects.ScheduleAttributes
Returns the end status that is expected for the subordinated tasks of the Schedule.
getOnFulfillmentObject() - Method in class com.uc4.api.objects.SloFulfillment
Returns the name of the object which is executed on fulfillment.
getOnlinePartitions() - Method in class com.uc4.communication.requests.ILMList
 
getOnOperator() - Method in class com.uc4.api.objects.SyncAction
Returns the comparison operator.
getOnState() - Method in class com.uc4.api.objects.SyncAction
Returns the comparison state.
getOnValue() - Method in class com.uc4.api.objects.SyncAction
Returns the comparison value.
getOnViolationObject() - Method in class com.uc4.api.objects.SloFulfillment
Returns the name of the object which is executed on violation.
getOpcode() - Method in class com.uc4.communication.KickEvent
 
getOpen() - Method in class com.uc4.api.SearchResultItem
Returns the name of the user who has opened the object.
getOpenAutomatically() - Method in class com.uc4.communication.MessageSettings
Returns whether the Message Window should open automatically for incoming information or error messages.
getOpenByUser() - Method in class com.uc4.communication.requests.GetObjectProperties
If the object is currently edited by a user this method will return the name of the User.
getOpenedBy() - Method in class com.uc4.api.FolderListItem
Returns the name of the Automation Engine user who has opened the object.
getOpenSince() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns a DateTime instance that contains the time when the User started editing the object.
getOperation() - Method in class com.uc4.api.objects.CompositeVariable
Returns the enum for the operation.
getOperationWindowFrom() - Method in class com.uc4.api.objects.AttributesSLO
Returns "From" time of operation window.
getOperationWindowTo() - Method in class com.uc4.api.objects.AttributesSLO
Returns "To" time of operation window.
getOperator() - Method in class com.uc4.api.objects.CheckActivitiesCondition
 
getOperator() - Method in class com.uc4.api.objects.DatabaseEventSettings
Returns the operator character.
getOperator() - Method in class com.uc4.api.objects.FileSystem
Returns the operator.
getOperator() - Method in class com.uc4.api.objects.OutputFilter
Returns the operator which is used to combine the filter in this object.
getOperator() - Method in class com.uc4.api.objects.ReturnCodeCondition
Returns the operator.
getOperator() - Method in class com.uc4.api.objects.TimeSinceActivationCondition
 
getOperator() - Method in class com.uc4.api.objects.UserDefinedCondition
 
getOperatorID() - Method in class com.uc4.api.objects.PSRemoteTaskManagerFilter
Returns the PeopleSoft operator ID or null if not set.
getOperatorName() - Method in interface com.uc4.api.objects.ICallOperatorCondition
Returns the name or UserGroup of the Operator which should be notified.
getOptionsElement() - Method in class com.uc4.communication.requests.GetAgentProperties
Returns the option element
getOptionsElement() - Method in class com.uc4.communication.requests.GetCPProperties
Returns the option element
getOptionsElement() - Method in class com.uc4.communication.requests.GetWPProperties
Returns the option element
getOrderName() - Method in class com.uc4.api.objects.AttributesBS2000
Returns the order name (PNAME).
getOS() - Method in class com.uc4.api.objects.BackendCommand
Returns the operating system of the command.
getOsName() - Method in class com.uc4.api.objects.ConsoleOS390
 
getOther() - Method in class com.uc4.api.objects.AttributesMPE
Returns additional Job parameters.
getOtypes() - Method in class com.uc4.api.ObjectTypeFilter
Gets the object types, which will be returned by the filter.
GetOutputDirectory - Class in com.uc4.communication.requests
Returns a list of reports (external and in UC4 DB) of a Job.
GetOutputDirectory(int) - Constructor for class com.uc4.communication.requests.GetOutputDirectory
Creates a new GetOutputDirectory request.
GetOutputDirectory.OutputDirectoryItem - Class in com.uc4.communication.requests
This class represents a single row in the Output directory.
getOutputFormat() - Method in class com.uc4.api.prompt.DateElement
 
getOutputFormat() - Method in interface com.uc4.api.prompt.PromptInterfaces.OutputFormat
 
getOutputFormat() - Method in class com.uc4.api.prompt.TimeStampElement
 
getOutputMsg() - Method in class com.uc4.api.systemoverview.MQMemListItem
 
getParallelTasks() - Method in class com.uc4.api.objects.MaxParallel
Returns the maximum number of paralle tasks.
getParallelTasks() - Method in class com.uc4.api.systemoverview.AgentGroupListItem
Returns the number of parallel tasks or -1 if this proptery has not been set.
getParameter(String) - Method in class com.uc4.api.objects.ConditionOrAction
Internal use only: Returns the value or message number of the specified parameter.
getParameter() - Method in class com.uc4.api.objects.ConsoleSAP.EventHistoryFilter
 
getParameter() - Method in class com.uc4.api.objects.ConsoleSAP.JavaEventHistoryFilter
 
getParameter(String) - Method in class com.uc4.api.objects.DynamicExecVariable
Gets the parameter from given key.
getParameter() - Method in class com.uc4.api.objects.ExecuteObjectAction
Returns the parameter of this task.
getParameter() - Method in class com.uc4.api.systemoverview.ExitListItem
 
getParameterMessageID() - Method in class com.uc4.api.objects.AbortAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.BlockAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.CancelProcessFlowAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.ChangeQueueAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.CheckActivitiesCondition
 
getParameterMessageID() - Method in class com.uc4.api.objects.CheckConnectionCondition
 
getParameterMessageID() - Method in class com.uc4.api.objects.CheckFileCondition
 
getParameterMessageID() - Method in class com.uc4.api.objects.CheckHistoryCondition
 
getParameterMessageID() - Method in class com.uc4.api.objects.CheckProcessCondition
 
getParameterMessageID() - Method in class com.uc4.api.objects.ClearVariableAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.ConditionOrAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.CurrentQueueCondition
 
getParameterMessageID() - Method in class com.uc4.api.objects.CurrentTimeCondition
 
getParameterMessageID() - Method in class com.uc4.api.objects.ExecuteObjectAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.ModifyStateAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.PublishValueAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.ReEvaluateAtAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.ReEvaluateInAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.RestartTaskAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.ReturnCodeCondition
 
getParameterMessageID() - Method in class com.uc4.api.objects.RollbackAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.RunPathAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.RunTaskAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.SetValueAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.SetVariableAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.SkipTaskAction
 
getParameterMessageID() - Method in class com.uc4.api.objects.StatusCondition
 
getParameterMessageID() - Method in class com.uc4.api.objects.TimeSinceActivationCondition
 
getParameterMessageID() - Method in class com.uc4.api.objects.UserDefinedCondition
 
getParent() - Method in interface com.uc4.api.objects.IFolder
Returns the parent folder of this folder.
getParent() - Method in class com.uc4.api.systemoverview.ILMHistoryItem
Returns the schema name (MS SQL Server) or the corresponding main table of the database (Oracle).
getParent() - Method in class com.uc4.api.systemoverview.ILMPartitionItem
Returns the schema name (MS SQL Server) or the corresponding main table of the database (Oracle).
getParentAlias() - Method in class com.uc4.api.objects.JobPlanExternal
 
getParentErtUsage(String) - Method in class com.uc4.api.objects.TaskValues
Returns the ErtUsage value of the parent, for a given validity keyword The method returns ErtUsage.NONE if the validity keyword does not exist.
getParentIdnr() - Method in class com.uc4.api.objects.ResourceItem
Returns the ParentIdnr of the ResourceItem.
getParentRunID() - Method in class com.uc4.api.AbstractTask
Returns the RunID of the parent.
getParentRunID() - Method in class com.uc4.api.systemoverview.CheckILMPartitionItem
Returns the RunID of the parent.
getParentRunID() - Method in class com.uc4.api.TaskFilter
Returns the filter for a parent RunID.
getParentRunID() - Method in class com.uc4.communication.requests.NotificationMonitor
Returns the RunID of the parent or 0 if there is none.
getParentValue(String) - Method in class com.uc4.api.objects.TaskValues
Returns the parent value for a given validity keyword The method returns null if the validity keyword does not exist.
getParentVariable(String) - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the value of a given parent variable.
getPartner() - Method in class com.uc4.api.objects.ConsoleSAP.XIChannelFilter
 
getPassword() - Method in class com.uc4.communication.ConnectionAttributes
 
getPasswordType() - Method in class com.uc4.communication.ConnectionAttributes
Returns the type of the secret if the defined in the Connection.open() method.
getPath() - Method in class com.uc4.api.objects.FileSystem
 
getPath() - Method in class com.uc4.api.objects.RunPathAction
Returns the path as it was set by the setPath() method.
getPercentERT() - Method in class com.uc4.api.objects.MinimumRuntime
Returns the correction value in percent for ERT for the minimum runtime.
getPeriod() - Method in class com.uc4.api.objects.ScheduleAttributes
Returns the period in days of this Schedule.
getPeriodDescription() - Method in class com.uc4.api.AbstractTask
Returns the period description of the task.
getPeriodDescription() - Method in class com.uc4.api.objects.ExecuteRecurring
Description of the periodic cycle in which executions are triggered.
getPeriodDescription() - Method in class com.uc4.api.TaskFilter
Returns the filter for the period description.
getPeriodDescription() - Method in class com.uc4.communication.requests.GenericStatistics
Returns a filter for the period description.
getPhrase() - Method in class com.uc4.api.objects.ServerAttributes
Returns the Service Manager Phrase.
getPlatform() - Method in class com.uc4.api.AbstractTask
Returns the platform of the object or an empty String if a platform is not defined for the object.
getPlatform() - Method in class com.uc4.api.AutoForecastItem
 
getPlatform() - Method in class com.uc4.api.FolderListItem
Returns the platform of the object or an empty String if a platform is not defined for the object.
getPlatform() - Method in class com.uc4.api.ForecastItem
Returns the platform of the Automation Engine Object or an empty String if a platform is not defined.
getPlatform() - Method in class com.uc4.api.ForecastTreeItem
Returns the platform of a Job.
getPlatform() - Method in class com.uc4.api.objects.ResourceItem
Return the Platform (from PlatformSwHwType) of the resource.
getPlatform() - Method in enum com.uc4.api.PlatformSwHwType
Return the platform.
getPlatform() - Method in class com.uc4.api.systemoverview.LicenseListItem
Returns the license for the platform that is used.
getPlatform() - Method in class com.uc4.api.Template
Returns the platform of the template.
getPlatform() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the platform of the object.
getPlatform() - Method in class com.uc4.communication.requests.GroupMonitor.Task
Returns the platform of the object or an empty String if a platform is not defined for the object.
getPlatformFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the platform filter.
getPort() - Method in class com.uc4.api.objects.ServerAttributes
Returns the Service Manager port.
getPort() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the Agent's port number.
getPort() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the Server process port number.
getPostProcess() - Method in class com.uc4.api.objects.FileTransfer
Returns the content of the Post Process tab.
getPostProcess() - Method in class com.uc4.api.objects.Job
Returns the content of the Post Process tab.
getPostProcess() - Method in class com.uc4.api.objects.PSRemoteTaskManager
Returns the content of the Post Process tab.
getPostProcess() - Method in class com.uc4.api.objects.SAPQueueManager
Returns the content of the Post Process tab.
getPreCalculatedDates() - Method in class com.uc4.api.objects.CalendarKeyword
 
getPredecessorState(JobPlanMonitor.Task) - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the status of the predecessor.
getPreProcess() - Method in class com.uc4.api.objects.Job
Returns the content of the Pre Process tab.
getPriority() - Method in class com.uc4.api.objects.AttributesBS2000
Returns the jobs priority.
getPriority() - Method in class com.uc4.api.objects.AttributesNSK
Returns the Job's priority.
getPriority() - Method in class com.uc4.api.objects.AttributesOS390
Returns the Job's priority.
getPriority() - Method in class com.uc4.api.objects.AttributesOS400
Returns the priority with which the Job should be executed.
getPriority() - Method in class com.uc4.api.objects.AttributesVMS
Returns the priority for the Job.
getPriority() - Method in class com.uc4.api.objects.EventAttributes
Priority with which this Job should be executed in UC4.
getPriority() - Method in class com.uc4.api.objects.FileTransferAttributes
Priority with which this Job should be executed in the Automation Engine.
getPriority() - Method in class com.uc4.api.objects.JobAttributes
Priority with which this Job should be executed in UC4.
getPriority() - Method in class com.uc4.api.objects.JobPlanAttributes
Priority with which this Workflow should be executed in the Automation Engine.
getPriority() - Method in class com.uc4.api.objects.NotificationAttributes
Priority with which this Notification should be executed in the Automation Engine.
getPriority() - Method in class com.uc4.api.objects.QueueAttributes
Priority with which this Queue should be executed in UC4.
getPriority() - Method in class com.uc4.api.objects.QueueExceptionCondition
Priority with which this Queue should be executed in the Automation Engine.
getPriority() - Method in class com.uc4.api.objects.QueueManagerAttributes
Priority with which this Job should be executed in the Automation Engine.
getPriority() - Method in class com.uc4.api.objects.ScheduleAttributes
Priority with which this Job should be executed in the Automation Engine.
getPriority() - Method in class com.uc4.api.objects.ScriptAttributes
Priority with which this Script should be executed in the Automation Engine.
getPriority() - Method in class com.uc4.api.systemoverview.ClientListItem
Default value of the priority set for the client in the UC4 Variable UC_CLIENT_SETTINGS.
getPriority() - Method in class com.uc4.api.systemoverview.QueueListItem
 
getPriority() - Method in class com.uc4.api.Task
Returns the priority of the task.
getPriority() - Method in class com.uc4.communication.requests.ActiveNotifications.Entry
Returns the Priority of the Notification (high, normal, low).
getPriority() - Method in class com.uc4.communication.requests.GetModifyQueue
returns the priority value for queue
getPriority() - Method in class com.uc4.communication.requests.GroupMonitor.Task
Return the priority of the task.
getPriority() - Method in class com.uc4.communication.requests.NotificationMonitor
Returns the Priority of the Notification (high, normal, low).
getPrivilege() - Method in class com.uc4.communication.requests.CheckUserPrivileges.Candidate
Returns the privilege to check.
getProcess() - Method in class com.uc4.api.objects.Cockpit
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.ConsoleEvent
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.DatabaseEvent
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.FileEvent
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.FileTransfer
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.Group
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.Include
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.Job
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.JobPlan
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.Notification
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.PSRemoteTaskManager
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.SAPQueueManager
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.Schedule
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.Script
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.TimeEvent
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.WorkflowIF
Returns the content of the "Process" tab.
getProcess() - Method in class com.uc4.api.objects.WorkflowLoop
Returns the content of the "Process" tab.
getProcessChain() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
 
getProcessId() - Method in class com.uc4.api.StatisticSearchItem
 
getProcessID() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the process ID of this Agent.
getProcessId() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the process identification number of the server process.
getProcessId() - Method in class com.uc4.api.Task
Returns the process identification on OS level during execution.
getProcessInstanceFrom() - Method in class com.uc4.api.objects.PSRemoteTaskManagerFilter
Returns a filter for the process instance number or null if not set.
getProcessInstanceTo() - Method in class com.uc4.api.objects.PSRemoteTaskManagerFilter
Returns a filter for the process instance number or null if not set.
getProcessName() - Method in class com.uc4.api.objects.CheckProcessCondition
 
getProcessName() - Method in class com.uc4.api.objects.PSRemoteTaskManagerFilter
Returns the process name or null if not set.
getProcessorRunID() - Method in class com.uc4.api.Task
Returns the processor RunID.
getProcessors() - Method in class com.uc4.api.systemoverview.LicenseListItem
Returns the number of allowed processors or users (depending on platform).
getProcessType() - Method in class com.uc4.api.objects.PSRemoteTaskManagerFilter
Returns the process type or null if not set.
getProductVersion() - Method in class com.uc4.api.objects.HostGroupItem
 
getProgramId() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the program id
getProgramName() - Method in class com.uc4.api.objects.AttributesOS390
Returns the program name.
getPromptName() - Method in class com.uc4.api.objects.ConditionOrAction
 
getPromptSet() - Method in class com.uc4.communication.requests.AddPromptSet
Returns the Prompt Set definition.
getPromptSetID() - Method in class com.uc4.communication.requests.TaskPromptSetContent
 
getPromptSetName() - Method in class com.uc4.communication.requests.TaskPromptSetContent
Returns the name of the PromptSet.
getPromptSets() - Method in class com.uc4.communication.requests.TaskPromptSetNames
Deprecated.
getProperties() - Method in class com.uc4.api.DetailGroup
Returns the properties of this group.
getProperty(String) - Method in class com.uc4.api.objects.PromptElement
Returns the value of a property by its name.
getPublishedVariable() - Method in class com.uc4.api.objects.LoopDataSource
Returns the name of the Script variable which is used for published items.
getPublishName() - Method in class com.uc4.api.objects.PublishValueAction
Returns the name.
getPurgeJobLog() - Method in class com.uc4.api.objects.AttributesOS390
Returned values: 2 - Whether or not the job log is deleted depends on the configuration of the Agent's INI file (Parameter jobPurge).
getQuery() - Method in class com.uc4.api.objects.SloSelection
Returns the query definition as XML.
getQueue() - Method in class com.uc4.api.AbstractTask
Returns the name of the Queue or an empty String.
getQueue() - Method in class com.uc4.api.objects.AttributesMPE
Returns the Queue in which this Job should run.
getQueue() - Method in class com.uc4.api.objects.ChangeQueueAction
 
getQueue() - Method in class com.uc4.api.objects.EventAttributes
Returns the Queue Object.
getQueue() - Method in class com.uc4.api.objects.ExecuteRecurring
Returns the Queue Object.
getQueue() - Method in class com.uc4.api.objects.FileTransferAttributes
Returns the name of the Queue Object.
getQueue() - Method in class com.uc4.api.objects.Group
Deprecated.
use attributes.getQueue of this group instead
getQueue() - Method in class com.uc4.api.objects.GroupAttributes
Returns the Queue Object.
getQueue() - Method in class com.uc4.api.objects.JobAttributes
Returns the Queue Object.
getQueue() - Method in class com.uc4.api.objects.JobPlanAttributes
Returns the Queue Object.
getQueue() - Method in class com.uc4.api.objects.NotificationAttributes
Returns the Queue Object.
getQueue() - Method in class com.uc4.api.objects.QueueManagerAttributes
Returns the Queue Object.
getQueue() - Method in class com.uc4.api.objects.ScheduleAttributes
Returns the Queue Object.
getQueue() - Method in class com.uc4.api.objects.ScriptAttributes
Returns the Queue Object.
getQueue() - Method in class com.uc4.communication.requests.GetExecuteOnce
Returns the name of the queue object where the task runs.
getQueue() - Method in class com.uc4.communication.requests.GetRestartInformation
Returns Queue Name.
getQueueClient(int) - Method in class com.uc4.api.TaskFilter
If in client zero, its possible to set a filter for a Queue in a certain client.
getQueueClient() - Method in class com.uc4.api.TaskFilter
If in client zero, its possible to set a filter for a Queue in a certain client.
getQueueClientList() - Method in class com.uc4.api.TaskFilter
 
getQueueList() - Method in class com.uc4.api.TaskFilter
 
getQueueName() - Method in class com.uc4.api.objects.AttributesVMS
Returns the name of the queue in which the Job should be activated.
getQueueName() - Method in class com.uc4.api.objects.CurrentQueueCondition
 
getQueueObject(int) - Method in class com.uc4.api.TaskFilter
 
getQueueObject() - Method in class com.uc4.api.TaskFilter
 
getQueueObjectCount() - Method in class com.uc4.api.TaskFilter
 
getQuoteCharacter() - Method in class com.uc4.api.prompt.CheckGroupElement
Returns the character for a quote.
getQuoteCharacter() - Method in class com.uc4.api.prompt.ComboElement
Returns the character for a quote.
getQuoteCharacter() - Method in class com.uc4.api.prompt.NumberElement
Returns the character for a quote.
getQuoteCharacter() - Method in interface com.uc4.api.prompt.PromptInterfaces.QuoteCharacter
Returns the character for a quote.
getQuoteCharacter() - Method in class com.uc4.api.prompt.RadioGroupElement
Returns the character for a quote.
getQuoteCharacter() - Method in class com.uc4.api.prompt.TextElement
Returns the character for a quote.
getRaAgentName() - Method in class com.uc4.communication.requests.TaskPromptSetContent
Returns the name of the Agent if this is an RA panel.
GetRAAgentNames - Class in com.uc4.communication.requests
Returns a list of RA Agent names.
GetRAAgentNames(String, String) - Constructor for class com.uc4.communication.requests.GetRAAgentNames
 
getRaCaption() - Method in class com.uc4.communication.requests.TaskPromptSetContent
Returns the caption of the tab if this is an RA prompt.
GetRAConnectionNames - Class in com.uc4.communication.requests
Used to return the names of connection objects.
GetRAConnectionNames(String, String, String) - Constructor for class com.uc4.communication.requests.GetRAConnectionNames
Creates a new GetRAConnectionNames request.
GetRAConnectionValues - Class in com.uc4.communication.requests
Returns the content of an CONN object.
GetRAConnectionValues(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetRAConnectionValues
Creates a new GetRAConnectionValues request.
GetRAJobNames - Class in com.uc4.communication.requests
Returns names of RA Jobs.
GetRAJobNames(String, String, String) - Constructor for class com.uc4.communication.requests.GetRAJobNames
Creates a query of RA Job names.
getRAJobType() - Method in class com.uc4.api.objects.Job
Returns the Rapid Automation Job type or null if this is not an RA Job.
getRaJobtype() - Method in class com.uc4.communication.requests.TaskPromptSetContent
Returns the job type if this is an RA panel.
getRange() - Method in class com.uc4.api.objects.StepListItem
 
getRangeEndDate() - Method in class com.uc4.api.objects.ExecuteRecurring
Returns the end date of the date range which has been set using the method setDateRange.
getRangeEndDate() - Method in class com.uc4.api.objects.Period
Deprecated.
getRangeStartDate() - Method in class com.uc4.api.objects.ExecuteRecurring
Returns the start date of of the date range which has been set using the method setDateRange.
getRangeStartDate() - Method in class com.uc4.api.objects.Period
Deprecated.
getRASubJobType() - Method in class com.uc4.api.objects.Job
Returns the Rapid Automation Sub Job type or null if this is not an RA Job.
getRASubJobType() - Method in class com.uc4.api.objects.JobPlanTask
Gets the object Subtype of this RA task.
getRaSubtype() - Method in class com.uc4.communication.requests.TaskPromptSetContent
Returns the sub type of the Job if this is an RA panel.
getRealRuntime(int) - Method in class com.uc4.communication.requests.GetLastRuntimes
This method returns one of 25 real runtimes measured in seconds.
getReason() - Method in class com.uc4.api.systemoverview.QuarantineListItem
 
getRecentObjects() - Method in class com.uc4.communication.requests.FolderTree
Returns an IFolder object which represents the "Recent Objects" folder.
getRecipient() - Method in class com.uc4.communication.requests.NotificationMonitor.CallStatus
Returns the name of the receiver of this notification.
getRecurringDefinition() - Method in class com.uc4.communication.requests.ExecuteObject
Returns the settings of the periodic task.
getRecycleBin() - Method in class com.uc4.communication.requests.FolderTree
Returns an IFolder object which represents the "Recycle Bin" folder.
getReferenceRunID() - Method in class com.uc4.communication.requests.GetRestartInformation
Returns the original RunID of the task.
getReferenceRunID() - Method in class com.uc4.communication.requests.RestartTask
Gets the reference RunID.
getRefreshDurationMultiplier() - Method in class com.uc4.communication.ActivitySettings
Specify the number of seconds that the system must be idle in order to allow refreshing.
getRefreshInterval() - Method in class com.uc4.communication.ActivitySettings
Returns the refresh interval in case the refresh is set to automatic.
getRegExp() - Method in class com.uc4.api.prompt.TextElement
Returns the Regular expression or an empty String if not set.
getReleasedBlockings() - Method in class com.uc4.communication.requests.UnblockWorkflow
Returns the number of released blockings.
getRelMsgClass() - Method in class com.uc4.api.objects.AttributesOS390
Returned values: 0 ...
getRemoteHost() - Method in class com.uc4.communication.ConnectionAttributes
Returns the host name of the API user.
getRemoteID() - Method in class com.uc4.api.systemoverview.UserListItem
 
getRemoteID() - Method in class com.uc4.communication.ConnectionAttributes
Returns the remote ID.
getRemoteStatus() - Method in class com.uc4.api.AbstractTask
Returns the remote status of this task.
getRepeatCount() - Method in class com.uc4.api.objects.TaskResult
Returns the number of repetitions.
getRepeatWaitMinutes() - Method in class com.uc4.api.objects.TaskResult
Returns the waiting time in minutes before the Job is repeated.
GetReplaceList - Class in com.uc4.communication.requests
Returns list of UC4 Objects in which the specified UC4 Object is used.
GetReplaceList(RenameObject) - Constructor for class com.uc4.communication.requests.GetReplaceList
Creates a new GetReplaceList request using the specified RenameObject instance.
GetReplaceList(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetReplaceList
Creates a new GetReplaceList request to replace the specified object.
getReplays() - Method in class com.uc4.api.systemoverview.QuarantineListItem
 
getReport() - Method in class com.uc4.communication.requests.Report
Returns the content of this page or null if the request has not been sent.
getReportID() - Method in class com.uc4.communication.requests.GetOutputDirectory.OutputDirectoryItem
Returns the ID of this report.
getReportType() - Method in class com.uc4.communication.requests.Report
Returns the report type.
getRequestID(String) - Method in class com.uc4.communication.requests.XMLRequest
Sub classes may override to send a UUID instead.
getResourceList() - Method in class com.uc4.communication.requests.ExportObject
Returns an Iterator with items of DownloadBinary objects after invoking the ExportObject instance.
getResourceList() - Method in class com.uc4.communication.requests.ExportWithReferences
Returns an Iterator with items of DownloadBinary objects after invoking the ExportObject instance.
getResourceList() - Method in class com.uc4.communication.requests.ImportObject
Returns an Iterator with items of UploadBinary objects after invoking the ImportObject instance.
getResourceName() - Method in class com.uc4.communication.requests.DownloadBinary
Returns the resource name which was set, or null if it was not set.
getResourceType() - Method in class com.uc4.api.StorageItem
Returns the type of this resource.
getResponseLastMinute() - Method in class com.uc4.communication.requests.GetDatabaseInfo.MQEntry
 
getResponseTime10Minutes() - Method in class com.uc4.communication.requests.GetDatabaseInfo.MQEntry
 
getResponseTime60Minutes() - Method in class com.uc4.communication.requests.GetDatabaseInfo.MQEntry
 
getResponsible() - Method in class com.uc4.api.objects.LocaAttributes
Returns the responsible value of this Loca - Object.
getRestartedRunID() - Method in class com.uc4.communication.requests.RestartTask
Returns the runID of the restarted task.
GetRestartInformation - Class in com.uc4.communication.requests
Returns restart information of the specified task.
GetRestartInformation(int) - Constructor for class com.uc4.communication.requests.GetRestartInformation
Creates a new GetRestartInformation request.
GetRestartInformation(UC4Object) - Constructor for class com.uc4.communication.requests.GetRestartInformation
Creates a new GetRestartInformation request.
GetRestartInformation(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetRestartInformation
Creates a new GetRestartInformation request.
getRestartPoint() - Method in class com.uc4.communication.requests.RestartTask
Returns the value of the Restart Point field.
getRestriction() - Method in class com.uc4.api.systemoverview.LicenseListItem
Returns the comment field for restrictions.
getResult() - Method in class com.uc4.communication.requests.ActivatorStatistics
 
getResult() - Method in class com.uc4.communication.requests.CheckAuthorizations.Candidate
Returns the result of this check.
getResult() - Method in class com.uc4.communication.requests.CheckUserPrivileges.Candidate
Returns the result of the check.
getResult() - Method in class com.uc4.communication.requests.ParentStatistics
 
getResultFormat() - Method in class com.uc4.api.objects.BackendVariable
Returns the result format.
getResultFormat() - Method in class com.uc4.api.objects.CompositeVariable
Returns the result format.
getResultFormat() - Method in class com.uc4.api.objects.DynamicSQLVariable
Returns the result format.
getResultFormat() - Method in class com.uc4.api.objects.DynamicSQLVariableIntern
Returns the result format.
getResultFormat() - Method in class com.uc4.api.objects.SecureSQLVariable
Returns the result format.
getResultFormat() - Method in class com.uc4.api.objects.SecureSQLVariableIntern
Returns the result format.
getResultVariableName() - Method in class com.uc4.api.objects.DynamicExecVariable
Gets the Variable result name.
getRetCode() - Method in class com.uc4.api.objects.ModifyStateAction
 
getRetCodeExecuteObject() - Method in class com.uc4.api.objects.Runtime
Returns the name of the Automation Engine Object which should be executed when the actual return code is higher than the maximum allowed return code.
getReturnCode() - Method in class com.uc4.api.AbstractTask
Returns the return code which has ended the object.
getReturnCode() - Method in class com.uc4.api.objects.OutputScanFilter
Returns the return code of the Object in case the filter matches.
getReturnCode() - Method in class com.uc4.api.objects.QueueManagerAttributes
Returns the Max Expected Return Code.
getReturnCode() - Method in class com.uc4.api.objects.ReturnCodeCondition
 
getReturnCode() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
Method to fetch SAP return code.
getRole() - Method in class com.uc4.api.objects.AgentAssignmentFilter.Item
 
getRole() - Method in class com.uc4.api.objects.HostGroupItem
 
getRole() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the role of the work process.
getRoles() - Method in class com.uc4.api.systemoverview.AgentListItem
 
getRolesFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the roles filter.
getRollbackObject() - Method in class com.uc4.api.objects.Rollback
Returns the UC4 Object for rollback.
getRouteMessageClass() - Method in class com.uc4.api.objects.AttributesOS390
 
getRoutine() - Method in class com.uc4.api.systemoverview.MQMemListItem
 
getRoutingData() - Method in class com.uc4.api.objects.AttributesOS400
Returns the rooting data with which the Job's first rooting step is initiated.
getRow(String) - Method in class com.uc4.api.objects.Variable
Returns all values of the row with the specified key as String array.
getRow(String) - Method in class com.uc4.api.objects.VariableValues
Returns the values of a row with the specified key.
getRow(String) - Method in class com.uc4.communication.requests.GetStaticVaraRows
Returns all values of the row with the specified key as String array.
getRow(int) - Method in class com.uc4.communication.requests.PreviewAssignment
Returns the data of the specified row.
getRow(int) - Method in class com.uc4.communication.requests.PreviewVariable
Returns the data of the specified row.
getRow(int) - Method in class com.uc4.communication.requests.PromptInputHelp
Returns the data of the specified row.
getRowCount() - Method in class com.uc4.api.systemoverview.ILMPartitionItem
Returns the number of staging-table data records (MS SQL Server).
getRunID() - Method in class com.uc4.api.AbstractTask
Running number of the execution.
getRunID() - Method in class com.uc4.api.systemoverview.CheckILMPartitionItem
Running number of the execution.
getRunID() - Method in class com.uc4.communication.ActivationProtocol
 
getRunID() - Method in class com.uc4.communication.KickEvent
 
getRunID() - Method in class com.uc4.communication.requests.ActiveNotifications.Entry
Returns the RunID of this notification.
getRunID() - Method in class com.uc4.communication.requests.CauDeploy
Returns the RunID of the CAU statistics record.
getRunID() - Method in class com.uc4.communication.requests.ExecuteObject
Returns the RunID of this request.
getRunID() - Method in class com.uc4.communication.requests.ExecuteObjects.ExecuteObjectsResponse
Returns the RunID of this request.
getRunID() - Method in class com.uc4.communication.requests.GenericStatistics
Returns the selected RunID.
getRunId() - Method in class com.uc4.communication.requests.GetAgentGroupMonitorProperties
Returns the same value that has been set in the constructor.
getRunId() - Method in class com.uc4.communication.requests.GetGroupMonitorProperties
Returns the same value that has been set in the constructor.
getRunID() - Method in class com.uc4.communication.requests.GroupMonitor
Returns the run id of this Group.
getRunID() - Method in class com.uc4.communication.requests.GroupMonitor.Task
Returns the RunID of the task in the monitor or 0 if the task has not been executed.
getRunID() - Method in class com.uc4.communication.requests.JobPlanMonitor
returns the RunID of the ProcessFlow.
getRunID() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
 
getRunID() - Method in class com.uc4.communication.requests.NotificationMonitor
Returns the RunID of this notification.
getRunID() - Method in class com.uc4.communication.requests.ScheduleMonitor
Returns the run id of this schedule.
getRunID() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
Returns the RunID of the task in the monitor or 0 if the task has not been executed.
getRunID() - Method in class com.uc4.communication.requests.TaskList
Returns runID.
getRunID() - Method in class com.uc4.communication.requests.TaskPromptSetNames
Get RunID.
getRunningCount() - Method in class com.uc4.api.TrafficLight
Return the number of running tasks.
getRuntime() - Method in class com.uc4.api.AbstractTask
Returns the time used for the execution of the task.
getRuntime() - Method in class com.uc4.api.AutoForecastItem
 
getRuntime() - Method in class com.uc4.api.ForecastItem
 
getRuntime() - Method in class com.uc4.api.ForecastTreeItem
 
getSapAddressType() - Method in class com.uc4.api.objects.AttributesSAP
Returns the type of address.
getSapRecipent() - Method in class com.uc4.api.objects.AttributesSAP
Returns the receiver of a spool list.
getSAPRouter() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the SAP router string.
getSavedName() - Method in class com.uc4.api.VersionControlListItem
Returns the generated name of the revision.
getScheduledStartGreater() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
 
getScheduledStartLower() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
 
getScheduleRunID() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
Returns the RunID of the Schedule.
getScheduleTask() - Method in class com.uc4.communication.requests.AddScheduleTask
Returns a ScheduleTask which can be added to an UC4 Schedule.
getSchenv() - Method in class com.uc4.api.objects.AttributesOS390
Returns a scheduling environment on OS/390.
getScope() - Method in class com.uc4.api.objects.CancelProcessFlowAction
 
getScope() - Method in class com.uc4.api.objects.SetValueAction
 
getScriptFontSize() - Method in class com.uc4.communication.FontSettings
Returns the font size used in scripts, reports and activation logs.
getScriptFontStyle() - Method in class com.uc4.communication.FontSettings
Returns the font style used in scripts, reports and activation logs.
getScriptFontType() - Method in class com.uc4.communication.FontSettings
Returns the font type used in scripts, reports and activation logs.
getScriptName() - Method in class com.uc4.api.objects.ConditionOrAction
 
getSdlConnection() - Method in class com.uc4.api.objects.SAPAgentPanel
 
getSearchLocation() - Method in class com.uc4.communication.requests.SearchObject
Returns the folder path which used in the search.
getSecond() - Method in class com.uc4.api.DateTime
Returns the second.
getSeparatorSubstitute() - Method in class com.uc4.api.objects.AttributesSQL
Returns the substitute character that will be used to replace characters in the field value which are the same as the separator character.
getServer() - Method in class com.uc4.api.objects.ConsoleSAP.EventHistoryFilter
 
getServer() - Method in class com.uc4.api.objects.DatabaseEventValue
 
getServerName() - Method in class com.uc4.api.objects.PSRemoteTaskManagerFilter
Returns the process name of the process scheduler server or null if not set.
getServerTime() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the Date and time of the computer on which the server process is running or null if the server process is not active.
getServerURL() - Method in class com.uc4.api.objects.AttributesJMX
Returns the JMX URL of the remote MBean Server.
getServerVersion() - Method in class com.uc4.communication.ConnectionAttributes
Returns the version of the the Automation Engine.
getService() - Method in class com.uc4.api.objects.ConsoleSAP.XIChannelFilter
 
getService() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the services of the Agent (Mail or Database).
getSessionId() - Method in class com.uc4.api.systemoverview.UserListItem
Returns the number of the user session.
getSessionId() - Method in class com.uc4.communication.ConnectionAttributes
 
getSessionID() - Method in class com.uc4.communication.requests.CreateSession
Returns the ID this session.
getSessionInfo() - Method in interface com.uc4.communication.AEConnection
Returns information about the current UC4 Session.
getSessionInfo() - Method in class com.uc4.communication.Connection
Returns information about the current UC4 Session.
getSessionTimeZone() - Method in class com.uc4.api.systemoverview.UserListItem
Returns the timeZone of the session.
getSessionTimeZone() - Method in class com.uc4.communication.ConnectionAttributes
Gets the session time zone.
GetSessionTZ - Class in com.uc4.communication.requests
Request that gets the used TimeZone of the Session.
GetSessionTZ() - Constructor for class com.uc4.communication.requests.GetSessionTZ
 
getSetting(String) - Method in class com.uc4.api.objects.Client
Returns the value of a setting or null if not found.
getSeverity() - Method in class com.uc4.api.objects.ConsoleOS400
 
getShell() - Method in class com.uc4.api.objects.AttributesUnix
Returns the Unix Shell, under which the Job should run.
getShellOptions() - Method in class com.uc4.api.objects.AttributesUnix
Returns shell options.
getShortName() - Method in class com.uc4.api.objects.AttributesOA
Returns the short name of the application.
getSID() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the system id of the SAP System.
getSiebelServer() - Method in class com.uc4.api.objects.AttributesSiebel
Returns the name of the Siebel Server.
getSize() - Method in class com.uc4.api.objects.ResourceItem
Return the size of the resource.
getSize() - Method in class com.uc4.api.StorageItem
Returns the size of resource content.
getSkeletonMessageID() - Method in class com.uc4.api.objects.AbortAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.BlockAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.CancelProcessFlowAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.ChangeQueueAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.CheckActivitiesCondition
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.CheckConnectionCondition
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.CheckFileCondition
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.CheckHistoryCondition
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.CheckProcessCondition
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.ClearVariableAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.ConditionOrAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.CurrentQueueCondition
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.CurrentTimeCondition
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.ExecuteObjectAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.ModifyStateAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.PublishValueAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.ReEvaluateAtAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.ReEvaluateInAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.RestartTaskAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.ReturnCodeCondition
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.RollbackAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.RunPathAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.RunTaskAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.SetValueAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.SetVariableAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.SkipTaskAction
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.StatusCondition
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.TimeSinceActivationCondition
 
getSkeletonMessageID() - Method in class com.uc4.api.objects.UserDefinedCondition
 
getSltWithinSeconds() - Method in class com.uc4.api.objects.JobPlanExternal
Returns the number of seconds which are set as time limit.
getSmgrName() - Method in class com.uc4.api.objects.HostAttributes
 
getSmgrPhrase() - Method in class com.uc4.api.objects.HostAttributes
Returns the Service Manager Phrase.
getSmgrPort() - Method in class com.uc4.api.objects.HostAttributes
Returns the port of the Service Manager.
getSNCLib() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the SNC library.
getSNCMyName() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the SNC "MyName" value.
getSNCPartnerName() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the SNC Partner name.
getSNCQOP() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the QOP value for the SNC encryption.
getSnumb() - Method in class com.uc4.api.objects.AttributesGCOS8
Returns the sequence number of the Job.
getSoftware() - Method in class com.uc4.api.objects.AgentAssignmentFilter.Item
 
getSoftware() - Method in class com.uc4.api.objects.HostGroupItem
 
getSoftware() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns Computer's operating system.
getSoftwareFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the Software filter.
getSoftwareType() - Method in class com.uc4.api.StorageItem
Returns the software type attribute.
getSoftwareVersion() - Method in class com.uc4.api.objects.AgentAssignmentFilter.Item
 
getSoftwareVersion() - Method in class com.uc4.api.objects.HostGroupItem
 
getSoftwareVersion() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the version of the operating system.
getSoftwareVersionFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the Software version filter.
getSolutionDisplayText() - Method in class com.uc4.api.objects.Host
Returns the display name of the RA Agent.
getSolutionName() - Method in class com.uc4.api.objects.Host
Returns the technical name of the RA solution.
getSolutionName() - Method in class com.uc4.api.objects.RAConnection
Returns the technical name of the RA solution which belongs to this connection.
getSortColumn() - Method in class com.uc4.api.objects.VariableAttributes
Returns the column for sorting.
getSource() - Method in class com.uc4.api.objects.ConsoleWindows
 
getSource() - Method in class com.uc4.api.objects.NotificationSettings
 
getSource() - Method in class com.uc4.api.objects.OutputFilter.Entry
Returns the source of this filter.
getSource() - Method in class com.uc4.api.objects.VariableAttributes
Returns the source of this variable.
getSource() - Method in class com.uc4.api.systemoverview.MessageListItem
 
getSourceCalendar() - Method in class com.uc4.api.objects.RollCalendarKeyword
Returns the source calendar condition.
getSourceCodeTable() - Method in class com.uc4.api.objects.FileTransferSettings
 
getSourceDestHost() - Method in class com.uc4.communication.requests.TaskList
Returns the source host.
getSourceFile() - Method in class com.uc4.api.objects.FileTransferSettings
 
getSourceFileAttributes() - Method in class com.uc4.api.objects.FileTransferSettings
 
getSourceHost() - Method in class com.uc4.api.AutoForecastItem
 
getSourceHost() - Method in class com.uc4.api.objects.FileTransferSettings
 
getSourceHost() - Method in class com.uc4.communication.requests.GenericStatistics
Returns the selected source host of a FileTransfer.
getSourceHost() - Method in class com.uc4.communication.requests.QueryAutoforecast
 
getSourceLabel() - Method in class com.uc4.api.objects.VariableAttributes
Returns the label source of this variable.
getSourceLogin() - Method in class com.uc4.api.AutoForecastItem
 
getSourceLogin() - Method in class com.uc4.api.objects.FileTransferSettings
 
getSourceLogin() - Method in class com.uc4.communication.requests.QueryAutoforecast
 
getSpnegoToken() - Method in class com.uc4.communication.ConnectionAttributes
Returns the browser token.
getSpoolBlocksize() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the blocksize for the transfer of spool lists.
getSqlStatement() - Method in class com.uc4.api.objects.DatabaseEventValue
 
getSqlStatement() - Method in class com.uc4.api.objects.DynamicSQLVariable
Returns the SQL statement .
getSqlStatement() - Method in class com.uc4.api.objects.SecureSQLVariable
Returns the SQL statement.
getStageId() - Method in class com.uc4.api.systemoverview.ILMPartitionItem
Returns the name of an individual staging table (MS SQL Server).
getStart() - Method in class com.uc4.api.AbstractTask
Deprecated.
use getStartTime() instead
getStart() - Method in class com.uc4.api.systemoverview.ILMHistoryItem
Returns the time as of when data records have been stored in the partition.
getStart() - Method in class com.uc4.api.systemoverview.ILMPartitionItem
Returns the time as of when data records have been stored in the partition.
getStartAction() - Method in class com.uc4.api.objects.SyncItem
Returns the action that should be carried out when the task starts.
getStartDST() - Method in class com.uc4.api.objects.TimeZoneAttributes
Returns the TimeChangeRule when the daylight saving time (DST) starts.
getStartMonth() - Method in class com.uc4.api.objects.MonthlyCalendarKeyword
Returns the number of the start month of the monthly interval.
getStartTask() - Method in class com.uc4.api.objects.JobPlan
Returns the START-task of this JobPlan.
getStartTask() - Method in class com.uc4.api.objects.WorkflowIF
Returns the Start Task of an IF.
getStartTask() - Method in class com.uc4.api.objects.WorkflowLoop
Returns the Start Task of this FOR EACH workflow.
getStartTask() - Method in class com.uc4.communication.requests.JobPlanMonitor
Returns the start task.
getStartTime() - Method in class com.uc4.api.AbstractTask
Returns the date and time of object start.
getStartTime() - Method in class com.uc4.api.objects.ScheduleTask
Returns the start time of this task.
getStartTime() - Method in class com.uc4.api.systemoverview.CheckILMPartitionItem
Returns the date and time of object start.
getStartTime() - Method in class com.uc4.communication.requests.ActiveNotifications.Entry
Returns the start time of this notification.
getStartTime() - Method in class com.uc4.communication.requests.GroupMonitor.Task
Return the start time of the task.
getStartTime() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
 
getStartTime() - Method in class com.uc4.communication.requests.NotificationMonitor
Returns the start time of this notification.
getStartTime() - Method in class com.uc4.communication.requests.ScheduleMonitor
 
getStartTime() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
Return the start time of the task.
getStartTimestamp() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
 
getStartType() - Method in class com.uc4.api.AbstractTask
Returns the method used for the start.
getStartType() - Method in class com.uc4.api.objects.EventAttributes
Returns the start type of this Job.
getStartType() - Method in class com.uc4.api.objects.FileTransferAttributes
Returns the start type of this Job.
getStartType() - Method in class com.uc4.api.objects.JobAttributes
Returns the start type of this Job.
getStartType() - Method in class com.uc4.api.objects.JobPlanAttributes
Returns the start type of this JobPlan.
getStartType() - Method in class com.uc4.api.objects.NotificationAttributes
Returns the start type of this Notification.
getStartType() - Method in class com.uc4.api.objects.ScheduleAttributes
Returns the start type of this job.
getStartType() - Method in class com.uc4.api.objects.ScriptAttributes
Returns the start type of this Script.
getStartWeek() - Method in class com.uc4.api.objects.WeeklyCalendarKeyword
Returns the start week for the interval.
getStartYear() - Method in class com.uc4.api.objects.YearlyCalendarKeyword
Returns the start year for the interval.
getState() - Method in class com.uc4.api.AutoForecastItem
 
getState() - Method in class com.uc4.api.ForecastItem
 
getState() - Method in class com.uc4.api.ForecastTreeItem
 
getState() - Method in class com.uc4.api.objects.ConsoleSAP.XIChannelFilter
 
getState() - Method in class com.uc4.api.objects.SyncState
Returns the name of the state.
getState() - Method in class com.uc4.api.StatisticSearchItem
Returns the task status which has ended the object in a language independent format.
getStateIcon() - Method in class com.uc4.api.AbstractTask
Returns a description of the status.
getStatementDB2() - Method in class com.uc4.api.objects.DynamicSQLVariableIntern
Returns the SQL statement for DB2.
getStatementDB2() - Method in class com.uc4.api.objects.SecureSQLVariableIntern
Returns the SQL statement for DB2.
getStatementMsSQL() - Method in class com.uc4.api.objects.DynamicSQLVariableIntern
Returns the SQL statement for MS SQL.
getStatementMsSQL() - Method in class com.uc4.api.objects.SecureSQLVariableIntern
Returns the SQL statement for MS SQL.
getStatementOracle() - Method in class com.uc4.api.objects.DynamicSQLVariableIntern
Returns the SQL statement for Oracle.
getStatementOracle() - Method in class com.uc4.api.objects.SecureSQLVariableIntern
Returns the SQL statement for Oracle.
getStaticValue() - Method in class com.uc4.api.objects.DatabaseEventValue
 
GetStaticVaraRows - Class in com.uc4.communication.requests
Returns a list of rows according to the specified key-filters supplied by the constructor.
GetStaticVaraRows(UC4ObjectName, String...) - Constructor for class com.uc4.communication.requests.GetStaticVaraRows
Creates a new instance of the GetStaticVaraRows request.
getStatus() - Method in class com.uc4.api.AbstractTask
Returns the status of this task as String which is independent on the logon language.
getStatus() - Method in class com.uc4.api.objects.CheckActivitiesCondition
 
getStatus() - Method in class com.uc4.api.objects.CheckHistoryCondition
 
getStatus() - Method in class com.uc4.api.objects.CheckProcessCondition
 
getStatus() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
Returns the Job status.
getStatus() - Method in class com.uc4.api.objects.StatusCondition
 
getStatus() - Method in class com.uc4.api.systemoverview.CheckILMPartitionItem
Returns the status of this task.
getStatus() - Method in class com.uc4.api.systemoverview.QuarantineListItem
 
getStatus() - Method in class com.uc4.api.systemoverview.QueueListItem
 
getStatus() - Method in class com.uc4.api.TaskFilter
Returns the selected status.
getStatus() - Method in class com.uc4.communication.requests.GenericStatistics
Returns the selected status for tasks.
getStatus() - Method in class com.uc4.communication.requests.GroupMonitor.Task
Returns the status of this task as String which is independent on the logon language.
getStatus() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the status of this task as String which is independent on the logon language.
getStatus() - Method in class com.uc4.communication.requests.NavigatorAgentTree.AgentLeaf
Returns the status of the Agent (Active or Inactive), or null if the ITreeItem represents a node.
getStatus() - Method in class com.uc4.communication.requests.NavigatorQueueTree.QueueLeaf
Returns the status of the Queue (Green, Yellow or Red).
getStatus() - Method in class com.uc4.communication.requests.NotificationMonitor.CallStatus
Returns the status of this task.
getStatus() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
Returns the status of this task as String which is independent on the logon language.
getStatusByMail() - Method in class com.uc4.api.objects.AttributesSAP
Returns the report status by mail:
getStatusCode() - Method in class com.uc4.api.AbstractTask
Returns the status of the task as integer.
getStatusCode() - Method in class com.uc4.api.systemoverview.CheckILMPartitionItem
Returns the status of the task as integer.
getStatusCode() - Method in class com.uc4.communication.requests.ActiveNotifications.Entry
Returns the status of the task as integer.
getStatusCode() - Method in class com.uc4.communication.requests.GroupMonitor
Returns the status of the task as integer.
getStatusCode() - Method in class com.uc4.communication.requests.GroupMonitor.Task
Returns the status of the task as integer.
getStatusCode() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the status of the task as integer.
getStatusCode() - Method in class com.uc4.communication.requests.NotificationMonitor.CallStatus
Returns the status of the task as integer.
getStatusCode() - Method in class com.uc4.communication.requests.NotificationMonitor
Returns the status of the notification.
getStatusCode() - Method in class com.uc4.communication.requests.ScheduleMonitor
Returns the status of the task as integer.
getStatusCode() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
Returns the status of the task as integer.
getStatusForExternalTasks() - Method in class com.uc4.communication.ProcessFlowSettings
Returns the default status for external tasks in a ProcessFlow.
getStatusForInternalTasks() - Method in class com.uc4.communication.ProcessFlowSettings
Returns the default status for tasks in a ProcessFlow.
getStatusText() - Method in class com.uc4.api.AbstractTask
Returns a description of the status.
getStatusText() - Method in class com.uc4.api.ForecastItem
Returns a description of the status.
getStatusText() - Method in class com.uc4.api.ForecastTreeItem
Returns a description of the status.
getStatusText() - Method in class com.uc4.api.objects.OutputScanFilter
Returns the status text that is used for the task's remote status when the filter definition applies.
getStatusText() - Method in class com.uc4.api.systemoverview.CheckILMPartitionItem
Returns a description of the status.
getStatusText() - Method in class com.uc4.communication.requests.ActiveNotifications.Entry
Returns a description of the status.
getStatusText() - Method in class com.uc4.communication.requests.GroupMonitor.Task
Returns a description of the status.
getStatusText() - Method in class com.uc4.communication.requests.ILMList
 
getStatusText() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns a description of the status.
getStatusText() - Method in class com.uc4.communication.requests.NotificationMonitor.CallStatus
Returns a description of the status.
getStatusText() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
Returns a description of the status.
getStatusWithinParentText() - Method in class com.uc4.api.Task
Returns the state of the task within his parent task which can be a Workflow of any type: Standard, IF or ForEach.
getStepList() - Method in class com.uc4.api.objects.Runtime
Returns teh OS 390 Step List.
getStepName() - Method in class com.uc4.api.objects.StepListItem
 
GetStorageItems - Class in com.uc4.communication.requests
Lists all resources from a storage object.
GetStorageItems(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetStorageItems
Construct this object and set requested storage name.
getString(String) - Method in class com.uc4.communication.requests.QueryData.Row
Returns the value of a column as String.
getStylesheet() - Method in class com.uc4.api.objects.Stylesheet
Returns the content of the "XSL" tab.
getSubFolder(String, boolean) - Method in interface com.uc4.api.objects.IFolder
Returns a subfolder with the specified name.
getSubject() - Method in class com.uc4.api.objects.NotificationSettings
 
getSubject() - Method in class com.uc4.communication.requests.NotificationMonitor
Returns the subject of the message text.
getSubType() - Method in class com.uc4.api.FolderListItem
Returns the subtype of the object if available.
getSubType() - Method in class com.uc4.api.objects.Header
Returns the subtype of the object as String.
getSubType() - Method in class com.uc4.api.objects.JobPlanTask
Gets the object Subtype of this task.
getSubType() - Method in class com.uc4.api.objects.XHeader
Returns the subtype of the object as String.
getSubType() - Method in class com.uc4.api.Template
Returns the sub-type of the template.
getSubType() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the sub-type of the object.
getSubType() - Method in class com.uc4.communication.requests.JobPlanMonitor
Returns the SubType of the Workflow.
getSubType() - Method in class com.uc4.communication.requests.PreviewVariable
Returns the type of the variable.
getSw() - Method in class com.uc4.api.objects.ResourceItem
Return the SW (from PlatformSwHwType) of the resource.
getSw() - Method in enum com.uc4.api.PlatformSwHwType
Return the SW.
GetSyncMonitor - Class in com.uc4.communication.requests
This request can be used to read the current state and value of a SYNC object.
GetSyncMonitor(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetSyncMonitor
Creates a new GetSyncMonitor.
getSyncObject() - Method in class com.uc4.api.objects.SyncItem
Returns the name of a Sync object with which the task should be synchronized.
GetSyncUsage - Class in com.uc4.communication.requests
Returns a list of SYNC Object names that are currently used.
GetSyncUsage() - Constructor for class com.uc4.communication.requests.GetSyncUsage
Creates a new GetSyncUsage request for all current used objects.
GetSyncUsage(int) - Constructor for class com.uc4.communication.requests.GetSyncUsage
Creates a new GetSyncUsage request that returns SYNC objects used by a specified RunID.
getSystemName() - Method in class com.uc4.api.objects.ConsoleOS390
 
getSystemName() - Method in class com.uc4.communication.ConnectionAttributes
 
getSystemName() - Method in class com.uc4.communication.requests.CreateSession
Returns the name of the UC4 system.
getSystemNumber() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the system number or -1 if not set.
getTargetSystem() - Method in class com.uc4.api.objects.AttributesSAP
Returns the target system in SAP.
getTask() - Method in class com.uc4.api.objects.JobPlanTaskDependency
Returns the predecessor task.
getTask() - Method in class com.uc4.api.objects.RollbackAction
Returns the task to rollback.
getTaskByLnr(String) - Method in class com.uc4.communication.requests.JobPlanMonitor
Returns the task with the specified activation number.
getTaskByRunID(int) - Method in class com.uc4.communication.requests.JobPlanMonitor
Returns the task with the specified runID.
getTaskByUserDefinedID(String) - Method in class com.uc4.api.objects.JobPlan
Returns a worfkflow task with the specified ID.
getTaskByUserDefinedID(String) - Method in class com.uc4.api.objects.WorkflowIF
Returns a worfkflow task with the specified ID.
getTaskByUserDefinedID(String) - Method in class com.uc4.api.objects.WorkflowLoop
Returns a worfkflow task with the specified ID.
getTaskClient() - Method in class com.uc4.api.AbstractTask
Returns the client of the task in the Automation Engine.
getTaskIcon() - Method in class com.uc4.api.objects.JobPlanTask
Return the Task Icon
getTaskID() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns a unique ID of a task.
getTaskMonitorType() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Method to fetch the task Monitor type.
getTaskName() - Method in interface com.uc4.api.objects.ITaskItem
Gets the name of this Schedule or Workflow task.
getTaskName() - Method in class com.uc4.api.objects.JobPlanTask
Gets the name of this JobPlan task.
getTaskName() - Method in class com.uc4.api.objects.ScheduleTask
 
getTaskPosition() - Method in class com.uc4.communication.requests.ScheduleMonitor.Task
Returns the position of the task in the Schedule
getTaskPriority() - Method in class com.uc4.api.systemoverview.ClientListItem
Default value of the priority set for the client in the UC4 Variable UC_CLIENT_SETTINGS.
getTaskStatus() - Method in class com.uc4.api.systemoverview.MQMemListItem
 
getTaskTitle() - Method in class com.uc4.api.objects.JobPlanTask
Return the Title of the Task
getTcpIPAddressFilter() - Method in class com.uc4.communication.requests.AgentList.Filter
Returns the TCP/IP address filter.
getTemplate() - Method in class com.uc4.communication.requests.CreateObject
Returns the template which is used to create the object in UC4.
getTemplate(String) - Method in class com.uc4.communication.requests.TemplateList
Returns a Template given template name or null if the template was not found.
getTemplateFor(String) - Static method in class com.uc4.api.Template
Returns the Template for a specified object type null if a matching Template could not be found.
getTemplateName() - Method in class com.uc4.api.Template
Returns the name of the template.
getTestAgentName() - Method in class com.uc4.api.objects.RAConnection
Returns the name of an RA Agent which is able to use this connection.
getTestOptions() - Method in class com.uc4.communication.requests.GetExecuteOnce
Returns the TestOptions which are used when restarting the task or null if the TestOptions are not set.
getTestOptions() - Method in class com.uc4.communication.requests.RestartTask
Returns the TestOptions which are used when restarting the task or null if the TestOptions are not set.
getText() - Method in class com.uc4.api.MessageBox
Returns the translated message text.
getText() - Method in class com.uc4.api.objects.AbortAction
 
getText() - Method in class com.uc4.api.objects.BlockAction
 
getText() - Method in class com.uc4.api.objects.ModifyStateAction
 
getText() - Method in class com.uc4.api.objects.SkipTaskAction
 
getText() - Method in class com.uc4.api.systemoverview.HostTraceOptions.HostTraceFlag
get the trace flag text information
getText() - Method in class com.uc4.api.TraceOptions.TraceFlag
get the trace flag text information
getText() - Method in class com.uc4.api.TranslatedMessage
Returns the translated message text.
getText() - Method in class com.uc4.communication.AsyncMessage
Returns the translatet text.
getText() - Method in class com.uc4.communication.requests.GetComments.Comment
Returns the comment text.
getText() - Method in class com.uc4.communication.requests.TaskPromptSetContent
Returns the caption of the prompt set.
getTextDocuNames() - Method in class com.uc4.api.objects.DocuContainer
 
getThreshold1() - Method in class com.uc4.api.objects.CockpitThresholds
Returns the maximal value for lowest indicator.
getThreshold2() - Method in class com.uc4.api.objects.CockpitThresholds
Returns the maximal value for middle indicator (yellow area).
getThresholdValue() - Method in class com.uc4.api.systemoverview.CacheListItem
Limit for the cache's memory release.
getTicktNr() - Method in class com.uc4.api.objects.LocaMessageItem
Returns the ticket number.
getTime() - Method in class com.uc4.api.DateTime
Returns the time in the format hh:mm as String.
getTime() - Method in class com.uc4.api.objects.CurrentTimeCondition
 
getTime() - Method in class com.uc4.api.objects.JobPlanCheckpoint
Deprecated.
Returns the checkpoint time.
getTime() - Method in class com.uc4.api.objects.JobPlanEarliest
Returns the earliest start time.
getTime() - Method in class com.uc4.api.objects.MaximumRuntime
Returns the time when the task must be finished.
getTime() - Method in class com.uc4.api.objects.ProcessFlowGeneral
Returns the checkpoint time.
getTime() - Method in class com.uc4.api.objects.ReEvaluateAtAction
 
getTime() - Method in class com.uc4.api.objects.TimeSinceActivationCondition
 
getTimeDifference() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the time difference between Agent and Automation Engine system.
getTimeDifference() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the time difference between the computer on which the server process is running and the Automation Engine.
getTimeFormat() - Method in class com.uc4.api.objects.VariableAttributes
Returns the output format of a time.
getTimeFrame() - Method in class com.uc4.api.TaskFilter
Returns the selected Time Frame.
getTimeframeEnd() - Method in class com.uc4.api.objects.ExecuteRecurring
Returns the end time which was set using the method setTimeframe.
getTimeframeEnd() - Method in class com.uc4.api.objects.Period
Deprecated.
getTimeframeStart() - Method in class com.uc4.api.objects.ExecuteRecurring
Returns the start time which was set using the method setTimeframe.
getTimeframeStart() - Method in class com.uc4.api.objects.Period
Deprecated.
getTimeInMillis() - Method in class com.uc4.api.DateTime
Gets this DateTime's value as long.
getTimeOffset() - Method in class com.uc4.api.objects.CheckHistoryCondition
 
getTimeOfSingleExecution() - Method in class com.uc4.api.objects.ExecuteRecurring
Returns the start time that has been set using the method setAtTime.
getTimeOfSingleExecution() - Method in class com.uc4.api.objects.Period
Deprecated.
getTimeout() - Method in class com.uc4.communication.Connection
Returns the timout for synchronous application.
getTimeoutSeconds() - Method in class com.uc4.api.objects.JobPlanExternal
Returns the time span that should be waited.
getTimerControlMinutes() - Method in class com.uc4.api.objects.EventSettings
Returns the interval in minutes.
getTimerControlMinutes() - Method in class com.uc4.api.objects.FileSystem
Returns the interval in minutes.
getTimerControlStartTime() - Method in class com.uc4.api.objects.EventSettings
Gets the start time of the event.
getTimerControlStartTime() - Method in class com.uc4.api.objects.FileSystem
Gets the start time of the event.
getTimestamp() - Method in class com.uc4.api.systemoverview.MessageListItem
 
getTimestamp() - Method in class com.uc4.api.systemoverview.QuarantineListItem
 
getTimestamp() - Method in class com.uc4.communication.requests.GetChangeLog.Entry
Returns the timestamp of this event.
getTimestamp() - Method in class com.uc4.communication.requests.GetComments.Comment
Returns the timestamp of the comment.
getTimestampFormat() - Method in class com.uc4.api.objects.VariableAttributes
Returns the output format of timestamps.
getTimestampFrom() - Method in class com.uc4.api.TaskFilter
Returns the From timestamp for the Activation.
getTimestampTo() - Method in class com.uc4.api.TaskFilter
Returns the To timestamp for the Activation.
getTimeUnit() - Method in class com.uc4.api.TaskFilter
Returns the TimeUnit for the last Activations.
getTimeUsed() - Method in class com.uc4.api.systemoverview.CacheListItem
Total time consumed by the work processes for calling the cache.
getTimeWithSeconds() - Method in class com.uc4.api.DateTime
Returns the time including seconds.
getTimezone() - Method in class com.uc4.api.objects.AttributesSLO
Returns the time zone of this SLO Object.
getTimezone() - Method in class com.uc4.api.objects.Client
Returns the time zone of this client.
getTimezone() - Method in class com.uc4.api.objects.EventAttributes
Returns the TimeZone that is to be used.
getTimeZone() - Method in class com.uc4.api.objects.ExecuteRecurring
 
getTimezone() - Method in class com.uc4.api.objects.FileTransferAttributes
Returns the TimeZone that is to be used.
getTimezone() - Method in class com.uc4.api.objects.Group
Deprecated.
use attributes.getTimezone of this group instead
getTimezone() - Method in class com.uc4.api.objects.GroupAttributes
Returns the TimeZone that is to be used.
getTimezone() - Method in class com.uc4.api.objects.JobAttributes
Returns the TimeZone that is to be used.
getTimezone() - Method in class com.uc4.api.objects.JobPlanAttributes
Returns the TimeZone that is to be used.
getTimezone() - Method in class com.uc4.api.objects.JobPlanCheckpoint
Deprecated.
Returns the TimeZone that is to be used.
getTimezone() - Method in class com.uc4.api.objects.JobPlanDependencies
Returns the TimeZone that is to be used.
getTimezone() - Method in class com.uc4.api.objects.JobPlanEarliest
Returns the TimeZone that is to be used.
getTimezone() - Method in class com.uc4.api.objects.MaximumRuntime
Returns the time zone which is used for the current date.
getTimezone() - Method in class com.uc4.api.objects.NotificationAttributes
Returns the TimeZone that is to be used.
getTimezone() - Method in class com.uc4.api.objects.ProcessFlowGeneral
Returns the TimeZone that is to be used.
getTimezone() - Method in class com.uc4.api.objects.QueueAttributes
 
getTimezone() - Method in class com.uc4.api.objects.QueueManagerAttributes
Returns the TimeZone that is to be used.
getTimezone() - Method in class com.uc4.api.objects.ScheduleAttributes
Returns the TimeZone that is to be used.
getTimezone() - Method in class com.uc4.api.objects.ScriptAttributes
Returns the TimeZone that is to be used.
getTimezone() - Method in class com.uc4.api.objects.UserAttributes
Returns the TimeZone to be used for this user following System logon.
getTimezone() - Method in class com.uc4.api.systemoverview.ClientListItem
Time zone valid in this client.
getTimezone() - Method in class com.uc4.communication.requests.GetExecuteOnce
 
getTimezone() - Method in class com.uc4.communication.requests.GetGroupMonitorProperties
returns Timezone for Group monitor
getTimeZone() - Method in class com.uc4.communication.requests.GetSessionTZ
Returns the timezone of the connected user.
getTimezone() - Method in class com.uc4.communication.TimeSettings
The TimeZone that is specified here only serves display reasons (for example, for the Message Wwindow).
getTimezoneText() - Method in class com.uc4.communication.requests.TaskPromptSetNames
Returns the timezone information.
getTitle() - Method in class com.uc4.api.ComponentWorkflowObjectName
Returns the title of the template.
getTitle() - Method in class com.uc4.api.FolderListItem
Returns the title of this Automation Engine Object.
getTitle() - Method in class com.uc4.api.objects.Header
Returns the title of the object.
getTitle() - Method in interface com.uc4.api.objects.IFolder
Returns the title of the folder.
getTitle() - Method in class com.uc4.api.objects.XHeader
Returns the title of the object.
getTitle() - Method in class com.uc4.api.QuickSearchItem
Returns the title of the object.
getTitle() - Method in class com.uc4.api.SearchResultItem
Returns the title of the object.
getTitle() - Method in class com.uc4.api.ServiceLevelObjectiveListItem
Returns the title of the object.
getTitle() - Method in class com.uc4.api.systemoverview.AgentAssignmentListItem
Returns the title on the header tab of the HSTA object.
getTitle() - Method in class com.uc4.api.systemoverview.ClientListItem
Title specified in the client object.
getTitle() - Method in class com.uc4.api.VersionControlListItem
 
getTitle() - Method in class com.uc4.communication.requests.CreateObject
Returns the title of the FOLD object, never null.
getTitle() - Method in class com.uc4.communication.requests.GetChangeLog.Entry
Returns the title of the object.
getTitle() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the title of the UC4 Object.
getTitle() - Method in class com.uc4.communication.requests.SearchIndex.Result
Gets the object title.
getTitleOrName() - Method in class com.uc4.api.objects.JobPlanTask
Return the Task Title if available else the name of the task object
getTo() - Method in class com.uc4.api.objects.EventCalendarItem
 
getTo() - Method in class com.uc4.api.objects.QueueExceptionCondition
Returns the end of the validity period.
getToDate() - Method in class com.uc4.communication.requests.GenericStatistics
Returns the until date for the selection.
getToDate() - Method in class com.uc4.communication.requests.SearchObject
Returns the end of the date range.
getToken() - Method in class com.uc4.communication.ConnectionAttributes
Returns a logon token which can be used instead of a password.
getToken() - Method in class com.uc4.communication.requests.CreateSession
Returns a token which can be used instead of a passwort for future logons with the same UC4 user.
getTokenAgent() - Method in class com.uc4.communication.ConnectionAttributes
Returns the Agent name if the API is used within an UC4 Agent.
getToolbarLabel() - Method in class com.uc4.communication.GeneralSettings
Returns the location of the toolbar label.
getTooltip() - Method in class com.uc4.api.objects.PromptElement
Returns the tooltip of this Prompt Element.
getTooltip() - Method in class com.uc4.api.prompt.NumberElement
Returns the tooltip of this Prompt Element.
getTop() - Method in class com.uc4.api.objects.CockpitControl
Returns the distance to the top.
getTopRunID() - Method in class com.uc4.api.TaskFilter
Returns the filter for a top RunID.
getTopRunID() - Method in class com.uc4.communication.requests.GenericStatistics
Returns the selected topRunID.
getTotalHits() - Method in class com.uc4.communication.requests.SearchIndex
Returns the total number of hits.
getTotalWorkload() - Method in class com.uc4.communication.requests.SystemWorkload
Returns a WorkloadItem which represents the total system workload.
getTraceFileTrigger() - Method in class com.uc4.api.systemoverview.HostTraceOptions
 
getTraceFlag(int) - Method in class com.uc4.communication.requests.GetAgentProperties
Returns the trace flag value.
getTraceFlag(int) - Method in class com.uc4.communication.requests.GetCPProperties
Returns the trace flag value.
getTraceFlag(int) - Method in class com.uc4.communication.requests.GetWPProperties
Returns the trace flag value.
getTraceFlagDescription(int) - Method in class com.uc4.communication.requests.GetAgentProperties
Returns a detailed description of a trace flag.
getTraceFlagDescription(int) - Method in class com.uc4.communication.requests.GetCPProperties
Returns a detailed description of a trace flag.
getTraceFlagDescription(int) - Method in class com.uc4.communication.requests.GetWPProperties
Returns a detailed description of a trace flag.
getTraceFlags() - Method in class com.uc4.api.TraceOptions
 
getTraceFlagsSize() - Method in class com.uc4.communication.requests.GetAgentProperties
returns the length of the trace flag array
getTraceFlagsSize() - Method in class com.uc4.communication.requests.GetCPProperties
returns the length of the trace flag array
getTraceFlagsSize() - Method in class com.uc4.communication.requests.GetWPProperties
returns the length of the trace flag array
getTraceFlagText(int) - Method in class com.uc4.communication.requests.GetAgentProperties
Returns the caption of a trace flag.
getTraceFlagText(int) - Method in class com.uc4.communication.requests.GetCPProperties
Returns the caption of a trace flag.
getTraceFlagText(int) - Method in class com.uc4.communication.requests.GetWPProperties
Returns the caption of a trace flag.
getTraceListener() - Method in class com.uc4.communication.Connection
Returns the listener of trace message or null if the trace is not enabled.
getTraceType() - Method in class com.uc4.api.systemoverview.HostTraceOptions
 
getTraceType() - Method in class com.uc4.api.TraceOptions
get the trace type (file or memory)
getTraceType() - Method in class com.uc4.communication.requests.GetAgentProperties
returns the trace type
getTraceType() - Method in class com.uc4.communication.requests.GetCPProperties
returns the trace type
getTraceType() - Method in class com.uc4.communication.requests.GetWPProperties
returns the trace type
getTrafficLight() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
 
getTranslator() - Method in class com.uc4.communication.ConnectionAttributes
Returns the message translator.
getTransportFolder() - Method in class com.uc4.communication.requests.FolderTree
Returns an IFolder object which represents the transport case folder.
getTreeItem() - Method in class com.uc4.communication.requests.ForecastTree
 
getTrigger() - Method in class com.uc4.communication.requests.GetAgentProperties
returns the trigger string
getTriggerText() - Method in class com.uc4.api.systemoverview.WPTraceOptions
get the trace trigger text
getTriggerText() - Method in class com.uc4.communication.requests.GetWPProperties
returns the trigger text
getTriggerType() - Method in class com.uc4.api.systemoverview.HostTraceOptions
 
getTriggerType() - Method in class com.uc4.communication.requests.GetAgentProperties
returns the trigger type
getTrustedIPs() - Method in class com.uc4.api.objects.HostAttributes
Returns a String containing all trusted IPs separated by semicolon.
getTurnaround() - Method in class com.uc4.api.objects.ScheduleAttributes
Returns the turn around time of the Schedule.
getTxtSpkID() - Method in class com.uc4.api.objects.LocaMessageItem
Returns the speaking ID of the message.
getTyp() - Method in class com.uc4.api.objects.LocaMessageItem
Returns the message type.
getType() - Method in class com.uc4.api.AbstractTask
Returns the type of the object.
getType() - Method in class com.uc4.api.FolderListItem
Returns the type of this Automation Engine Object.
getType() - Method in class com.uc4.api.MessageBox
Returns the type of the message.
getType() - Method in class com.uc4.api.objects.AbstractDocumentation
 
getType() - Method in class com.uc4.api.objects.ConsoleWindows.ConsoleWindowsFilter
 
getType() - Method in class com.uc4.api.objects.ConsoleWindows
 
getType() - Method in class com.uc4.api.objects.DeactivateCondition
Deactivate option.
getType() - Method in interface com.uc4.api.objects.IFolder
Returns the type of this folder CLNT ...
getType() - Method in interface com.uc4.api.objects.ITaskItem
Returns the object type of this task.
getType() - Method in class com.uc4.api.objects.JobPlanTask
 
getType() - Method in class com.uc4.api.objects.OCVPanel.CITValue
 
getType() - Method in class com.uc4.api.objects.ScheduleTask
 
getType() - Method in class com.uc4.api.objects.UC4Object
Returns the type of the object, for example JOBP, VARA or SCRI.
getType() - Method in class com.uc4.api.objects.UserRight
Returns the object type.
getType() - Method in class com.uc4.api.SearchResultItem
Deprecated.
Use getObjectType instead
getType() - Method in class com.uc4.api.systemoverview.CheckILMPartitionItem
Returns the type of the UC4 object.
getType() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the process type.
getType() - Method in class com.uc4.api.TaskPromptSetName
Returns the type of this prompt.
getType() - Method in class com.uc4.api.Template
Returns the object type of the template.
getType() - Method in class com.uc4.api.TranslatedMessage
Returns the type of the message.
getType() - Method in class com.uc4.communication.AsyncMessage
Returns a single character which represents the type of this message.
getType() - Method in class com.uc4.communication.requests.GetChangeLog.Entry
Returns the type of the change.
getType() - Method in class com.uc4.communication.requests.OpenObject
Returns the type of the object.
getType() - Method in class com.uc4.communication.requests.SearchIndex.Result
Gets the object type.
getType() - Method in class com.uc4.communication.requests.TaskPromptSetContent
Returns the type of this prompt.
getTypeIcon() - Method in class com.uc4.api.AbstractTask
Returns a description of the status.
getTypeNumber() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
 
getTypeText() - Method in class com.uc4.communication.requests.ActiveNotifications.Entry
Translated type text, for example Email, Message, Request or Alert.
getTypeText() - Method in class com.uc4.communication.requests.NotificationMonitor
Translated type text, for example Email, Message, Request or Alert.
getUC4Client() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the SAP client.
getUC4Department() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the name of the UC4 department.
getUC4Object() - Method in class com.uc4.communication.requests.OpenObject
Returns a subclass of UC4Object or null if the object could not be opened or is not supported.
getUC4User() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the name of the UC4 user.
getUnit() - Method in class com.uc4.api.objects.FileSystem
 
GetUnreadMessages - Class in com.uc4.communication.requests
Returns a list of unread messages.
GetUnreadMessages() - Constructor for class com.uc4.communication.requests.GetUnreadMessages
 
getUpdateCount() - Method in class com.uc4.communication.requests.SetHostAuthorizations
 
getUrgency() - Method in class com.uc4.api.objects.AttributesGCOS8
Returns the priority with which the Job should be executed.
getURL() - Method in class com.uc4.api.objects.SAPConnectionHTTP
Returns the URL of the Service (XI, JXBP, SLD).
getUsage() - Method in class com.uc4.api.systemoverview.LicenseListItem
Returns the number of licenses that are used.
getUsageType() - Method in class com.uc4.api.StorageItem
Returns the specified usage type of the resource.
getUse() - Method in class com.uc4.api.SearchResultItem
Returns a String containing information where the object is used.
getUsedCount() - Method in class com.uc4.api.systemoverview.QueueListItem
 
getUser() - Method in class com.uc4.api.ForecastItem
 
getUser() - Method in class com.uc4.api.objects.ConsoleWindows.ConsoleWindowsFilter
 
getUser() - Method in class com.uc4.api.objects.DatabaseConnection
 
getUser() - Method in class com.uc4.api.objects.SAPConnectionHTTP
Returns the name of the user.
getUser() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the name of the batch user.
getUser() - Method in class com.uc4.api.StatisticSearchItem
Deprecated.
use getUserName() instead
getUser() - Method in class com.uc4.api.Task
Deprecated.
use getUserName() instead
getUser() - Method in class com.uc4.api.TaskFilter
Returns the selected user.
getUser() - Method in class com.uc4.communication.requests.CheckUserPrivileges.Candidate
Returns the name of the user.
getUser() - Method in class com.uc4.communication.requests.GetComments.Comment
Returns the name of the UC4 user which made the comment.
getUser() - Method in class com.uc4.communication.requests.GroupMonitor.Task
Return the user of the task.
getUserDefinedID() - Method in class com.uc4.api.objects.JobPlanTask
Returns the user defined ID of this task or null if not set.
getUserId() - Method in class com.uc4.api.AbstractTask
Returns the signature of the user.
getUserIdnr() - Method in class com.uc4.communication.ConnectionAttributes
 
getUserIdnr() - Method in class com.uc4.communication.requests.CreateSession
Returns the ID of the connected user.
getUserName() - Method in class com.uc4.api.AbstractTask
Returns the name of the User object of the person who has started the task.
getUserName() - Method in class com.uc4.api.objects.SAPQueueManagerFilter
 
getUserName() - Method in class com.uc4.api.systemoverview.CheckILMPartitionItem
Returns the name of the User object of the person who has started the task.
getUserName() - Method in class com.uc4.communication.ConnectionAttributes
 
getUserName() - Method in class com.uc4.communication.requests.CreateSession
Returns the name of the logged on user.
getUserName() - Method in class com.uc4.communication.requests.GetChangeLog.Entry
Returns the user name of the user who did the change (for example USER/DEPARTMENT).
getUserObject() - Method in class com.uc4.communication.requests.CreateSession
Returns the name of the User object (user/department).
getUserTimeZone() - Method in class com.uc4.api.systemoverview.UserListItem
Returns the TimeZone specified in User object.
getValidFrom() - Method in class com.uc4.api.objects.StaticCalendarKeyword
Returns the start date of the validity period.
getValidityKeywordType() - Method in class com.uc4.api.objects.VariableAttributes
Returns the type of the validity keyword.
getValidTimeFrom() - Method in class com.uc4.api.objects.UserAttributes
If hasLogonTimeSpan() is true this method returns the lower limit of the allowed logon time.
getValidTimeTo() - Method in class com.uc4.api.objects.UserAttributes
If hasLogonTimeSpan() is true this method returns the upper limit of the allowed logon time.
getValidTo() - Method in class com.uc4.api.objects.StaticCalendarKeyword
Returns the end date of the validity period.
getValidTypes() - Static method in enum com.uc4.api.objects.UserRight.Type
Returns all object types that are not deprecated.
getValue() - Method in class com.uc4.api.FormItemLabel
 
getValue() - Method in class com.uc4.api.FormItemList
 
getValue() - Method in class com.uc4.api.FormItemNumber
 
getValue() - Method in class com.uc4.api.FormItemText
 
getValue() - Method in interface com.uc4.api.IFormItem
Returns the current value.
getValue() - Method in class com.uc4.api.objects.CustomAttribute
Returns the value of the Custom Attribute.
getValue() - Method in class com.uc4.api.objects.FileSystem
 
getValue(String) - Method in class com.uc4.api.objects.ObjectValues
Returns the value for a given validity keyword The method returns null if the validity keyword does not exist.
getValue() - Method in class com.uc4.api.objects.OCVPanel.CITValue
 
getValue() - Method in class com.uc4.api.objects.PromptElement
Returns the default value of this prompt element.
getValue(String) - Method in class com.uc4.api.objects.PromptSetDefinition
Returns the value of the specified ID.
getValue() - Method in class com.uc4.api.objects.PublishValueAction
 
getValue() - Method in enum com.uc4.api.objects.SAPConnectionRFC.BIExtendedMonitoring
Returns the extended SAP BW monitoring setting.
getValue() - Method in enum com.uc4.api.objects.SAPConnectionRFC.XALVersion
 
getValue() - Method in enum com.uc4.api.objects.SAPConnectionRFC.XBPVersion
 
getValue() - Method in class com.uc4.api.objects.SetValueAction
 
getValue() - Method in class com.uc4.api.objects.SetVariableAction
 
getValue() - Method in class com.uc4.api.objects.SloSelection.Beneficiary
Returns the value of the Beneficiary.
getValue() - Method in class com.uc4.api.objects.SyncAttributes
Gets the current value.
getValue(String) - Method in class com.uc4.api.objects.TaskValues
Returns the value for a given validity keyword The method returns null if the validity keyword does not exist.
getValue() - Method in class com.uc4.api.objects.XMLDocuNode
Returns the value of this node or an empty String if not set.
getValue() - Method in enum com.uc4.api.PlatformSwHwType
Returns the string-representation.
getValue() - Method in class com.uc4.api.systemoverview.HostTraceOptions.HostTraceFlag
get the trace value
getValue() - Method in class com.uc4.api.TraceOptions.TraceFlag
get the trace flag value
getValue() - Method in class com.uc4.communication.requests.GetSyncMonitor
 
getValue() - Method in class com.uc4.communication.requests.NavigatorStatusTree.StatusLeaf
Returns the integer value of the status.
getValue(CockpitControl) - Method in class com.uc4.communication.requests.RefreshCockpitMonitor
Returns the value of the CockpitControl element.
getValue() - Method in enum com.uc4.communication.requests.UploadBinary.ContentType
Returns the string-representation.
getValue1() - Method in class com.uc4.api.objects.UserDefinedCondition
 
getValue2() - Method in class com.uc4.api.objects.UserDefinedCondition
 
getValueColumn() - Method in class com.uc4.api.objects.SetVariableAction
 
getValueFormat() - Method in class com.uc4.api.objects.CockpitValueControl
Returns the format of the 2nd caption.
getValues() - Method in class com.uc4.api.objects.PromptElement
Returns the list of values if the "Array" property is set.
getValues(String) - Method in class com.uc4.api.objects.PromptSetDefinition
Returns the values of the specified ID.
getValues() - Method in class com.uc4.communication.requests.GetRAConnectionValues
Returns the connection values as Map.
getVariable() - Method in class com.uc4.api.objects.PromptElement
Returns the variable name that can be used in the Automation Engine Script.
getVariable(String) - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the value of a given variable.
getVariable1() - Method in class com.uc4.api.objects.CompositeVariable
Returns the name of the first variable.
getVariable2() - Method in class com.uc4.api.objects.CompositeVariable
Returns the name of the first variable.
getVariableColumn() - Method in class com.uc4.api.objects.LoopDataSource
Returns the column.
getVariableKeyword() - Method in class com.uc4.api.objects.DatabaseEventValue
Deprecated.
: variableKeyowrd type changed from UC4ObjectName to String.
getVariableName() - Method in class com.uc4.api.objects.ClearVariableAction
Returns the name of the Variable object.
getVariableName() - Method in class com.uc4.api.objects.CockpitControlDataSource
Returns the name of data source variable.
getVariableName() - Method in class com.uc4.api.objects.DatabaseEventValue
 
getVariableName() - Method in class com.uc4.api.objects.LoopDataSource
Returns the name of the UC4 VARA Object.
getVariableName() - Method in class com.uc4.api.objects.SetVariableAction
 
getVarKeyword() - Method in class com.uc4.api.objects.DatabaseEventValue
 
getVersion() - Method in class com.uc4.api.AbstractTask
Returns the value of the version column.
getVersion() - Method in class com.uc4.api.FolderListItem
Returns the Version of this Automation Engine object.
getVersion() - Method in class com.uc4.api.objects.AgentAssignmentFilter.Item
 
getVersion() - Method in class com.uc4.api.objects.BackendCommand
Returns the version.
getVersion() - Method in class com.uc4.api.objects.ResourceItem
Return the version of the resource.
getVersion() - Method in class com.uc4.api.StorageItem
Returns the version of the resource.
getVersion() - Method in class com.uc4.api.systemoverview.AgentListItem
Returns the Agent version including patch level.
getVersion() - Method in class com.uc4.api.systemoverview.ServerListItem
Returns the server process version including the patch level.
getVersion() - Method in class com.uc4.api.systemoverview.UserListItem
Returns the system version including patch level.
getVersionManagement() - Method in class com.uc4.communication.requests.FolderTree
Returns an IFolder object which represents the "Version Management" folder.
getVersionNumber() - Method in class com.uc4.api.VersionControlListItem
 
getVhTerm() - Method in class com.uc4.api.objects.AttributesNSK
Returns the virual terminal.
getWaitingCount() - Method in class com.uc4.api.systemoverview.QueueListItem
 
getWaitingCount() - Method in class com.uc4.api.TrafficLight
Returns the number of waiting tasks.
getWeekday() - Method in class com.uc4.api.DateTime
 
getWeekday() - Method in class com.uc4.api.objects.TimeZoneAttributes.TimeChangeRule
Gets the weekday on which the time change is made.
getWeekOfYear() - Method in class com.uc4.api.DateTime
Returns the week number.
getWelcomeMessage() - Method in class com.uc4.communication.requests.CreateSession
Returns the first message after logon.
getWFRunID() - Method in class com.uc4.communication.ConnectionAttributes
Returns the ARA Workflow ID.
getwfType() - Method in class com.uc4.api.ComponentWorkflowObjectName
Returns the wfType of the template.
getWhen() - Method in class com.uc4.api.objects.CurrentTimeCondition
 
getWhen() - Method in class com.uc4.api.objects.DeactivateCondition
Returns the status for the error-free execution.
getWhen() - Method in class com.uc4.api.objects.JobPlanTaskDependency
Gets the expected status of the predecessor.
getWidth() - Method in class com.uc4.api.objects.CockpitControl
Returns the width of the CockpitControl.
getWidth() - Method in class com.uc4.api.objects.CockpitDesign
Returns the width of the cockpit form.
getWidth() - Method in class com.uc4.api.TaskPromptSetName
Returns the width of the window in the User Interface.
getWithinSeconds() - Method in class com.uc4.api.objects.FileSystem
 
getWorkflowName() - Method in class com.uc4.api.objects.Deployment
Returns the name of the Workflow .
getWorkflowName() - Method in class com.uc4.communication.requests.GetDeploymentProperties
Returns the name of the Workflow.
getWorkflowName() - Method in class com.uc4.communication.requests.GetObjectProperties
Returns the name of the Workflow.
getWorkingDirectory() - Method in class com.uc4.api.objects.AttributesWin
Returns the working directory in which the Job should run.
getWPDetailElement() - Method in class com.uc4.communication.requests.GetWPProperties
Returns a value of the ServerDetail section
getWPName() - Method in class com.uc4.communication.requests.GetWPProperties
Returns the WP name.
GetWPProperties - Class in com.uc4.communication.requests
Returns the trace options for a Work Process using existing XREQ
GetWPProperties(UC4ObjectName) - Constructor for class com.uc4.communication.requests.GetWPProperties
Creates an instance of GetWPProperties
getWPPropertiesElement() - Method in class com.uc4.communication.requests.GetWPProperties
Returns the WP property element
getWPProperty(String) - Method in class com.uc4.communication.requests.GetWPProperties
Returns the value of an Server property or null if the key was not found.
getWPTraceElement() - Method in class com.uc4.communication.requests.GetWPProperties
Returns a value of the ServerDetail section
getWPTraceOptions() - Method in class com.uc4.communication.requests.GetWPProperties
Returns a WPTraceOptions Object
getX() - Method in class com.uc4.api.objects.JobPlanTask
Returns the column number of this JobPlan task.
getX() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the position of this task.
getXALMonitor() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the name of the monitor.
getXALMonitorSet() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the name of the monitor set.
getXALMonitorShortName() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the short name of the XAL monitor.
getXALVersion() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the XAL Version, DEFAULT if not set.
getXBPAuditlevel() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the XBP auditlevel (0= Minimal, 3= Trace) Depending on the auditlevel the XMI log will contain more or less entries.
getXBPVersion() - Method in class com.uc4.api.objects.SAPConnectionRFC
Returns the XBP Version.
getXiConnection() - Method in class com.uc4.api.objects.SAPAgentPanel
 
getXmlDocuNames() - Method in class com.uc4.api.objects.DocuContainer
 
getXmlKey() - Method in class com.uc4.api.prompt.CheckGroupElement
Returns the key for XML Variables in the data reference.
getXmlKey() - Method in class com.uc4.api.prompt.ComboElement
Returns the key for XML Variables in the data reference.
getXmlKey() - Method in interface com.uc4.api.prompt.PromptInterfaces.XmlKey
Returns the key for XML Variables in the data reference.
getXmlKey() - Method in class com.uc4.api.prompt.RadioGroupElement
Returns the key for XML Variables in the data reference.
getXmlKey() - Method in class com.uc4.api.prompt.TextElement
Returns the key for XML Variables in the data reference.
getXmlName() - Method in class com.uc4.api.objects.OCVPanel.CITValue
 
getXmlStream() - Method in class com.uc4.api.systemoverview.QuarantineListItem
 
getXPath() - Method in class com.uc4.api.prompt.CheckGroupElement
Returns the XPath expression if XML variables are used as data reference.
getXPath() - Method in class com.uc4.api.prompt.ComboElement
Returns the XPath expression if XML variables are used as data reference.
getXPath() - Method in interface com.uc4.api.prompt.PromptInterfaces.XPath
Returns the XPath expression if XML variables are used as data reference.
getXPath() - Method in class com.uc4.api.prompt.RadioGroupElement
Returns the XPath expression if XML variables are used as data reference.
getXPath() - Method in class com.uc4.api.prompt.TextElement
Returns the XPath expression if XML variables are used as data reference.
getY() - Method in class com.uc4.api.objects.JobPlanTask
Returns the row number of this JobPlan task.
getY() - Method in class com.uc4.communication.requests.JobPlanMonitor.Task
Returns the position of this task.
getYear() - Method in class com.uc4.api.DateTime
Returns the 4-digit year of this DateTime object.
getYear() - Method in class com.uc4.api.objects.TimeZoneAttributes
Returns the year for and after the local time values are valid.
getZDUStep() - Method in class com.uc4.communication.requests.ZduStep
 
getZduVersion() - Method in class com.uc4.api.systemoverview.AgentListItem
 
getZduVersion() - Method in class com.uc4.api.systemoverview.MQMemListItem
 
getZduVersion() - Method in class com.uc4.api.systemoverview.UserListItem
Returns ZDU Version
getZDUVersion() - Method in class com.uc4.api.Task
 
Group - Class in com.uc4.api.objects
This class represents a UC4 JOBG object.
Group() - Constructor for class com.uc4.api.objects.Group
 
GroupAttributes - Class in com.uc4.api.objects
JobGroup attributes.
GroupCalendarKeyword - Class in com.uc4.api.objects
This class represents a group calendar keyword.
GroupCalendarKeyword(UC4ObjectName) - Constructor for class com.uc4.api.objects.GroupCalendarKeyword
Constructs a new GroupCalendarKeyword.
groupIterator() - Method in class com.uc4.communication.requests.TaskDetails
Returns an iterator over DetailGroup.
GroupMonitor - Class in com.uc4.communication.requests
Reads a Group monitor.
GroupMonitor(int) - Constructor for class com.uc4.communication.requests.GroupMonitor
Constructs a new GroupMonitor request.
GroupMonitor.Task - Class in com.uc4.communication.requests
This class represents a task in the Group monitor.
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z