Class ModifyStartTime

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.ModifyStartTime

public final class ModifyStartTime extends XMLRequest
Modifies the start time of a task was executed once and is waiting for its start time.
  • Constructor Details

    • ModifyStartTime

      public ModifyStartTime(int runID, DateTime start, UC4TimezoneName timeZone)
      Constructs a new ModifyStartTime request to change the start time of a task.
      Parameters:
      runID - RunID of the task
      start - Start time New start time of the task
      timeZone - Name of the time zone object or null if the default should be used
    • ModifyStartTime

      public ModifyStartTime(int runID, DateTime start, DateTime logicalDatetime, UC4TimezoneName timeZone)
      Constructs a new ModifyStartTime request to change the start time of a task.
      Parameters:
      runID - RunID of the task
      start - Start time New start time of the task
      logicalDatetime - logical Date and time
      timeZone - Name of the time zone object or null if the default should be used
  • 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
    • isTimeoutIfPast

      public boolean isTimeoutIfPast()
      Returns true if the task should end with a timeout in case the modified start date is in the past, false is returned if the task should start immediately.
      Returns:
      Timeout setting
    • setTimeoutIfPast

      public void setTimeoutIfPast(boolean timeoutIfPast)
      Sets the behaviour in case of a start date which is in the past: If the parameter timeoutIfPast is set to true the task will end if false the task will run immediately.
      Parameters:
      timeoutIfPast - Timeout if modification is in past
    • modifyFirstTimeExecuteTask

      public void modifyFirstTimeExecuteTask()
      This method will set the timeoutIfPast to Zero.
    • 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