ScheduleMonitor.Task (java-api 12.3.1 API)

java.lang.Object
- com.uc4.communication.requests.ScheduleMonitor.Task

Enclosing class:

ScheduleMonitor
```
public static class ScheduleMonitor.Task
extends Object
```
This class represents a task in the Schedule monitor.

Constructor Summary

Constructors
Constructor and Description

Task(boolean srcEH, int runID, Element task, ConnectionAttributes session)
Creates an instance from a DOM element.

Constructors
Constructor and Description
`Task(boolean srcEH, int runID, Element task, ConnectionAttributes session)` Creates an instance from a DOM element.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getConditions()` Returns the value of the conditions column in the monitor.
`int`	`getDayOffset()` Returns the number of days (calendar days serve as a basis) which must have passed after the start of the period.
`String`	`getName()`
`DateTime`	`getNextCheck()` Returns the timestamp of the next check.
`DateTime`	`getNextStart()` Returns the timstamp of the next start.
`String`	`getObjectType()` Returns the type of the Object.
`int`	`getRunID()` Returns the RunID of the task in the monitor or `0` if the task has not been executed.
`int`	`getScheduleRunID()` Returns the RunID of the Schedule.
`Time`	`getStartTime()` Return the start time of the task.
`String`	`getStatus()` Returns the status of this task as String which is independent on the logon language.
`int`	`getStatusCode()` Returns the status of the task as integer.
`String`	`getStatusText()` Returns a description of the status.
`String`	`getTaskPosition()` Returns the position of the task in the Schedule
`boolean`	`hasComment()`
`boolean`	`isActive()` Returns `true` if the task is active.
`boolean`	`isNextStartNotDefined()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Task
```
public Task(boolean srcEH,
            int runID,
            Element task,
            ConnectionAttributes session)
```
    Creates an instance from a DOM element.
    
    Parameters:
    
    srcEH - True if the task is in the activity list
    
    runID - RunId
    
    task - Element
    
    session - API Session info
- Method Detail
  - getDayOffset
```
public int getDayOffset()
```
    Returns the number of days (calendar days serve as a basis) which must have passed after the start of the period. Then, the task is started at the specified time.
    
    Returns:
    
    Number of days
  - getNextStart
```
public DateTime getNextStart()
```
    Returns the timstamp of the next start.
    
    Returns:
    
    Next start
  - getNextCheck
```
public DateTime getNextCheck()
```
    Returns the timestamp of the next check.
    
    Returns:
    
    Next check
  - getStartTime
```
public Time getStartTime()
```
    Return the start time of the task.
    
    Returns:
    
    Time for task start in hours and minutes.
  - getTaskPosition
```
public String getTaskPosition()
```
    Returns the position of the task in the Schedule
    
    Returns:
    
    LNR
  - isActive
```
public boolean isActive()
```
    Returns true if the task is active. If the check box is not selected, the task is not active. It is therefore not executed but is still part of the Schedule.
    
    Returns:
    
    true if the task is active, false if not
  - getRunID
```
public int getRunID()
```
    Returns the RunID of the task in the monitor or 0 if the task has not been executed.
    
    Returns:
    
    RunID of the task or zero
  - getScheduleRunID
```
public int getScheduleRunID()
```
    Returns the RunID of the Schedule.
    
    Returns:
    
    Schedule RunID
  - getObjectType
```
public String getObjectType()
```
    Returns the type of the Object.
    
    Returns:
    
    Object type
  - getConditions
```
public String getConditions()
```
    Returns the value of the conditions column in the monitor.
    
    Returns:
    
    Conditions
  - getName
```
public String getName()
```
    Returns:
    
    Name of the UC4 Object
  - getStatusText
```
public String getStatusText()
```
    Returns a description of the status. This return value depends on the logon language.
    
    Returns:
    
    description for task status. Possible return values are described in the status: AbstractTask.getStatusCode()
  - getStatus
```
public String getStatus()
```
    Returns the status of this task as String which is independent on the logon language.
    
    Returns:
    
    status, possible return values are described in the status table: AbstractTask.getStatusCode()
  - getStatusCode
```
public final int getStatusCode()
```
    Returns the status of the task as integer.
    
    Returns:
    
    Status code or -1 in case of an error
  - hasComment
```
public boolean hasComment()
```
    Returns:
    
    true if this task item has an attached comment.
  - isNextStartNotDefined
```
public boolean isNextStartNotDefined()
```
    Returns:
    
    true if this task item does not have next start time.

Class ScheduleMonitor.Task

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Task

Method Detail

getDayOffset

getNextStart

getNextCheck

getStartTime

getTaskPosition

isActive

getRunID

getScheduleRunID

getObjectType

getConditions

getName

getStatusText

getStatus

getStatusCode

hasComment

isNextStartNotDefined