FileResultset Class Reference

The FileResultset class supports basic functions to loop through a list of DocFile objects. More...

Public Member Functions
FileResultset	FileResultset (String fileType, String filter="", String sortOrder="")
	Create a new FileResultset object. More...
DocFile	first ()
	Retrieve the first DocFile object in the FileResultset. More...
string []	getIds ()
	Returns an array with all file ids in the FileResultset. More...
DocFile	last ()
	Retrieve the last DocFile object in the FileResultset. More...
DocFile	next ()
	Retrieve the next DocFile object in the FileResultset. More...
int	size ()
	Get the amount of DocFile objects in the FileResultset. More...

Detailed Description

The FileResultset class supports basic functions to loop through a list of DocFile objects.

You can manually create a FileResultset as well as access the (selected) files of a (public) Folder.

Constructor & Destructor Documentation

FileResultset()

FileResultset FileResultset::FileResultset	(	String	fileType,
		String	filter = "",
		String	sortOrder = ""
	)

Create a new FileResultset object.

Like in other programming languages you create a new object with the new operator (refer to example below).

Parameters

fileType	String containing the technical name of the desired filetype
filter	String containing an optional filter criterium; use empty String ('') if you don't want to filter at all
sortOrder	String containing an optional sort order; use empty String ('') if you don't want to sort at all

Returns

FileResultset representing a list of all matching DocFile objects in the system

Since

ELC 3.50 / otrisPORTAL 5.0

Example:

var fileType = "Standard";
var filter = "";
var sortOrder = "";
var myFRS = new FileResultset(fileType, filter, sortOrder);

Note

Details for the filter expression you find in section Filter Expressions

Further samples are in Filter Expression Examples

Member Function Documentation

first()

DocFile FileResultset::first

(

)

Retrieve the first DocFile object in the FileResultset.

Returns

DocFile or null in case of an empty FileResultset

Since

ELC 3.50 / otrisPORTAL 5.0

Example:

var myFRS = new FileResultset("Standard", "", "");
var myFile = myFRS.first();

getIds()

string [] FileResultset::getIds

(

)

Returns an array with all file ids in the FileResultset.

Returns

Array of String with file ids of the FileResultset

Since

DOCUMENTS 5.0c

Example:

var myFRS = new FileResultset("Standard", "", "");
util.out(myFRS.getIds());

last()

DocFile FileResultset::last

(

)

Retrieve the last DocFile object in the FileResultset.

Returns

DocFile or null if end of FileResultset is reached.

Since

ELC 3.60j / otrisPORTAL 6.0j

next()

DocFile FileResultset::next

(

)

Retrieve the next DocFile object in the FileResultset.

Returns

DocFile or null if end of FileResultset is reached.

Since

ELC 3.50 / otrisPORTAL 5.0

Example:

var myFRS = new FileResultset("Standard", "", "");
for (var myFile = myFRS.first(); myFile; myFile = myFRS.next())
{
   // do something with each DocFile object
}

size()

int FileResultset::size

(

)

Get the amount of DocFile objects in the FileResultset.

Returns

integer value with the amount of DocFile objects in the FileResultset

Since

ELC 3.50 / otrisPORTAL 5.0

Example:

var myFRS = new FileResultset("Standard", "", "");
util.out(myFRS.size());