Class actuate.reportexplorer.FolderItems
Description
A container for the contents of a folder. FolderItems represents a JavaScript version of com.actuate.schemas.GetFolderItemsResponse.
Constructor
Syntax
actuate.reportexplorer.FolderItems( )
Constructs a new FolderItems object.
Function summary
Table 44‑44 lists actuate.reportexplorer.FolderItems functions.
Table 44‑44 actuate.reportexplorer.FolderItems functions
Function | Description |
| Gets the fetchHandle value for GetFolderItemsResponse |
| Gets the itemList value for GetFolderItemsResponse |
| Gets the totalCount value for GetFolderItemsResponse |
| Sets the fetchHandle value for GetFolderItemsResponse |
| Sets the itemList value for GetFolderItemsResponse |
| Sets the totalCount value for GetFolderItemsResponse |
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( );
getItemList
Syntax
actuate.reportexplorer.File[ ] FolderItems.getItemList( )
Gets the list of file contents for the folder.
Returns
Array of actuate.reportexplorer.File objects. A list of the folder contents.
Example
To store the fitems item list in the files variable, use code similar to the following:
files = fitems.getItemList( );
getTotalCount
Syntax
string FolderItems.getTotalCount( )
Returns the maximum number of list items to retrieve from this folder.
Returns
String. The total count.
Example
To retrieve the total count from fitems, use code similar to the following:
var count = fitems.getTotalCount( );
setFetchHandle
Syntax
void FolderItems.setFetchHandle(string fetchHandle)
Sets the fetch handle value for this FolderItems object.
Parameter
fetchHandle
String. The fetch handle.
Example
To set the FolderItems fitems fetch handle to dir, use code similar to the following:
fitems.setFetchHandle("dir");
setItemList
Syntax
void FolderItems.setItemList(ctuate.reportexplorer.File[ ] itemList)
Sets the list of contents for this folder.
Parameter
itemList
Array of actuate.reportexplorer.File objects. A list of the folder contents.
Example
To assign the item list from fitems1 to fitems2, use code similar to the following:
fitems2.setItemList(fitems1.getItemList( ));
setTotalCount
Syntax
void FolderItems.setDataType(string totalCount)
Sets the maximum number of list items to retrieve from this folder.
Parameter
totalCount
String. The total count.
Example
To reset the count total for fitems, use code similar to the following:
fitems.setTotalCount("0");