Package org.iplass.mtp.webapi.definition

Class WebApiResultAttribute

java.lang.Object

org.iplass.mtp.webapi.definition.WebApiResultAttribute

All Implemented Interfaces:

Serializable

public class WebApiResultAttribute
extends Object
implements Serializable

WebAPI 結果属性

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

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WebApiResultAttribute()

Method Summary

Modifier and Type	Method	Description
String	getDataType()	レスポンスデータ型を取得します。
String	getName()	レスポンス属性名を取得します。
void	setDataType(String dataType)	レスポンスデータ型を設定します。
void	setName(String name)	レスポンス属性名を設定します。

Methods inherited from class java.lang.Object

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

Constructor Details

WebApiResultAttribute

public WebApiResultAttribute()

Method Details

getName

public String getName()

レスポンス属性名を取得します。

Returns:

レスポンス属性名

setName

public void setName(String name)

レスポンス属性名を設定します。

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

Parameters:

name - レスポンス属性名

getDataType

public String getDataType()

レスポンスデータ型を取得します。

Returns:

レスポンスデータ型

setDataType

public void setDataType(String dataType)

レスポンスデータ型を設定します。

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

Parameters:

dataType - レスポンスデータ型