Class ModifyProcessFlowMonitor

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

public class ModifyProcessFlowMonitor extends XMLRequest
Adds a task or changes an existing task in a ProcessFlow monitor which is opened for modification. After this request has been executed an updated ProcessFlow monitor can be retrieved using the method getMonitor().
  • Constructor Details

    • ModifyProcessFlowMonitor

      public ModifyProcessFlowMonitor(JobPlanMonitor monitor, JobPlanTask add)
      Adds a task to a ProcessFlow. The added task has no successor or predecessor. The dependencies must be set in a second step using the other constructor of this class.
      Parameters:
      monitor - ProcessFlow monitor
      add - Task which should be added.
    • ModifyProcessFlowMonitor

      public ModifyProcessFlowMonitor(JobPlanMonitor monitor, JobPlanMonitor.Task mod)
      Modifies an existing task in the ProcessFlow monitor.
      Parameters:
      monitor - ProcessFlow monitor
      mod - Modified task
    • ModifyProcessFlowMonitor

      public ModifyProcessFlowMonitor(JobPlanMonitor monitor, JobPlanMonitor.Task mod, JobPlanMonitor.Task dep)
      Removes a dependency of a task in the ProcessFlow monitor.
      Parameters:
      monitor - ProcessFlow monitor
      mod - Modified task
      dep - Dependency to remove
  • 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
    • getMonitor

      public JobPlanMonitor getMonitor()
      Returns an updated ProcessFlow monitor after this request has been executed. In case of an error or if this request has not been set the return value is null.
      Returns:
      ProcessFlow monitor if successfully executed, otherwise null