TaskState (java-api 21.0.12 API)

java.lang.Object
- com.uc4.api.objects.TaskState

public class TaskState
extends java.lang.Object

Task states.

Field Summary

Fields
Modifier and Type	Field and Description
`static TaskState`	`ANY_ABEND` Task disrupted.
`static TaskState`	`ANY_ABEND_EXCEPT_FAULT` System return code 1800-1819,1823-1899.
`static TaskState`	`ANY_ACTIVE` System return code 1300-1799.
`static TaskState`	`ANY_BLOCKED` System return code 1560,1562.
`static TaskState`	`ANY_BLOCKED_OR_STOPPED` System return code 1560-1564 .
`static TaskState`	`ANY_EXCEPT_FAULT` System return code 1800-1819,1823-1999.
`static TaskState`	`ANY_OK` Task ended normally.
`static TaskState`	`ANY_OK_OR_UNBLOCKED` System return code 1900-1999,1899.
`static TaskState`	`ANY_SKIPPED` Task skipped.
`static TaskState`	`ANY_STOPPED` System return code 1561,1563-1564.
`static TaskState`	`ANY_WAITING` System return code 1301,1682-1700,1709-1710.
`static TaskState`	`ENDED_CANCEL` Task canceled.
`static TaskState`	`ENDED_EMPTY` Task ended empty.
`static TaskState`	`ENDED_ESCALATED` Aborted by escalation.
`static TaskState`	`ENDED_INACTIVE` Task is inactive.
`static TaskState`	`ENDED_INACTIVE_MANUAL` Task was set inactive.
`static TaskState`	`ENDED_NOT_OK` Task aborted (Return Code not 0).
`static TaskState`	`ENDED_NOT_OK_SYNC` Task ended not ok beacause of Sync condition.
`static TaskState`	`ENDED_OK` Task ended normally (Return Code = 0).
`static TaskState`	`ENDED_OK_OR_EMPTY` Task ended normally or is empty.
`static TaskState`	`ENDED_OK_OR_INACTIVE` Task ended normally or is inactive.
`static TaskState`	`ENDED_OK_OR_UNBLOCKED` System return code 1900,1899.
`static TaskState`	`ENDED_SKIPPED` Task skipped due to the WHEN condition.
`static TaskState`	`ENDED_SKIPPED_CONDITIONS` System return code 1933.
`static TaskState`	`ENDED_SKIPPED_SYNC` Task skipped due to the Sync condition.
`static TaskState`	`ENDED_TIMEOUT` Task was not executed because time had expired (dependency condition).
`static TaskState`	`ENDED_TRUNCATE` Transfer incomplete due to line limit.
`static TaskState`	`ENDED_UNDEFINED` Task ended undefined (Agent ended ahead of schedule).
`static TaskState`	`ENDED_VANISHED` Task vanished.
`static TaskState`	`FAULT_ALREADY_RUNNING` Group running.
`static TaskState`	`FAULT_NO_HOST` Job could not start due to unavailable host.
`static TaskState`	`FAULT_OTHER` Task could not start due to another error.
`static TaskState`	`USER_100_200` Task ended with a user return code between 100 and 200.
`static TaskState`	`USER_147` Task ended with the user return code 147.
`static TaskState`	`USER_201_299` Task ended with a user return code between 201 and 299.
`static TaskState`	`USER_300` Task ended with the user return code 300.
`static TaskState`	`USER_510` Task ended with a user return code 510.
`static TaskState`	`USER_690` Task ended with a user return code 690.
`static TaskState`	`WAITING_AGENT` System return code 1685,1688-1689,1694,1696.
`static TaskState`	`WAITING_AGENT_OR_AGENTGROUP` System return code 1685,1688-1689,1694,1696.
`static TaskState`	`WAITING_AGENTGROUP` System return code 1686-1687.
`static TaskState`	`WAITING_EXTERNAL` System return code 1690.
`static TaskState`	`WAITING_GROUP` System return code 1710.
`static TaskState`	`WAITING_QUEUE` System return code 1684.
`static TaskState`	`WAITING_SYNC` System return code 1697.

Constructor Summary

