Package com.appiancorp.suiteapi.common

Class Result

java.lang.Object

com.appiancorp.suiteapi.common.Result

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ResultList, ResultPage

public class Result
extends Object
implements Serializable

Base class for storing the results returned by a service call.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Result()

Method Summary

Modifier and Type	Method	Description
int	getNumResults()	Gets the number of results available.
Object[]	getResults()	Returns the results as an array of Objects.
void	setResults(Object[] results_)	See getResults().
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Result

public Result()

Method Details

getResults

public Object[] getResults()

Returns the results as an array of Objects. Every service call should document the type of the Objects that are returned within the Result (or any object that extends it, such as ResultPage and ResultList).

Returns:

the results as an array of Objects

See Also:

• setResults(Object[])

setResults

public void setResults(Object[] results_)

See getResults().

Parameters:

results_ - The results as an array of Objects returned by a service call.

See Also:

• getResults()

getNumResults

public int getNumResults()

Gets the number of results available. If results is null, will return zero.

Returns:

the number of results.

toString

public String toString()

Overrides:

toString in class Object