com.ibm.ecm.json

Class JSONMessage

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

com.ibm.json.java.JSONObject

com.ibm.ecm.json.JSONMessage

All Implemented Interfaces:

com.ibm.json.java.JSONArtifact, java.io.Serializable, java.lang.Cloneable, java.util.Map

public class JSONMessage
extends com.ibm.json.java.JSONObject

Structures the standard JSON for a message returned.

Since:

2.0.2

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADMIN_RESPONSE
static java.lang.String	EXPLANATION
static java.lang.String	FOOTER
static java.lang.String	MORE_INFORMATION
static java.lang.String	NUMBER
static java.lang.String	TEXT
static java.lang.String	USER_RESPONSE

Constructor Summary

Constructors

Constructor and Description
JSONMessage(int number, java.lang.String text, java.lang.String explanation, java.lang.String userResponse, java.lang.String adminResponse, java.lang.String moreInformation)
JSONMessage(int number, java.lang.String text, java.lang.String explanation, java.lang.String userResponse, java.lang.String adminResponse, java.lang.String moreInformation, java.lang.String footer) Constructs a message.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdminResponse() Returns the suggested administrator response.
java.lang.String	getExplanation() Returns a more detailed explanation of the message.
java.lang.String	getFooter() Returns the message footer.
java.lang.String	getMoreInformation() Returns additional detailed information, typically a list of items for which the message applies.
int	getNumber() Returns the message number.
java.lang.String	getText() Returns the brief text of the message.
java.lang.String	getUserResponse() Returns the suggested user response.

Methods inherited from class com.ibm.json.java.JSONObject

isValidObject, isValidType, parse, parse, parse, put, serialize, serialize, serialize, serialize, serialize, serialize, toString

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

NUMBER

public static final java.lang.String NUMBER

See Also:

Constant Field Values

TEXT

public static final java.lang.String TEXT

See Also:

Constant Field Values

EXPLANATION

public static final java.lang.String EXPLANATION

See Also:

Constant Field Values

USER_RESPONSE

public static final java.lang.String USER_RESPONSE

See Also:

Constant Field Values

ADMIN_RESPONSE

public static final java.lang.String ADMIN_RESPONSE

See Also:

Constant Field Values

MORE_INFORMATION

public static final java.lang.String MORE_INFORMATION

See Also:

Constant Field Values

FOOTER

public static final java.lang.String FOOTER

See Also:

Constant Field Values

Constructor Detail

JSONMessage

public JSONMessage(int number,
                   java.lang.String text,
                   java.lang.String explanation,
                   java.lang.String userResponse,
                   java.lang.String adminResponse,
                   java.lang.String moreInformation,
                   java.lang.String footer)

Constructs a message.

Parameters:

number - The message number

text - The message text

explanation - A more detailed explanation

userResponse - A user response

adminResponse - An administrator response or null.

moreInformation - More information, typically with a list of items for which the message applies.

footer - A footer

JSONMessage

public JSONMessage(int number,
                   java.lang.String text,
                   java.lang.String explanation,
                   java.lang.String userResponse,
                   java.lang.String adminResponse,
                   java.lang.String moreInformation)

Method Detail

getNumber

public int getNumber()

Returns the message number.

getText

public java.lang.String getText()

Returns the brief text of the message.

getExplanation

public java.lang.String getExplanation()

Returns a more detailed explanation of the message.

getUserResponse

public java.lang.String getUserResponse()

Returns the suggested user response.

getAdminResponse

public java.lang.String getAdminResponse()

Returns the suggested administrator response.

getMoreInformation

public java.lang.String getMoreInformation()

Returns additional detailed information, typically a list of items for which the message applies.

getFooter

public java.lang.String getFooter()

Returns the message footer.