Package com.uc4.api.objects

Class MaxParallel

java.lang.Object
com.uc4.api.objects.MaxParallel
public class MaxParallel extends Object
This class contains information about the maximum number of parallel tasks. MaxParallel is part of the attributes tab for all executeable objects.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    MaxParallel(com.uc4.util.XMLDocument doc, Element attr)
    Constructs a MaxParallel from specified parameters.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    int
    getParallelTasks()
    Returns the maximum number of paralle tasks.
    int
    hashCode()
     
    boolean
    isCancel()
    Returns true if objects should be canceled when maximum number of parallel tasks is exceeded.
    protected boolean
    isDirty()
     
    void
    setCancel(boolean cancel)
    Sets the handling of the Object if execution exceeds the maximum number of tasks set to run parallel.
    void
    setParallelTasks(int parallelTasks)
    Setting which defines the maximum number of parallel executions for this Job.
    protected void
    store(com.uc4.util.XMLDocument doc, Element attr)
    Stores the content of this object under the attr element.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • MaxParallel

      protected MaxParallel(com.uc4.util.XMLDocument doc, Element attr)
      Constructs a MaxParallel from specified parameters.
      Parameters:
      doc - XML Document
      attr - attribut element

  • Method Details

    • isDirty

      protected boolean isDirty()

    • isCancel

      public boolean isCancel()
      Returns true if objects should be canceled when maximum number of parallel tasks is exceeded.
      Returns:
      State of the cancel checkbox

    • setCancel

      public void setCancel(boolean cancel)
      Sets the handling of the Object if execution exceeds the maximum number of tasks set to run parallel. if cancel is set to true additional Automation Engine Objects are canceled with status FAULT_ALREADY_RUNNING - task is already running. if cancel is set to false additional Automation Engine Objects will wait until execution is possible.
      Parameters:
      cancel - Cancel

    • getParallelTasks

      public int getParallelTasks()
      Returns the maximum number of paralle tasks.
      Returns:
      parallel tasks

    • setParallelTasks

      public void setParallelTasks(int parallelTasks)
      Setting which defines the maximum number of parallel executions for this Job.

      Permitted values: 0 to 99999
      Default: 0 (no limit on tasks running parallel)

      Parameters:
      parallelTasks - max parallel tasks

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element attr)
      Stores the content of this object under the attr element.
      Parameters:
      doc - XML Document
      attr - attributes