Class GetRestartInformation

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

public class GetRestartInformation extends XMLRequest
Returns restart information of the specified task.
  • Constructor Details

    • GetRestartInformation

      public GetRestartInformation(int runID)
      Creates a new GetRestartInformation request.
      Parameters:
      runID - RunID of the task
    • GetRestartInformation

      public GetRestartInformation(UC4Object obj)
      Creates a new GetRestartInformation request.
      Parameters:
      obj - UC4 Object
    • GetRestartInformation

      public GetRestartInformation(UC4ObjectName uc4ObjectName)
      Creates a new GetRestartInformation request.
      Parameters:
      uc4ObjectName - name of the Object.
  • 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
    • 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
    • getReferenceRunID

      public int getReferenceRunID()
      Returns the original RunID of the task. This RunID must be used for a restart.
      Returns:
      RunID of the original execution
    • getLastRestartPoint

      public String getLastRestartPoint()
      Returns the last restart point.
      Returns:
      Last restart point
    • isKeepStartType

      public boolean isKeepStartType()
      Returns the Keep Start Type.
      Returns:
      Keep Start Type
    • isWaitForRelease

      public boolean isWaitForRelease()
      Returns the wait For Release.
      Returns:
      Wait for Release
    • isAbortedOnly

      public boolean isAbortedOnly()
      Returns the Aborted Only.
      Returns:
      aborted Only
    • getQueue

      public String getQueue()
      Returns Queue Name.
      Returns:
      the Queue Name
    • getExecuteTestOption

      public ExecuteTestOptions getExecuteTestOption()
      Returns Execute Test Options.
      Returns:
      the execute Test option
    • getFileTransferSetting

      public RestartTask.FileTransferRestart getFileTransferSetting()
      Returns File Transfer Restart.
      Returns:
      the file Transfer Restart