WorkflowIF (java-api 21.0.12 API)

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 Summary

Constructors
Constructor and Description

WorkflowIF()

Constructors
Constructor and Description
`WorkflowIF()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFalse(JobPlanTask task)` Adds a task to the `false` branch of this IF workflow.
`void`	`addFalse(JobPlanTask task, int pos)` Adds a task to the `false` branch of this IF workflow at the specified position.
`void`	`addTrue(JobPlanTask task)` Adds a task to the `true` branch of this IF workflow.
`void`	`addTrue(JobPlanTask task, int pos)` Adds a task to the `true` branch of this IF workflow at the specified position.
`void`	`afterSaveObject()` Called after an object is saved.
`JobPlanAttributes`	`attributes()` Returns attributes of this `JobPlan`.
`void`	`clear()` Removes all tasks from the `true` and `false` branches.
`ConditionsSet`	`condition()` Returns the condition of the IF.
`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.
`java.util.Iterator<JobPlanTask>`	`falseTasksIterator()` Returns an iterator over tasks in the `false` branch.
`JobPlanTask`	`getEndTask()` Returns the END task of an IF.
`int`	`getNumberOfFalseTasks()` Returns the number of tasks in the `false` branch.
`int`	`getNumberOfTrueTasks()` Returns the number of tasks in the `true` branch.
`java.lang.String`	`getProcess()` Returns the content of the "Process" tab.
`JobPlanTask`	`getStartTask()` Returns the Start Task of an IF.
`JobPlanTask`	`getTaskByUserDefinedID(java.lang.String id)` Returns a worfkflow task with the specified ID.
`XHeader`	`header()` Returns the header data of this object.
`boolean`	`isExecutable()` Returns `true` if this Object can be executed.
`boolean`	`removeTask(JobPlanTask task)` Removes the specified task from the `WorkFLowIF`.
`Rollback`	`rollback()` This method provides access to the rollback tab of an executable object.
`Runtime`	`runtime()` Returns runtime information of this job.
`void`	`setProcess(java.lang.String script)` Sets the content of the "Process" tab.
`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.
`SyncList`	`syncs()` Returns a `SyncList` object which contains sync conditions of this object.
`java.util.Iterator<JobPlanTask>`	`trueTasksIterator()` Returns an iterator over tasks in the `true` branch.
`void`	`update()` Update the object (i.e.
`void`	`validate()` Validates the object.
`ObjectValues`	`values()`

Methods inherited from class com.uc4.api.objects.UC4Object
docu, getAccess, getIdnr, getModCount, getName, getType, isOldVersion, load, store

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WorkflowIF
```
public WorkflowIF()
```
- Method Detail
  - 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(java.lang.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 java.lang.String getProcess()
```
    Returns the content of the "Process" tab.
    
    Returns:
    
    JCL
  - setProcess
```
public void setProcess(java.lang.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 java.io.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:
    
    java.io.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 java.util.Iterator<JobPlanTask> trueTasksIterator()
```
    Returns an iterator over tasks in the true branch.
    
    Returns:
    
    Iterator of tasks in the true branch.
  - falseTasksIterator
```
public java.util.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 java.io.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:
    
    java.io.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

Class WorkflowIF

Constructor Summary

Method Summary

Methods inherited from class com.uc4.api.objects.UC4Object

Methods inherited from class java.lang.Object

Constructor Detail

WorkflowIF

Method Detail

setTaskFactory

values

header

syncs

getTaskByUserDefinedID

runtime

getProcess

setProcess

attributes

addTrue

addTrue

removeTask

getStartTask

getEndTask

rollback

addFalse

addFalse

getNumberOfTrueTasks

getNumberOfFalseTasks

trueTasksIterator

falseTasksIterator

condition

clear

isExecutable

createWorkflowTasks

validate

update

afterSaveObject