WorkflowStepIterator Class Reference

The WorkflowStepIterator 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
WorkflowStep	first ()
	Retrieve the first WorkflowStep object in the WorkflowStepIterator. More...
WorkflowStep	next ()
	Retrieve the next WorkflowStep object in the WorkflowStepIterator. More...
int	size ()
	Get the amount of WorkflowStep objects in the WorkflowStepIterator. More...

Detailed Description

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

You may access WorkflowStepIterator objects by the getAllLockingWorkflowSteps() method described in the DocFile chapter.

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()

WorkflowStep WorkflowStepIterator::first

(

)

Retrieve the first WorkflowStep object in the WorkflowStepIterator.

Returns

WorkflowStep or null in case of an empty WorkflowStepIterator

Since

ELC 3.51e / otrisPORTAL 5.1e

next()

WorkflowStep WorkflowStepIterator::next

(

)

Retrieve the next WorkflowStep object in the WorkflowStepIterator.

Returns

WorkflowStep or null if end of WorkflowStepIterator is reached.

Since

ELC 3.51e / otrisPORTAL 5.1e

size()

int WorkflowStepIterator::size

(

)

Get the amount of WorkflowStep objects in the WorkflowStepIterator.

Returns

integer value with the amount of WorkflowStep objects in the WorkflowStepIterator

Since

ELC 3.51e / otrisPORTAL 5.1e