Package com.uc4.communication.requests

Class ScheduleMonitor

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.ScheduleMonitor
All Implemented Interfaces:
Iterable<ScheduleMonitor.Task>
public class ScheduleMonitor extends XMLRequest implements Iterable<ScheduleMonitor.Task>
Reads a Schedule monitor.

  • Constructor Details

    • ScheduleMonitor

      @Deprecated public ScheduleMonitor(int runID, boolean active)
      Deprecated.
      This method is deprecated on 31-03-2016, please set "src" using methods setActivityScheduleMonitor, setArchiveScheduleMonitor, setExplorerScheduleMonitor
      Constructs a new ScheduleMonitor request.
      Parameters:
      runID - RunID
      active - true if the monitor should be read from the activity window,

    • ScheduleMonitor

      public ScheduleMonitor(int runID)
      Constructs a new ScheduleMonitor request.
      Parameters:
      runID - RunID

  • Method Details

    • createRequest

      protected void createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)
      Description copied from class: XMLRequest
      Creates the XML Document for the request. This method is used internally.
      Specified by:
      createRequest in class XMLRequest
      Parameters:
      doc - Document, used to create new Elements
      request - Request Element - classes append information to this request element
      sessionInfo - Information about the session

    • getSrc

      protected String getSrc()
      Description copied from class: XMLRequest
      Returns the request source. This method is used internally.
      Specified by:
      getSrc in class XMLRequest
      Returns:
      Source

    • setIncludeTaskProperties

      public void setIncludeTaskProperties(boolean includeTaskProperties)
      If this method is set to true, the properties of task are also returned in the monitor. The value should be set to false if the values are not used in order to improve the performance for large Schedule monitor tasks.
      Parameters:
      includeTaskProperties - true to include properties of each task in the response.

    • isReloadNextTurnaround

      public boolean isReloadNextTurnaround()
      Returns true if reload definition at period turnaround is enabled.
      Returns:
      Reload at period turnaround?

    • getStatusCode

      public int getStatusCode()
      Returns the status of the task as integer.
      Returns:
      Status code or -1 in case of an error. Possible return values are described in the status: AbstractTask.getStatusCode()

    • isActive

      public boolean isActive()
      Returns:
      true if the if task is active, false otherwise

    • getStartTime

      public String getStartTime()
      Returns:
      start Time

    • handleContent

      protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
      Description copied from class: XMLRequest
      Sub classes extract the values from the XML document and provide public getter methods.
      Overrides:
      handleContent in class XMLRequest
      Parameters:
      doc - XML Document
      session - Info about the user session

    • createTask

      protected ScheduleMonitor.Task createTask(Element task, ConnectionAttributes session)
      Creates a new ScheduleMonitor.Task in the Schedule monitor. Sub classes may override this method.
      Parameters:
      task - XML Element of the task
      session - Session Info
      Returns:
      a new ScheduleMonitor.Task instance

    • iterator

      public Iterator<ScheduleMonitor.Task> iterator()
      Specified by:
      iterator in interface Iterable<ScheduleMonitor.Task>

    • size

      public int size()
      Returns the number of tasks in this schedule.
      Returns:
      Task count

    • isAllowedInClientZero

      protected boolean isAllowedInClientZero()
      Description copied from class: XMLRequest
      This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.
      Overrides:
      isAllowedInClientZero in class XMLRequest
      Returns:
      true if this request is allowed in client 0, false otherwise

    • getRunID

      public int getRunID()
      Returns the run id of this schedule.
      Returns:
      run

    • setActivityScheduleMonitor

      public void setActivityScheduleMonitor()
      If this method is called the detail of a ScheduleMonitor in the activity list is returned.

    • setArchiveScheduleMonitor

      public void setArchiveScheduleMonitor()
      If this method is called the detail of a ScheduleMonitor in the statistics is returned.

    • setExplorerScheduleMonitor

      public void setExplorerScheduleMonitor()
      If this method is called the detail of a ScheduleMonitor in the Explorer is returned.