Package com.uc4.api.objects

Class WorkflowIF

java.lang.Object
com.uc4.api.objects.UC4Object
com.uc4.api.objects.WorkflowIF
All Implemented Interfaces:
LifecycleSaveAware, WorkflowInterfaces.IUpdatable
public class WorkflowIF extends UC4Object implements WorkflowInterfaces.IUpdatable, LifecycleSaveAware
This class represents an IF in a ProcessFlow.

  • Constructor Details

    • WorkflowIF

      public WorkflowIF()

  • Method Details

    • setTaskFactory

      protected void setTaskFactory(WorkFlowTaskFactory taskFactory)
      Sub classes may call this method in order to provide their own sub class of JobPlanTask which may contain additional features.
      Parameters:
      taskFactory - Task Factory

    • values

      public ObjectValues values()
      Returns:
      Variables of this object

    • header

      public XHeader header()
      Returns the header data of this object. This is the information of the header tab in the dialog client.
      Returns:
      header

    • syncs

      public SyncList syncs()
      Returns a SyncList object which contains sync conditions of this object.
      Returns:
      sync conditions

    • getTaskByUserDefinedID

      public JobPlanTask getTaskByUserDefinedID(String id)
      Returns a worfkflow task with the specified ID.
      Parameters:
      id - ID of the task
      Returns:
      Task or null if not found

    • runtime

      public Runtime runtime()
      Returns runtime information of this job. This corresponds to the "Runtime" tab in the dialog client.
      Returns:
      Runtime information

    • getProcess

      public String getProcess()
      Returns the content of the "Process" tab.
      Returns:
      JCL

    • setProcess

      public void setProcess(String script)
      Sets the content of the "Process" tab.
      Parameters:
      script - Script

    • attributes

      public JobPlanAttributes attributes()
      Returns attributes of this JobPlan.
      Returns:
      JobPlan attributes

    • addTrue

      public void addTrue(JobPlanTask task)
      Adds a task to the true branch of this IF workflow.
      Parameters:
      task - JobPlanTask to add

    • addTrue

      public void addTrue(JobPlanTask task, int pos)
      Adds a task to the true branch of this IF workflow at the specified position.
      Parameters:
      task - JobPlanTask to add
      pos - Position where the task should be added

    • removeTask

      public boolean removeTask(JobPlanTask task) throws InvalidObjectException
      Removes the specified task from the WorkFLowIF.
      Parameters:
      task - WorkFLowIF task which should be removed
      Returns:
      True if the task was removed successfully
      Throws:
      InvalidObjectException - If the object is not valid

    • getStartTask

      public JobPlanTask getStartTask()
      Returns the Start Task of an IF.
      Returns:
      Start task

    • getEndTask

      public JobPlanTask getEndTask()
      Returns the END task of an IF.
      Returns:
      End task

    • rollback

      public Rollback rollback()
      This method provides access to the rollback tab of an executable object.
      Returns:
      Rollback settings

    • addFalse

      public void addFalse(JobPlanTask task)
      Adds a task to the false branch of this IF workflow.
      Parameters:
      task - JobPlanTask to add

    • addFalse

      public void addFalse(JobPlanTask task, int pos)
      Adds a task to the false branch of this IF workflow at the specified position.
      Parameters:
      task - JobPlanTask to add
      pos - Position where the task should be added

    • getNumberOfTrueTasks

      public int getNumberOfTrueTasks()
      Returns the number of tasks in the true branch.
      Returns:
      Number of tasks which are executed when the condition is true

    • getNumberOfFalseTasks

      public int getNumberOfFalseTasks()
      Returns the number of tasks in the false branch.
      Returns:
      Number of tasks which are executed when the condition is false

    • trueTasksIterator

      public Iterator<JobPlanTask> trueTasksIterator()
      Returns an iterator over tasks in the true branch.
      Returns:
      Iterator of tasks in the true branch.

    • falseTasksIterator

      public Iterator<JobPlanTask> falseTasksIterator()
      Returns an iterator over tasks in the false branch.
      Returns:
      Iterator of tasks in the false branch.

    • condition

      public ConditionsSet condition()
      Returns the condition of the IF.
      Returns:
      IF condition

    • clear

      public void clear()
      Removes all tasks from the true and false branches.

    • isExecutable

      public boolean isExecutable()
      Description copied from class: UC4Object
      Returns true if this Object can be executed.
      Specified by:
      isExecutable in class UC4Object
      Returns:
      true if the Object can be executed, false if not.

    • createWorkflowTasks

      protected com.uc4.api.objects.WorkflowTasks createWorkflowTasks(com.uc4.util.XMLDocument doc, ConnectionAttributes info)
      Creates a WorkflowTasks object which holds the tasks of a workflow. Sub classes may override this method.
      Parameters:
      doc - XML Document
      info - Connection attributes
      Returns:
      WorklfowTasks

    • validate

      public void validate() throws InvalidObjectException
      Description copied from class: UC4Object
      Validates the object. If the object is not valid an InvalidObjectException is thrown.
      Overrides:
      validate in class UC4Object
      Throws:
      InvalidObjectException - If the object is not valid

    • update

      public void update()
      Description copied from interface: WorkflowInterfaces.IUpdatable
      Update the object (i.e. recalculate internal properties, sort tasks, ...)
      Specified by:
      update in interface WorkflowInterfaces.IUpdatable

    • afterSaveObject

      public void afterSaveObject()
      Description copied from interface: LifecycleSaveAware
      Called after an object is saved.
      Specified by:
      afterSaveObject in interface LifecycleSaveAware