The RegisterIterator class has been added to the DOCUMENTS PortalScripting API to gain full access to the registers of a DOCUMENTS file by scripting means. More...

Public Member Functions
Register	first ()
	Retrieve the first Register object in the RegisterIterator. More...

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

Register	next ()
	Retrieve the next Register object in the RegisterIterator. More...

int	size ()
	Get the amount of Register objects in the RegisterIterator. More...

Detailed Description

The RegisterIterator class has been added to the DOCUMENTS PortalScripting API to gain full access to the registers of a DOCUMENTS file by scripting means.

Since: ELC 3.50n / otrisPORTAL 5.0n; ELC 3.60i / otrisPORTAL 6.0i available for archive files

Example:: var docFile = context.file;
if (docFile)
{
var docregs = docFile.getRegisters("documents");
if (docregs && docregs.size() > 0)
{
for (var d = docregs.first(); d; d = docregs.next())
{
util.out(d.Name + ", " + d.Label);
}
}
}

Member Function Documentation

◆ first()

Register RegisterIterator::first ( )

Retrieve the first Register object in the RegisterIterator.

Returns: Register or null in case of an empty RegisterIterator

Since: ELC 3.50n / otrisPORTAL 5.0n; ELC 3.60i / otrisPORTAL 6.0i available for archive files

◆ getLastError()

String RegisterIterator::getLastError ( )

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

Returns: Text of the last error as String

Since: ELC 3.50n / otrisPORTAL 5.0n

See also: DocFile.getLastError()

Since: ELC 3.60i / otrisPORTAL 6.0i available for archive files

◆ next()

Register RegisterIterator::next ( )

Retrieve the next Register object in the RegisterIterator.

Returns: Register or null if end of RegisterIterator is reached.

Since: ELC 3.50n / otrisPORTAL 5.0n; ELC 3.60i / otrisPORTAL 6.0i available for archive files

◆ size()

int RegisterIterator::size ( )

Get the amount of Register objects in the RegisterIterator.

Returns: integer value with the amount of Register objects in the RegisterIterator