com.uc4.api

Class Task

java.lang.Object

com.uc4.api.AbstractTask

com.uc4.api.Task

public class Task
extends AbstractTask

This class contains a description of a single task in the ActivityList.

Constructor Summary

Constructors

Constructor and Description
Task(org.w3c.dom.Element row, ConnectionAttributes session) Constructs a new Task using the specified element.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other) Two tasks are equal if their RunID is equal.
int	getConsumption()
float	getCpuTime() Returns the consumed CPU time in seconds.
int	getHirarchicalParent() Returns the RunID of the of hirarchical parent.
java.lang.String	getModificationFlag() Returns the value of the modification flag column.
int	getPriority() Returns the priority of the task.
java.lang.String	getProcessId() Returns the process identification on OS level during execution.
int	getProcessorRunID() Returns the processor RunID.
java.lang.String	getStatusWithinParentText() Returns the state of the task within his parent task which can be a Workflow of any type: Standard, IF or ForEach.
java.lang.String	getUser() Deprecated. use getUserName() instead
int	hashCode() The RunID of a task is used as hash code.
boolean	isProcessorTask() Returns true if this task is a processor task.
java.lang.String	toString() Returns a string which contains the name and the RunID of this task.

Methods inherited from class com.uc4.api.AbstractTask

getArchive1, getArchive2, getArchiveKey1, getArchiveKey2, getClient, getEndTime, getHost, getName, getParentRunID, getPeriodDescription, getPlatform, getQueue, getRemoteStatus, getRunID, getRuntime, getStart, getStartTime, getStartType, getStateIcon, getStatus, getStatusCode, getStatusText, getTaskClient, getType, getTypeIcon, getUserId, getUserName, hasComment, isMonitoredTask, isRollback

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Task

public Task(org.w3c.dom.Element row,
    ConnectionAttributes session)

Constructs a new Task using the specified element.

Parameters:

row - Element

session - Session

Method Detail

isProcessorTask

public boolean isProcessorTask()

Returns true if this task is a processor task.

Returns:

Is processor?

getModificationFlag

public java.lang.String 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

public java.lang.String getProcessId()

Returns the process identification on OS level during execution.

Returns:

Process ID

getStatusWithinParentText

public final java.lang.String 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

getUser

@Deprecated
public java.lang.String getUser()

Deprecated. use getUserName() instead

Returns the name of the User object of the person who has started the task.

Returns:

UC4 User

equals

public boolean equals(java.lang.Object other)

Two tasks are equal if their RunID is equal.

Overrides:

equals in class java.lang.Object

Parameters:

other - Task

Returns:

true if two tasks have the same RundID, false otherwise

hashCode

public int hashCode()

The RunID of a task is used as hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

RunID

toString

public java.lang.String toString()

Returns a string which contains the name and the RunID of this task.

Overrides:

toString in class AbstractTask

Returns:

Name and RunID of the task.