パッケージ org.iplass.mtp.webapi.definition

クラス WebApiResultAttribute

java.lang.Object
org.iplass.mtp.webapi.definition.WebApiResultAttribute
すべての実装されたインタフェース:
Serializable
public class WebApiResultAttribute extends Object implements Serializable
WebAPI 結果属性

WebAPI レスポンスに関する属性を設定します。

関連項目:

  • コンストラクタの詳細

    • WebApiResultAttribute

      public WebApiResultAttribute()

  • メソッドの詳細

    • getName

      public String getName()
      レスポンス属性名を取得します。
      戻り値:
      レスポンス属性名

    • setName

      public void setName(String name)
      レスポンス属性名を設定します。

      必須の設定項目です。
      RequestContext.setAttribute(String, Object) で設定したキーに一致する値を、レスポンスの属性として設定します。

      パラメータ:
      name - レスポンス属性名

    • getDataType

      public String getDataType()
      レスポンスデータ型を取得します。
      戻り値:
      レスポンスデータ型

    • setDataType

      public void setDataType(String dataType)
      レスポンスデータ型を設定します。

      任意の設定項目です。設定値は WebAPI の動作に影響はありません。
      設定することで、OpenAPI 出力時にデータ型を指定することが可能となります。

      パラメータ:
      dataType - レスポンスデータ型