Classes


Class actuate.data.Request

Specifies a request for retrieving data and the conditions for that request. This class provides the scope for a request by defining a target element and a range of rows. The scope of the request determines what goes into an actuate.data.ResultSet object. Functions that use request can only retrieve result sets from report elements that have an explicit bookmark.
Member of: actuate.data.

Class Summary
Constructor Attributes Constructor Name and Description
 
actuate.data.Request(bookmark, startRow, maxRows)
Constructs a Request object that other classes use to retrieve data.
Method Summary
Method Attributes Method Name and Description
 
Returns the bookmark name for this request.
 
Returns a list of column names that match the request.
 
Returns filters set for this request.
 
Returns the maximum number of rows to retrieve.
 
Returns sorters assigned to this request.
 
Returns the index of the starting row as an integer.
 
setBookmark(bookmark)
Sets the bookmark of the element from which to request values.
 
setColumns(columns)
Sets the request column names.
 
setFilters(filters)
Adds filters to a request.
 
setMaxRows(maxRows)
Sets the maximum number of rows to retrieve.
 
setSorters(sorters)
Adds sorters to a request to sort the set of data that a request provides.
 
setStartRow(startRow)
Sets the requested first row.
Class Detail
actuate.data.Request(bookmark, startRow, maxRows)
Constructs a Request object that other classes use to retrieve data.
Parameters:
{String} bookmark
A bookmark that identifies an Actuate report element. The Request object uses the bookmark to identify the report element to request information from. If null, Request uses the first bookmark. Functions that use request can only retrieve actuate.data.ResultSet objects from report elements that have an explicit bookmark.
{integer} startRow
The numerical index of the requested first row. The smallest value is 0.
{integer} maxRows
The numerical index of the requested last row. 0 indicates no limit.
Method Detail
{String} getBookmark()
Returns the bookmark name for this request. This example retrieves the bookmark set in the myRequest object :
	return myRequest.getBookmarkName( );
Returns:
{String} The bookmark assigned in the Request object's constructor or #setBookmark.

{String[ ]} getColumns()
Returns a list of column names that match the request. This example retrieves the first, third, and fifth column names from the Request object myRequest:
	function get135Columns(myRequest){
		var columns = myRequest.getColumns( );
		return columns[0];
		return columns[2];
		return columns[4];
	}
Returns:
{String[ ]} The column names.

{actuate.data.Filter[ ]} getFilters()
Returns filters set for this request.
Returns:
{actuate.data.Filter[ ]} An array of actuate.data.Filter objects.
See:
actuate.data.Filter

{integer} getMaxRows()
Returns the maximum number of rows to retrieve.
Returns:
{integer} The maximum numer of rows to retrieve. 0 indicates no limit.

{actuate.data.Sorter[ ]} getSorters()
Returns sorters assigned to this request.
Returns:
{actuate.data.Sorter[ ]} An arry of actuate.data.Sorter objects.
See:
actuate.data.Sorter

{integer} getStartRow()
Returns the index of the starting row as an integer.
Returns:
{integer} The startRow value. The first row in a column has an index of 0.

{void} setBookmark(bookmark)
Sets the bookmark of the element from which to request values. This example sets the bookmark for the myRequest object to the string myRequestStart:
	function setMyRequestBookmark(myRequest){
		myRequest.setBookmark("myRequestStart");
	}
Parameters:
{String} bookmark
A bookmark.
Returns:
{void}

{void} setColumns(columns)
Sets the request column names.
Parameters:
{String[ ]} columns
An array of strings designating the columns of requested data. Use an array for this argument, even if there is only one value.
Returns:
{void}

{void} setFilters(filters)
Adds filters to a request. Filters further refine the set of data provided by a request. Using setFilter removes the previous filters from the Request object. All of the filters set in a request are applied when the request is used.
Parameters:
{actuate.data.Filter[ ]} filters
An array of actuate.data.Filter objects or a single actuate.data.Filter object to refine the request. Use an array for this argument, even if there is only one value.
Returns:
{void}
See:
actuate.data.Filter

{void} setMaxRows(maxRows)
Sets the maximum number of rows to retrieve. This example sets the index of the last row for the myRequest request object to 50:
	myRequest.setMaxRows(50);
Parameters:
{integer} maxRows
The numerical value of the index for the last row to request. 0 indicates no limit.
Returns:
{void}

{void} setSorters(sorters)
Adds sorters to a request to sort the set of data that a request provides. Sorting the data increases the effectiveness of requests by providing the data in a relevant order. Using setSorters removes the previous sorter objects from the request object. All of the sorters set in a request are applied when the request is used.

Sorters are applied in the order that they occur in the array. For example, if the first sorter specifies sorting on a state column and the second sorter specifies sorting on a city column, the result set is sorted by city within each state. This example sets the alphaNumericSorterSet array in myRequest:
	myRequest.setSorters(alphaNumericSorterSet);
Parameters:
{actuate.data.Sorter[ ]} sorters
An array of actuate.data.Sorter objects or a single actuate.data.Sorter object to sort the result of the request. Use an array for this argument, even if there is only one value.
Returns:
{void}
See:
actuate.data.Sorter

{void} setStartRow(startRow)
Sets the requested first row. This example sets the index of the first row for the myRequest request object to 10:
	myRequest.setStartRow(10);
Parameters:
{integer} startRow
The numerical value of the index for the first row to request. The first row in a column has an index of 0.
Returns:
{void}

Documentation generated by JsDoc Toolkit 2.0.1 on Tue Jan 29 2013 05:44:21 GMT-0800 (PST)