com.ibm.ecm.json

Class JSONClassDefinitionResponse

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

com.ibm.json.java.JSONObject

com.ibm.ecm.json.JSONResponse

com.ibm.ecm.json.JSONClassDefinitionResponse

All Implemented Interfaces:

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

public class JSONClassDefinitionResponse
extends JSONResponse

This class structures the JSON used to represent a class definition response. This responses is returned for a openClass request for a particular content class. It describes the classes attributes and other information about the class.

There are two ways to use this class:

1. In plug-in response filters for openClass. This class is actually the JSONObject passed to the response filter, so it can be immediately cast, as in:

    JSONClassDefinitionResponse jsonClassDefinitionResponse = (JSONClassDefinitionResponse) jsonResponse;
    

2. In a plug-in provided repository type, to format the response JSON appropriately for the openClass request.

Since:

2.0.3

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>

Constructor Summary

Constructors

Constructor and Description
JSONClassDefinitionResponse()

Method Summary

Modifier and Type	Method and Description
void	addAttributeDefinition(java.lang.String id, java.lang.String name, java.lang.String type, boolean multiValue, boolean readOnly, boolean system, java.lang.Object defaultValue, java.lang.Object minValue, java.lang.Object maxValue, int maxLength)

Methods inherited from class com.ibm.ecm.json.JSONResponse

addErrorMessage, addInfoMessage, addWarningMessage, hasErrors

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

Constructor Detail

JSONClassDefinitionResponse

public JSONClassDefinitionResponse()

Method Detail

addAttributeDefinition

public void addAttributeDefinition(java.lang.String id,
                                   java.lang.String name,
                                   java.lang.String type,
                                   boolean multiValue,
                                   boolean readOnly,
                                   boolean system,
                                   java.lang.Object defaultValue,
                                   java.lang.Object minValue,
                                   java.lang.Object maxValue,
                                   int maxLength)