Class actuate.reportexplorer.FolderItems

Description

FolderItems is a container for the contents of a folder.

Constructor

Syntax

actuate.reportexplorer.FolderItems( )

Constructs a new FolderItems object.

Function summary

Table 4-38 lists actuate.reportexplorer.FolderItems functions.

Table 4-38  actuate.reportexplorer.FolderItems functions 

Function	Description
getFetchHandle( )	Gets the fetchHandle value for GetFolderItemsResponse.
getItemList( )	Gets the itemList value for GetFolderItemsResponse.
getTotalCount( )	Gets the totalCount value for GetFolderItemsResponse.
setFetchHandle( )	Sets the fetchHandle value for GetFolderItemsResponse.
setItemList( )	Sets the itemList value for GetFolderItemsResponse.
setTotalCount( )	Sets the totalCount value for GetFolderItemsResponse.

actuate.reportexplorer.FolderItems.getFetchHandle

Syntax

string FolderItems.getFetchHandle( )

Retrieves the fetch handle for this folder’s contents.

Returns

String. The fetch handle.

Example

To retrieve the fetch handle from fitems, use code similar to the following:

var handle = fitems.getFetchHandle( );

actuate.reportexplorer.FolderItems.getItemList

Syntax

actuate.reportexplorer.File[ ] FolderItems.getItemList( )

Gets the list of file contents for the folder.

Returns

Array of actuate.reportexplorer.File objects.

Example

To store ftiems’ item list the files variable, use code similar to the following:

files = fitems.getItemList( );

actuate.reportexplorer.FolderItems.getTotalCount

Syntax

string FolderItems.getTotalCount( )

Returns the total count.

Returns

String. the total count.

Example

To retrieve the total count from fitems, use code similar to the following:

var count = fitems.getTotalCount( );

actuate.reportexplorer.FolderItems.setFetchHandle

Syntax

void FolderItems.setFetchHandle(string fetchHandle)

Sets the fetch handle value for this FolderItems object.

Parameters

fetchHandle

String.

Example

To set FolderItem fitems’s fetch handle to dir, use code similar to the following:

fitems.setFetchHandle("dir");

actuate.reportexplorer.FolderItems.setItemList

Syntax

void FolderItems.setItemList(ctuate.reportexplorer.File[ ] itemList)

Sets the list of contents for this Folder.

Parameters

itemList

Array of actuate.reportexplorer.File objects.

Example

To assign the item list from fitems1 to fitems2, use code similar to the following:

fitems2.setItemList(fitems1.getItemList( ));

actuate.reportexplorer.FolderItems.setTotalCount

Syntax

void FolderItems.setDataType(string totalCount)

Sets the total count of items contained in the folder.

Parameters

totalCount

String.

Example

To reset the count total for fitems, use code similar to the following:

fitems.setTotalCount("0");

(c) Copyright Actuate Corporation 2011