opensocial.ResponseItem (v0.7)

 SUMMARY     DETAIL

Class opensocial.ResponseItem

Represents a response that was generated by processing a data request item on the server.

Method Summary

 Object getData()

Gets the response data.

 String getErrorCode()

If the request had an error, returns the error code.

 String getErrorMessage()

If the request had an error, returns the error message.

 opensocial.DataRequest getOriginalDataRequest()

Returns the original data request.

 Boolean hadError()

Returns true if there was an error in fetching this data from the server.

 

Method Detail

getData

Object getData()

Gets the response data.

Returns:
Object The requested value calculated by the server; the type of this value is defined by the type of request that was made

getErrorCode

String getErrorCode()

If the request had an error, returns the error code. The error code can be container-specific or one of the values defined by Error.

Returns:
String The error code, or null if no error occurred

getErrorMessage

String getErrorMessage()

If the request had an error, returns the error message.

Returns:
String A human-readable description of the error that occurred; can be null, even if an error occurred

getOriginalDataRequest

opensocial.DataRequest getOriginalDataRequest()

Returns the original data request.

Returns:
opensocial.DataRequest The data request used to fetch this data response

hadError

Boolean hadError()

Returns true if there was an error in fetching this data from the server.

Returns:
Boolean True if there was an error; otherwise, false

---