ControlFlow Class Reference

The ControlFlow 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
String	getAttribute (String attribute)
	Get the String value of an attribute of the ControlFlow. More...
String	getLastError ()
	Function to get the description of the last error that occurred. More...
boolean	setAttribute (String attribute, String value)
	Set the String value of an attribute of the ControlFlow to the desired value. More...

Public Attributes
String	id
	String value containing the unique internal ID of the ControlFlow. More...
String	label
	String value containing the ergonomic label of the ControlFlow. More...
String	name
	String value containing the technical name of the ControlFlow. More...

Detailed Description

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

You may access ControlFlow objects of a certain WorkflowStep by the different methods described in the WorkflowStep chapter. The objects of this class reflect only 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

getAttribute()

String ControlFlow::getAttribute

(

String

attribute

)

Get the String value of an attribute of the ControlFlow.

Parameters

attribute

String containing the name of the desired attribute

Returns

String containing the value of the desired attribute

Note

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

Since

ELC 3.51e / otrisPORTAL 5.1e

getLastError()

String ControlFlow::getLastError

(

)

Function to get the description of the last error that occurred.

Returns

Text of the last error as String

Note

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

Since

ELC 3.51e / otrisPORTAL 5.1e

See also

DocFile.getLastError()

setAttribute()

boolean ControlFlow::setAttribute	(	String	attribute,
		String	value
	)

Set the String value of an attribute of the ControlFlow to the desired value.

Parameters

attribute	String containing the name of the desired attribute
value	String containing the desired value of the attribute

Returns

true if successful, false in case of any error

Note

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

Since

ELC 3.51e / otrisPORTAL 5.1e

Member Data Documentation

id

String ControlFlow::id

String value containing the unique internal ID of the ControlFlow.

Returns

String value containing the unique ControlFlow ID.

Note

This property requires a full workflow engine license, it does not work with pure submission lists. The property is readonly.

Since

ELC 3.51e / otrisPORTAL 5.1e

label

String ControlFlow::label

String value containing the ergonomic label of the ControlFlow.

This is usually the label of the according button in the web surface.

Returns

String value containing the ControlFlow's ergonomic label.

Note

This property requires a full workflow engine license, it does not work with pure submission lists. The property is readonly.

Since

ELC 3.51e / otrisPORTAL 5.1e

name

String ControlFlow::name

String value containing the technical name of the ControlFlow.

Returns

String value containing the ControlFlow's technical name.

Note

This property requires a full workflow engine license, it does not work with pure submission lists. The property is readonly.

Since

ELC 3.51e / otrisPORTAL 5.1e