Package com.uc4.communication.requests
Class ScheduleMonitor.Task
- java.lang.Object
-
- com.uc4.communication.requests.ScheduleMonitor.Task
-
- Enclosing class:
- ScheduleMonitor
public static class ScheduleMonitor.Task extends java.lang.Object
This class represents a task in the Schedule monitor.
-
-
Constructor Summary
Constructors Constructor Description Task(boolean srcEH, int runID, org.w3c.dom.Element task, ConnectionAttributes session)
Creates an instance from a DOM element.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.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.java.lang.String
getName()
DateTime
getNextCheck()
Returns the timestamp of the next check.DateTime
getNextStart()
Returns the timstamp of the next start.java.lang.String
getObjectType()
Returns the type of the Object.int
getRunID()
Returns the RunID of the task in the monitor or0
if the task has not been executed.int
getScheduleRunID()
Returns the RunID of the Schedule.Time
getStartTime()
Return the start time of the task.java.lang.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.java.lang.String
getStatusText()
Returns a description of the status.java.lang.String
getTaskPosition()
Returns the position of the task in the Scheduleboolean
hasComment()
boolean
isActive()
Returnstrue
if the task is active.boolean
isNextStartNotDefined()
-
-
-
Constructor Detail
-
Task
public Task(boolean srcEH, int runID, org.w3c.dom.Element task, ConnectionAttributes session)
Creates an instance from a DOM element.- Parameters:
srcEH
- True if the task is in the activity listrunID
- RunIdtask
- Elementsession
- 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 java.lang.String getTaskPosition()
Returns the position of the task in the Schedule- Returns:
- LNR
-
isActive
public boolean isActive()
Returnstrue
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 or0
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 java.lang.String getObjectType()
Returns the type of the Object.- Returns:
- Object type
-
getConditions
public java.lang.String getConditions()
Returns the value of the conditions column in the monitor.- Returns:
- Conditions
-
getName
public java.lang.String getName()
- Returns:
- Name of the UC4 Object
-
getStatusText
public java.lang.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 java.lang.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.
-
-