Package com.uc4.communication.requests

Class GetExecuteOnce

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.GetExecuteOnce
public class GetExecuteOnce extends XMLRequest
Reads the settings of a task that is or will be started with "Execute - Once..."

  • Constructor Details

    • GetExecuteOnce

      public GetExecuteOnce(UC4ObjectName name)
      Reads the default settings for a task that will be scheduled.
      Parameters:
      name - Name of the object

    • GetExecuteOnce

      public GetExecuteOnce(int runID)
      Reads the settings of a task which has already been started.
      Parameters:
      runID - RunID of the task, must not be zero

  • Method Details

    • 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

    • 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

    • 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

    • 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

    • getQueue

      public UC4ObjectName getQueue()
      Returns the name of the queue object where the task runs.
      Returns:
      Queue, never null

    • getAlias

      public UC4Alias getAlias()
      Returns the alias of the object or an empty instance if not set.
      Returns:
      Alias, never null

    • isWaitForManualRelease

      public boolean isWaitForManualRelease()
      Returns true if the task waits a for manual release.
      Returns:
      Manual release

    • getTimezone

      public UC4TimezoneName getTimezone()
      Returns:
      Name of the timezone object

    • isUseLogicalDate

      public boolean isUseLogicalDate()
      Returns:
      true if a logical date is used, false if not

    • getLogicalDateTime

      public DateTime getLogicalDateTime()
      Returns:
      DateTime object of the logical date.

    • getExecutionDateTime

      public DateTime getExecutionDateTime()
      Returns the scheduled start time if the task does not start immediately.
      Returns:
      Scheduled start time

    • isImmediately

      public boolean isImmediately()
      Returns:
      true if the task starts immediately, false if it has a start time.

    • getTestOptions

      public ExecuteTestOptions getTestOptions()
      Returns the TestOptions which are used when restarting the task or null if the TestOptions are not set.
      Returns:
      TestOptions

    • isExecuteAt

      public boolean isExecuteAt()
      Returns:
      true if the task starts immediately, false if it has a start time.