Package com.uc4.api
Class Task
java.lang.Object
com.uc4.api.AbstractTask
com.uc4.api.Task
- All Implemented Interfaces:
HasAlias
This class contains a description of a single task in the
ActivityList
.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
protected float
protected DateTime
protected int
protected String
protected int
protected String
protected int
protected boolean
protected boolean
protected String
Fields inherited from class com.uc4.api.AbstractTask
activationTime, alias, archiveKey1, archiveKey2, cauVersion, comment, endTime, host, intAccount, monitoredTask, name, objectName, parentRunID, periodDescription, platform, queue, remoteStatus, returnCode, rollback, runID, runtime, startTime, startType, state, stateIcon, stateWithinParent, statusCode, statusText, type, typeIcon, userId, version
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Task
(ConnectionAttributes session) Task
(Element row, ConnectionAttributes session) Constructs a newTask
using the specified element. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Two tasks are equal if their RunID is equal.int
Value to compare at file events console event: eventcounter job/ft: status counter, also indicates which client is deletedint
float
Returns the consumed CPU time in seconds.Returns the Estimated End Timeint
Returns the RunID of the of hirarchical parent.Returns the value of the modification flag column.int
Returns the priority of the task.Returns the process identification on OS level during execution.int
Returns the processor RunID.final String
Returns the state of the task within his parent task which can be a Workflow of any type: Standard, IF or ForEach.getUser()
Deprecated.use getUserName() insteadint
hashCode()
The RunID of a task is used as hash code.boolean
Returnstrue
if this task is a processor task.boolean
Returns the source of the task if it has been created with the TaskList request.toString()
Returns a string which contains the name and the RunID of this task.Methods inherited from class com.uc4.api.AbstractTask
getActivationTime, getAlias, getArchive1, getArchive2, getArchiveKey1, getArchiveKey2, getCauVersion, getClient, getEndTime, getHost, getIntAccount, getName, getObjectName, getParentRunID, getPeriodDescription, getPlatform, getQueue, getRemoteStatus, getReturnCode, getRunID, getRuntime, getRuntimeInMillis, getStart, getStartTime, getStartType, getStateIcon, getStatus, getStatusCode, getStatusIcon, getStatusText, getTaskClient, getType, getTypeIcon, getUserId, getUserName, getVersion, hasComment, initObjectNameAndAlias, isMonitoredTask, isRollback, setUserInfo
-
Field Details
-
priority
protected int priority -
processId
-
cpuTime
protected float cpuTime -
consumption
protected int consumption -
processorRunID
protected int processorRunID -
hirarchicalParent
protected int hirarchicalParent -
modificationFlag
-
processorTask
protected boolean processorTask -
zduVersion
-
statistics
protected boolean statistics -
estimatedEndTime
-
-
Constructor Details
-
Task
-
Task
Constructs a newTask
using the specified element.- Parameters:
row
- Elementsession
- Session
-
-
Method Details
-
isProcessorTask
public boolean isProcessorTask()Returnstrue
if this task is a processor task.- Returns:
- Is processor?
-
getModificationFlag
Returns the value of the modification flag column.- Returns:
- Name of the user who modified a workflow or an empty String.
-
getConsumption
public int getConsumption()- Returns:
- Consumption which is set for this task
-
getHirarchicalParent
public int getHirarchicalParent()Returns the RunID of the of hirarchical parent.- Returns:
- Parent RunID
-
getCpuTime
public float getCpuTime()Returns the consumed CPU time in seconds.- Returns:
- CPU time
-
getPriority
public int getPriority()Returns the priority of the task.- Returns:
- priority
-
getProcessorRunID
public int getProcessorRunID()Returns the processor RunID.- Returns:
- processor RunID
-
getProcessId
Returns the process identification on OS level during execution.- Returns:
- Process ID
-
getStatusWithinParentText
Returns the state of the task within his parent task which can be a Workflow of any type: Standard, IF or ForEach.- Returns:
- A readable translated state as String
-
getZDUVersion
- Returns:
- Target or Base version
-
isStatistics
public boolean isStatistics()Returns the source of the task if it has been created with the TaskList request. This request returns a combined view on activities and statistics.- Returns:
- true if the source is from statistics, false if the source of the task is the activity list.
-
getEstimatedEndTime
Returns the Estimated End Time- Returns:
- Estimated End Time, a DateTime
-
getUser
Deprecated.use getUserName() insteadReturns the name of the User object of the person who has started the task.- Returns:
- UC4 User
-
equals
Two tasks are equal if their RunID is equal. -
hashCode
public int hashCode()The RunID of a task is used as hash code. -
toString
Returns a string which contains the name and the RunID of this task.- Overrides:
toString
in classAbstractTask
- Returns:
- Name and RunID of the task.
-
getCompareValue
public int getCompareValue()Value to compare at file events console event: eventcounter job/ft: status counter, also indicates which client is deleted- Returns:
- compare value
-