opensocial.ResponseItem (v0.7)

 概要     詳細

Class opensocial.ResponseItem

サーバー上のデータ要求アイテムの処理によって生成された応答を表します。

メソッドの概要

 Object getData()

応答データを取得します。

 String getErrorCode()

要求にエラーがあった場合にエラー コードを返します。

 String getErrorMessage()

要求にエラーがあった場合にエラー メッセージを返します。

 opensocial.DataRequest getOriginalDataRequest()

元のデータ要求を返します。

 Boolean hadError()

サーバーからこのデータをフェッチする際にエラーが発生した場合は true を返します。

 

メソッドの詳細

getData

Object getData()

応答データを取得します。

戻り値:
Object サーバーによって計算された要求値 (値の型は要求の型によって定義)

getErrorCode

String getErrorCode()

要求にエラーがあった場合にエラー コードを返します。エラー コードには、コンテナ固有のコードと、Error で定義されたコードがあります。

戻り値:
String エラー コード、エラーが発生しなかった場合は null

getErrorMessage

String getErrorMessage()

要求にエラーがあった場合にエラー メッセージを返します。

戻り値:
String 発生したエラーに関する具体的な説明 (エラーが発生した場合でも null が返される可能性あり)

getOriginalDataRequest

opensocial.DataRequest getOriginalDataRequest()

元のデータ要求を返します。

戻り値:
opensocial.DataRequest このデータ応答のフェッチに使用したデータ要求

hadError

Boolean hadError()

サーバーからこのデータをフェッチする際にエラーが発生した場合は true を返します。

戻り値:
Boolean エラーが発生した場合は true、それ以外の場合は false

---