ControlFlowIterator Class Reference

The ControlFlowIterator class has been added to the DOCUMENTS PortalScripting API to gain full control over a file's workflow by scripting means. More...

Public Member Functions
ControlFlow	first ()
	Retrieve the first ControlFlow object in the ControlFlowIterator. More...
ControlFlow	next ()
	Retrieve the next ControlFlow object in the ControlFlowIterator. More...
int	size ()
	Get the amount of ControlFlow objects in the ControlFlowIterator. More...

Detailed Description

The ControlFlowIterator class has been added to the DOCUMENTS PortalScripting API to gain full control over a file's workflow by scripting means.

You may access ControlFlowIterator objects of a certain WorkflowStep by the different methods described in the WorkflowStep chapter. The objects of this class reflect a list of outgoing control flows of a WorkflowStep object.

Note

This class and all of its methods and attributes require a full workflow engine license, it does not work with pure submission lists.

Since

ELC 3.51e / otrisPORTAL 5.1e

Member Function Documentation

first()

ControlFlow ControlFlowIterator::first

(

)

Retrieve the first ControlFlow object in the ControlFlowIterator.

Returns

ControlFlow or null in case of an empty ControlFlowIterator

Note

This function requires a full workflow engine license, it does not work with pure submission lists.

Since

ELC 3.51e / otrisPORTAL 5.1e

next()

ControlFlow ControlFlowIterator::next

(

)

Retrieve the next ControlFlow object in the ControlFlowIterator.

Returns

ControlFlow or null if end of ControlFlowIterator is reached.

Note

This function requires a full workflow engine license, it does not work with pure submission lists.

Since

ELC 3.51e / otrisPORTAL 5.1e

size()

int ControlFlowIterator::size

(

)

Get the amount of ControlFlow objects in the ControlFlowIterator.

Returns

integer value with the amount of ControlFlow objects in the ControlFlowIterator

Note

This function requires a full workflow engine license, it does not work with pure submission lists.

Since

ELC 3.51e / otrisPORTAL 5.1e