Constructors
Constructor and Description
`TaskState(java.lang.String name)` Constructs a new `TaskState` from the specified name.
`TaskState(java.lang.String name, int state)` Constructs a new `TaskState` from the specified name and state.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getName()` Returns the name of the task state.
`int`	`getState()` Return the `TaskState` state.
`int`	`hashCode()`
`boolean`	`isStateDeleted()` Checks if the `TaskState` has the deleted state.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ANY_ABEND
```
public static final TaskState ANY_ABEND
```
    Task disrupted. ANY_ABEND combines all conditions with Return Codes between 1800 and 1899.
  - ANY_ABEND_EXCEPT_FAULT
```
public static final TaskState ANY_ABEND_EXCEPT_FAULT
```
    System return code 1800-1819,1823-1899.
  - ANY_ACTIVE
```
public static final TaskState ANY_ACTIVE
```
    System return code 1300-1799.
  - ANY_BLOCKED
```
public static final TaskState ANY_BLOCKED
```
    System return code 1560,1562.
  - ANY_BLOCKED_OR_STOPPED
```
public static final TaskState ANY_BLOCKED_OR_STOPPED
```
    System return code 1560-1564 .
  - ANY_EXCEPT_FAULT
```
public static final TaskState ANY_EXCEPT_FAULT
```
    System return code 1800-1819,1823-1999.
  - ANY_OK
```
public static final TaskState ANY_OK
```
    Task ended normally. ANY_OK combines all conditions with Return Codes between 1900 and 1999.
  - ANY_SKIPPED
```
public static final TaskState ANY_SKIPPED
```
    Task skipped. ANY_SKIPPED is the listing of certain conditions(they may also be found in ANY_OK).
  - ANY_STOPPED
```
public static final TaskState ANY_STOPPED
```
    System return code 1561,1563-1564.
  - ANY_WAITING
```
public static final TaskState ANY_WAITING
```
    System return code 1301,1682-1700,1709-1710.
  - ENDED_CANCEL
```
public static final TaskState ENDED_CANCEL
```
    Task canceled. The job itself, or the whole JobPlan, may have been canceled.
  - ENDED_EMPTY
```
public static final TaskState ENDED_EMPTY
```
    Task ended empty. The activation was ended without error message (STOP NOMSG - Script statement).
  - ENDED_ESCALATED
```
public static final TaskState ENDED_ESCALATED
```
    Aborted by escalation.
  - ENDED_INACTIVE_MANUAL
```
public static final TaskState ENDED_INACTIVE_MANUAL
```
    Task was set inactive.
  - ENDED_INACTIVE
```
public static final TaskState ENDED_INACTIVE
```
    Task is inactive.
  - ENDED_NOT_OK
```
public static final TaskState ENDED_NOT_OK
```
    Task aborted (Return Code not 0).
  - ENDED_NOT_OK_SYNC
```
public static final TaskState ENDED_NOT_OK_SYNC
```
    Task ended not ok beacause of Sync condition.
  - ENDED_OK
```
public static final TaskState ENDED_OK
```
    Task ended normally (Return Code = 0).
  - ENDED_OK_OR_EMPTY
```
public static final TaskState ENDED_OK_OR_EMPTY
```
    Task ended normally or is empty.
  - ENDED_OK_OR_INACTIVE
```
public static final TaskState ENDED_OK_OR_INACTIVE
```
    Task ended normally or is inactive.
  - ENDED_SKIPPED
```
public static final TaskState ENDED_SKIPPED
```
    Task skipped due to the WHEN condition.
  - ENDED_SKIPPED_SYNC
```
public static final TaskState ENDED_SKIPPED_SYNC
```
    Task skipped due to the Sync condition.
  - ENDED_TIMEOUT
```
public static final TaskState ENDED_TIMEOUT
```
    Task was not executed because time had expired (dependency condition).
  - ENDED_TRUNCATE
```
public static final TaskState ENDED_TRUNCATE
```
    Transfer incomplete due to line limit.
  - ENDED_UNDEFINED
```
public static final TaskState ENDED_UNDEFINED
```
    Task ended undefined (Agent ended ahead of schedule).
  - ENDED_VANISHED
```
public static final TaskState ENDED_VANISHED
```
    Task vanished.
  - FAULT_ALREADY_RUNNING
```
public static final TaskState FAULT_ALREADY_RUNNING
```
    Group running.
  - FAULT_NO_HOST
```
public static final TaskState FAULT_NO_HOST
```
    Job could not start due to unavailable host.
  - FAULT_OTHER
```
public static final TaskState FAULT_OTHER
```
    Task could not start due to another error.
  - USER_100_200
```
public static final TaskState USER_100_200
```
    Task ended with a user return code between 100 and 200.
  - USER_147
```
public static final TaskState USER_147
```
    Task ended with the user return code 147.
  - USER_201_299
```
public static final TaskState USER_201_299
```
    Task ended with a user return code between 201 and 299.
  - USER_300
```
public static final TaskState USER_300
```
    Task ended with the user return code 300.
  - USER_510
```
public static final TaskState USER_510
```
    Task ended with a user return code 510.
  - USER_690
```
public static final TaskState USER_690
```
    Task ended with a user return code 690.
  - WAITING_AGENT
```
public static final TaskState WAITING_AGENT
```
    System return code 1685,1688-1689,1694,1696.
  - WAITING_AGENT_OR_AGENTGROUP
```
public static final TaskState WAITING_AGENT_OR_AGENTGROUP
```
    System return code 1685,1688-1689,1694,1696.
  - WAITING_AGENTGROUP
```
public static final TaskState WAITING_AGENTGROUP
```
    System return code 1686-1687.
  - WAITING_EXTERNAL
```
public static final TaskState WAITING_EXTERNAL
```
    System return code 1690.
  - WAITING_GROUP
```
public static final TaskState WAITING_GROUP
```
    System return code 1710.
  - WAITING_QUEUE
```
public static final TaskState WAITING_QUEUE
```
    System return code 1684.
  - WAITING_SYNC
```
public static final TaskState WAITING_SYNC
```
    System return code 1697.
  - ANY_OK_OR_UNBLOCKED
```
public static final TaskState ANY_OK_OR_UNBLOCKED
```
    System return code 1900-1999,1899.
  - ENDED_SKIPPED_CONDITIONS
```
public static final TaskState ENDED_SKIPPED_CONDITIONS
```
    System return code 1933.
  - ENDED_OK_OR_UNBLOCKED
```
public static final TaskState ENDED_OK_OR_UNBLOCKED
```
    System return code 1900,1899.
- Constructor Detail
  - TaskState
```
public TaskState(java.lang.String name)
```
    Constructs a new TaskState from the specified name.
    
    Parameters:
    
    name - Name
  - TaskState
```
public TaskState(java.lang.String name,
                 int state)
