org.opensocial

Class Response

java.lang.Object

org.opensocial.Response

public class Response
extends Object

OpenSocial data response; encapsulates all information returned by a provider after processing a data request sent from a Client.

Author:

Jason Cooper

Constructor Summary

Constructors

Constructor and Description
Response() Creates and returns a new Response.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Model> List<T>	getEntries() Returns a List of all entry objects (e.g. people, activities) parsed from the provider's response; if the raw response contained no entry objects, an empty list is returned.
<T extends Model> T	getEntry() Returns a single entry object (e.g. person, activity) parsed from the response or null if the response contained no entry objects.
Long	getItemsPerPage()
Long	getStartIndex() Returns the value of the "startIndex" field contained within the provider's response or null if no such property was returned.
String	getStatusLink() Returns the value of the "statusLink" field contained within the provider's response or null if no such property was returned.
Long	getTotalResults() Returns the value of the "totalResults" field contained within the provider's response or null if no such property was returned.
Boolean	isFiltered() Returns the value of the "isFiltered" field contained within the provider's response or null if no such property was returned.
void	setIsFiltered(Object isFiltered) Parses the passed Object as a Boolean if necessary, then sets this as the value of the isFiltered field; this method is required by the response parser and should not be called by clients directly.
void	setItemsPerPage(Object itemsPerPage) Parses the passed Object as a Long if necessary, then sets this as the value of the itemsPerPage field; this method is required by the response parser and should not be called by clients directly.
void	setStartIndex(Object startIndex) Parses the passed Object as a Long if necessary, then sets this as the value of the startIndex field; this method is required by the response parser and should not be called by clients directly.
void	setStatusLink(Object statusLink) Casts the passed Object as a String and sets this as the value of the statusLink field; this method is required by the response parser and should not be called by clients directly.
void	setTotalResults(Object totalResults) Parses the passed Object as a Long if necessary, then sets this as the value of the totalResults field; this method is required by the response parser and should not be called by clients directly.

Methods inherited from class java.lang.Object

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

Constructor Detail

Response

public Response()

Creates and returns a new Response.

Method Detail

getStartIndex

public Long getStartIndex()

Returns the value of the "startIndex" field contained within the provider's response or null if no such property was returned.

getTotalResults

public Long getTotalResults()

Returns the value of the "totalResults" field contained within the provider's response or null if no such property was returned.

getItemsPerPage

public Long getItemsPerPage()

getStatusLink

public String getStatusLink()

Returns the value of the "statusLink" field contained within the provider's response or null if no such property was returned.

isFiltered

public Boolean isFiltered()

Returns the value of the "isFiltered" field contained within the provider's response or null if no such property was returned.

getEntries

public <T extends Model> List<T> getEntries()

Returns a List of all entry objects (e.g. people, activities) parsed from the provider's response; if the raw response contained no entry objects, an empty list is returned. The List type depends on the Service used to create the request; e.g. a List of Persons is returned if the executed Request was generated by a PeopleService method.

getEntry

public <T extends Model> T getEntry()

Returns a single entry object (e.g. person, activity) parsed from the response or null if the response contained no entry objects. Equivalent to calling getEntries.get(0) except no exception is thrown if no entries were parsed. The type of object returned depends on the Service used to create the request; e.g. a Person is returned if the executed Request was generated by a PeopleService method.

setStartIndex

public void setStartIndex(Object startIndex)

Parses the passed Object as a Long if necessary, then sets this as the value of the startIndex field; this method is required by the response parser and should not be called by clients directly.

Parameters:

startIndex - String or Number object to parse as a Long and store

setTotalResults

public void setTotalResults(Object totalResults)

Parses the passed Object as a Long if necessary, then sets this as the value of the totalResults field; this method is required by the response parser and should not be called by clients directly.

Parameters:

totalResults - String or Number object to parse as a Long and store

setItemsPerPage

public void setItemsPerPage(Object itemsPerPage)

Parses the passed Object as a Long if necessary, then sets this as the value of the itemsPerPage field; this method is required by the response parser and should not be called by clients directly.

Parameters:

itemsPerPage - String or Number object to parse as a Long and store

setStatusLink

public void setStatusLink(Object statusLink)

Casts the passed Object as a String and sets this as the value of the statusLink field; this method is required by the response parser and should not be called by clients directly.

Parameters:

statusLink - String object to store

setIsFiltered

public void setIsFiltered(Object isFiltered)

Parses the passed Object as a Boolean if necessary, then sets this as the value of the isFiltered field; this method is required by the response parser and should not be called by clients directly.

Parameters:

isFiltered - String or Boolean object to parse as a Boolean and store