Package com.uc4.api

Class Task

  • All Implemented Interfaces:
    HasAlias
    public class Task
extends AbstractTask
    This class contains a description of a single task in the ActivityList.

    • Field Detail

      • priority

        protected int priority

      • processId

        protected java.lang.String processId

      • cpuTime

        protected float cpuTime

      • consumption

        protected int consumption

      • processorRunID

        protected int processorRunID

      • hirarchicalParent

        protected int hirarchicalParent

      • modificationFlag

        protected java.lang.String modificationFlag

      • processorTask

        protected boolean processorTask

      • zduVersion

        protected java.lang.String zduVersion

      • statistics

        protected boolean statistics

      • estimatedEndTime

        protected DateTime estimatedEndTime

    • 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

      • getZDUVersion

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

        public DateTime getEstimatedEndTime()
        Returns the Estimated End Time
        Returns:
        Estimated End Time, a DateTime

      • 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.

      • 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