com.ibm.ecm.json

Class JSONMessage

  1. java.lang.Object
  2. extended byjava.util.AbstractMap<K,V>
  3. extended byjava.util.HashMap
  4. extended bycom.ibm.json.java.JSONObject
  5. extended bycom.ibm.ecm.json.JSONMessage
All implemented interfaces:
JSONArtifact, java.io.Serializable, java.lang.Cloneable, java.util.Map
  1. public class JSONMessage
  2. extends 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>

Constructor Summary

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)
Constructs a message.

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
 getAdminResponse()
Returns the suggested administrator response.
  1. java.lang.String
 getExplanation()
Returns a more detailed explanation of the message.
  1. java.lang.String
 getMoreInformation()
Returns additional detailed information, typically a list of items for which the message applies.
  1. int
 getNumber()
Returns the message number.
  1. java.lang.String
 getText()
Returns the brief text of the message.
  1. 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, containsKey, containsValue, entrySet, get, isEmpty, keySet, putAll, remove, 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

Constructor Detail

JSONMessage

  1. public JSONMessage(int number,
  2. java.lang.String text,
  3. java.lang.String explanation,
  4. java.lang.String userResponse,
  5. java.lang.String adminResponse,
  6. java.lang.String moreInformation)
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.

Method Detail

getNumber

  1. public int getNumber()
Returns the message number.

getText

  1. public java.lang.String getText( )
Returns the brief text of the message.

getExplanation

  1. public java.lang.String getExplanation( )
Returns a more detailed explanation of the message.

getUserResponse

  1. public java.lang.String getUserResponse( )
Returns the suggested user response.

getAdminResponse

  1. public java.lang.String getAdminResponse( )
Returns the suggested administrator response.

getMoreInformation

  1. public java.lang.String getMoreInformation( )
Returns additional detailed information, typically a list of items for which the message applies.