```
    Constructs a new TaskState from the specified name and state.
    
    Parameters:
    
    name - Name
    
    state - The state value.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name of the task state.
    
    Returns:
    
    Name
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getState
```
public int getState()
```
    Return the TaskState state.
    
    Returns:
    
    The task state as numeric value.
  - isStateDeleted
```
public boolean isStateDeleted()
```
    Checks if the TaskState has the deleted state. This is usually a state if one task was replaced by another task during monitor modifications.
    
    Returns:
    
    True if getState() is JobPlanMonitor.Task.DELETED_LINE_STATE

Class TaskState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANY_ABEND

ANY_ABEND_EXCEPT_FAULT

ANY_ACTIVE

ANY_BLOCKED

ANY_BLOCKED_OR_STOPPED

ANY_EXCEPT_FAULT

ANY_OK

ANY_SKIPPED

ANY_STOPPED

ANY_WAITING

ENDED_CANCEL

ENDED_EMPTY

ENDED_ESCALATED

ENDED_INACTIVE_MANUAL

ENDED_INACTIVE

ENDED_NOT_OK

ENDED_NOT_OK_SYNC

ENDED_OK

ENDED_OK_OR_EMPTY

ENDED_OK_OR_INACTIVE

ENDED_SKIPPED

ENDED_SKIPPED_SYNC

ENDED_TIMEOUT

ENDED_TRUNCATE

ENDED_UNDEFINED

ENDED_VANISHED

FAULT_ALREADY_RUNNING

FAULT_NO_HOST

FAULT_OTHER

USER_100_200

USER_147

USER_201_299

USER_300

USER_510

USER_690

WAITING_AGENT

WAITING_AGENT_OR_AGENTGROUP

WAITING_AGENTGROUP

WAITING_EXTERNAL

WAITING_GROUP

WAITING_QUEUE

WAITING_SYNC

ANY_OK_OR_UNBLOCKED

ENDED_SKIPPED_CONDITIONS

ENDED_OK_OR_UNBLOCKED

Constructor Detail

TaskState

TaskState

Method Detail

getName

equals

hashCode

toString

getState

isStateDeleted