The SystemUserIterator class has been added to the DOCUMENTS PortalScripting API to gain full access to the DOCUMENTS users by scripting means. More...

Public Member Functions
SystemUser	first ()
	Retrieve the first SystemUser object in the SystemUserIterator. More...

String	getLastError ()
	Function to get the description of the last error that occurred. More...

SystemUser	next ()
	Retrieve the next SystemUser object in the SystemUserIterator. More...

int	size ()
	Get the amount of SystemUser objects in the SystemUserIterator. More...

Detailed Description

The SystemUserIterator class has been added to the DOCUMENTS PortalScripting API to gain full access to the DOCUMENTS users by scripting means.

The objects of this class represent lists of Systemuser objects and allow to loop through such a list of users.

Since: ELC 3.50b / otrisPORTAL 5.0b

Member Function Documentation

◆ first()

SystemUser SystemUserIterator::first ( )

Retrieve the first SystemUser object in the SystemUserIterator.

Returns: SystemUser or null in case of an empty SystemUserIterator

Since: ELC 3.50b / otrisPORTAL 5.0b

◆ getLastError()

String SystemUserIterator::getLastError ( )

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

Returns: Text of the last error as String

Since: ELC 3.50b / otrisPORTAL 5.0b

See also: DocFile.getLastError()

◆ next()

SystemUser SystemUserIterator::next ( )

Retrieve the next SystemUser object in the SystemUserIterator.

Returns: SystemUser or null if end of SystemUserIterator is reached.

Since: ELC 3.50b / otrisPORTAL 5.0b

◆ size()

int SystemUserIterator::size ( )

Get the amount of SystemUser objects in the SystemUserIterator.

Returns: integer value with the amount of SystemUser objects in the SystemUserIterator