Classes


Class actuate.data.Request

The Request class is used to specify the conditions used to retrieve data.
Member of: actuate.data.

Class Summary
Constructor Attributes Constructor Name and Description
 
actuate.data.Request(bookmark, startRow, maxRows)
The Request class is used to specify the conditions used to retrieve data.
Method Summary
Method Attributes Method Name and Description
 
Returns the bookmark of the element from which to request values.
 
Returns the requested column names.
 
Returns the filter conditions of this request.
 
Returns the maximum number of rows to retrieve.
 
Returns the sorting conditions of this request.
 
Returns start row index.
 
setBookmark(bookmark)
Sets the bookmark of the element from which to request values.
 
setColumns(columns)
Sets the requested column names.
 
setFilters(filters)
Sets the filter conditions of this request.
 
setMaxRows(maxRows)
Sets the maximum number of rows to retrieve.
 
setSorters(sorters)
Sets the sorting conditions of this request.
 
setStartRow(startRow)
Sets start row index.
Class Detail
actuate.data.Request(bookmark, startRow, maxRows)
The Request class is used to specify the conditions used to retrieve data.
Parameters:
{String} bookmark
bookmark name of the element from which to request values.
{int} startRow
starting row (first one is 1)
{int} maxRows
maximum number of rows to retrieve or 0 for no limit
Method Detail
{String} getBookmark()
Returns the bookmark of the element from which to request values.
Returns:
{String} bookmark

{Array} getColumns()
Returns the requested column names.
Returns:
{Array} array of column names

{Array} getFilters()
Returns the filter conditions of this request.
Returns:
{Array} array of actuate.data.Filter objects
See:
actuate.data.Filter

{int} getMaxRows()
Returns the maximum number of rows to retrieve. 0 means no limit.
Returns:
{int} maxRows maximum number of rows to retrieve

{Array} getSorts()
Returns the sorting conditions of this request.
Returns:
{Array} sorters arrao of actuate.data.Sorter objects
See:
actuate.data.Sorter

{int} getStartRow()
Returns start row index. The first row has index 0.
Returns:
{int} startRow

setBookmark(bookmark)
Sets the bookmark of the element from which to request values.
Parameters:
{String} bookmark
bookmark name

setColumns(columns)
Sets the requested column names.
Parameters:
{Array} columns
array of column names

setFilters(filters)
Sets the filter conditions of this request.
Parameters:
{Array} filters
array of actuate.data.Filter objects
See:
actuate.data.Filter

setMaxRows(maxRows)
Sets the maximum number of rows to retrieve. 0 means no limit.
Parameters:
{int} maxRows
maximum number of rows to retrieve

setSorters(sorters)
Sets the sorting conditions of this request.
Parameters:
{Array} sorters
array of actuate.data.Sorter objects
See:
actuate.data.Sorter

setStartRow(startRow)
Sets start row index. The first row has index 0.
Parameters:
{int} startRow

Documentation generated by JsDoc Toolkit 2.0.1 on Tue Jan 19 2010 15:56:27 GMT-0800 (PST)