com.appiancorp.suiteapi.common

Class ResultPage

java.lang.Object

com.appiancorp.suiteapi.common.Result

com.appiancorp.suiteapi.common.ResultPage

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ReportResultPage

public class ResultPage
extends Result

Class for storing the results returned by a paging service call. The results returned by the call can be accessed using the Result.getResults() method of the Result base class. Since paging methods may return only a subset of all the results getAvailableItems() can be used to get the total number of results available on the server.

See Also:

Result, ResultList, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResultPage()

Method Summary

Modifier and Type	Method and Description
void	addResults(java.lang.Object[] results_) Add results to the result page.
long	getAvailableItems() Returns the total number of items available on the server (as opposed to the number of items actually returned by the service call and stored in the result page, which may be different when using a paging method and specifying a batch size that is less than the total number of results on the server).
java.lang.Integer[]	getCodesForFailedIds() Returns the codes for why the requested objects that were not returned from the server couldn't be returned.
java.lang.Long[]	getFailedIds() Returns the ids of any objects requested but not returned from the server.
java.lang.Object	getParent() Returns the parent object of the results (for instance, if getting a page of members of a group, this field might be populated with the group ID).
void	setAvailableItems(long availableItems_) See getAvailableItems().
void	setCodesForFailedIds(java.lang.Integer[] codesForFailedIds_) See getCodesForFailedIds().
void	setFailedIds(java.lang.Long[] failedIds_) See getFailedIds().
void	setParent(java.lang.Object object_) See getParent().
java.lang.String	toString() Returns the ResultPage and its array of results as a string.

Methods inherited from class com.appiancorp.suiteapi.common.Result

getNumResults, getResults, setResults

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ResultPage

public ResultPage()

Method Detail

toString

public java.lang.String toString()

Returns the ResultPage and its array of results as a string.

Overrides:

toString in class Result

getAvailableItems

public long getAvailableItems()

Returns the total number of items available on the server (as opposed to the number of items actually returned by the service call and stored in the result page, which may be different when using a paging method and specifying a batch size that is less than the total number of results on the server).

Returns:

The total number of items available on the server.

See Also:

setAvailableItems(long)

setAvailableItems

public void setAvailableItems(long availableItems_)

See getAvailableItems().

Parameters:

availableItems_ - The number of available items.

See Also:

getAvailableItems()

addResults

public void addResults(java.lang.Object[] results_)

Add results to the result page.

Parameters:

results_ - The objects to add to the result page.

getFailedIds

public java.lang.Long[] getFailedIds()

Returns the ids of any objects requested but not returned from the server. The corresponding array of error codes for why the objects couldn't be returned is accessible through getCodesForFailedIds().

Returns:

The ids of any objects requested but not returned from the server.

See Also:

setFailedIds(Long[])

setFailedIds

public void setFailedIds(java.lang.Long[] failedIds_)

See getFailedIds().

Parameters:

failedIds_ - An array of failed ids.

See Also:

getFailedIds()

getCodesForFailedIds

public java.lang.Integer[] getCodesForFailedIds()

Returns the codes for why the requested objects that were not returned from the server couldn't be returned. The corresponding array of ids of the requested objects that weren't returned is accessible through getFailedIds().

Returns:

The codes for why the requested objects that were not returned from the server couldn't be returned.

See Also:

setCodesForFailedIds(Integer[])

setCodesForFailedIds

public void setCodesForFailedIds(java.lang.Integer[] codesForFailedIds_)

See getCodesForFailedIds().

Parameters:

codesForFailedIds_ - The codes for why the requested objects that were not returned from the server couldn't be returned.

See Also:

getCodesForFailedIds()

getParent

public java.lang.Object getParent()

Returns the parent object of the results (for instance, if getting a page of members of a group, this field might be populated with the group ID). This field never populated by the backend, and is only populated in select instances by Java.

Returns:

The parent object of the results.

See Also:

setParent(Object)

setParent

public void setParent(java.lang.Object object_)

See getParent().

Parameters:

object_ - The parent object of the results

See Also:

getParent()