java.lang.Object
- com.iizix.prop.GProp<GProp<?>[]>
- - com.iizix.prop.PropCnr
  - - com.iizix.ws.prop.json.JSONReplyDocument

All Implemented Interfaces:
EventListener, IGProp<GProp<?>[]>, IPropCnr, IReplyProcessor, java.lang.Cloneable
Direct Known Subclasses:
EditorJSONReplyDocument
```
public class JSONReplyDocument
extends PropCnr
implements IReplyProcessor
```
The JSON reply document contains information that identifies the reply transaction and maps the structured data into VSFields and VSTables (or columns).
Author:
Christopher Mindus

Field Summary
- Fields inherited from class com.iizix.prop.PropCnr
  EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID
- Fields inherited from class com.iizix.prop.GProp
  GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2
- Fields inherited from interface com.iizix.prop.IGProp
  EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE

Constructor Summary
Constructors
Constructor Description
JSONReplyDocument()
Creates the property container without a name.
JSONReplyDocument(Atom propertyAtom)
Creates the property container.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`JSONReplyDocument`	`clone()`	Clones the instance.
`java.lang.String`	`getDescription()`	Gets the description of this this processor, with a default text.
`protected JSONObject`	`getDocument()`	Gets the JSON "Document" Object.
`protected java.lang.String`	`getDocumentString()`	Gets the JSON "Document" String.
`java.lang.String`	`getFailureMessage()`	Gets the failure message for the reply.
`OutputProps`	`getOutput()`	Gets the output properties.
`java.lang.String`	`getReplyMatch(IReplyContent reply)`	Called to verify if the reply matches the reply format of this processor.
`VirtualSpace`	`getVirtualSpace()`	Gets the VirtualSpace.
`WebServiceProp`	`getWebServiceProp()`	Gets the Web Service property.
`void`	`processReply(IAppSessionGyro appGyro, OutputProps output, IReplyContent reply)`	Processes the reply contents for the Web Service.
`protected boolean`	`processReply(IAppSessionGyro appGyro, OutputProps output, JSONReply reply, boolean doPerform, IComplexOperation op, java.util.List<VSComponent> list, java.util.Map<VSComponent,java.lang.Throwable> errors)`	Processes the reply to populate VirtualSpace.
`protected boolean`	`setDocument(JSONObject doc)`	Sets the JSON Document from a Reply.
`protected boolean`	`shouldCreateProps(org.w3c.dom.Element element)`	Checks if a child Element should be created as properties or if it should be skipped.

Methods inherited from class com.iizix.prop.PropCnr
__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, doVirtualizePropCnr, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getPredefinedProps, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldSerializeToXML, toElementString, toNativeValue0, usePropHashMap, usesPropIndex, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verify, verifyInternalUseOnly, verifyTree, virtualize

Methods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getModuleFolder, getModuleFolder, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.iizix.prop.IGProp
addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getModuleFolder, getModuleFolder, getParent, getParent, getPropAtom, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onRemoteEvent, removePropError, removePropListener, renameProp, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from interface com.iizix.prop.IPropCnr
canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized

- Constructor Detail
  - JSONReplyDocument
```
public JSONReplyDocument()
```
    Creates the property container without a name.
  - JSONReplyDocument
```
public JSONReplyDocument(Atom propertyAtom)
```
    Creates the property container.
    Parameters:
    propertyAtom - the name of the component, unique within it's parent.
- Method Detail
  - clone
```
public JSONReplyDocument clone()
```
    Clones the instance.
    Overrides:
    clone in class PropCnr
    Returns:
    A cloned instance.
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the description of this this processor, with a default text.
    Returns:
    A descriptive text.
  - shouldCreateProps
```
protected boolean shouldCreateProps(org.w3c.dom.Element element)
```
    Checks if a child Element should be created as properties or if it should be skipped. Override this method (and call super.shouldCreateProps(element)) if the container creates other child elements.
    Overrides:
    shouldCreateProps in class PropCnr
    Parameters:
    element - The element in question.
    Returns:
    true to create properties out of it, false to ignore the element.
  - getDocumentString
```
protected java.lang.String getDocumentString()
```
    Gets the JSON "Document" String.
    Returns:
    The JSON "Document" String when called in the Designer, null otherwise.
  - getDocument
```
protected JSONObject getDocument()
```
    Gets the JSON "Document" Object. This method can only be used in the Designer.
    Returns:
    The JSON "Document" Object, null when not used in the Designer.
  - setDocument
```
protected boolean setDocument(JSONObject doc)
```
    Sets the JSON Document from a Reply. This method can only be used in the Designer.
    Returns:
    true for changed document string, false for same contents or failure to save document.
  - getWebServiceProp
```
public WebServiceProp getWebServiceProp()
```
    Gets the Web Service property.
    Returns:
    The Web Service property, or null if not attached to it.
  - getOutput
```
public OutputProps getOutput()
```
    Gets the output properties.
    Returns:
    The output properties.
  - getVirtualSpace
```
public VirtualSpace getVirtualSpace()
```
    Gets the VirtualSpace.
    Returns:
    The VirtualSpace connected the the variable input, or null for none.
  - getReplyMatch
```
public java.lang.String getReplyMatch(IReplyContent reply)
```
    Called to verify if the reply matches the reply format of this processor.
    Specified by:
    getReplyMatch in interface IReplyProcessor
    Parameters:
    reply - The reply contents.
    Returns:
    null for match, or an error message.
  - processReply
```
public void processReply(IAppSessionGyro appGyro,
                         OutputProps output,
                         IReplyContent reply)
                  throws PropException
```
    Processes the reply contents for the Web Service.
    Specified by:
    processReply in interface IReplyProcessor
    Parameters:
    appGyro - The application session gyro in the server, null for Designer.
    output - The output properties.
    reply - The reply contents.
    Throws:
    PropException - For property errors.
  - getFailureMessage
```
public java.lang.String getFailureMessage()
```
    Gets the failure message for the reply.
    Specified by:
    getFailureMessage in interface IReplyProcessor
    Returns:
    null to proceed processing, or a String as message to throw to abort the web service.
  - processReply
```
protected boolean processReply(IAppSessionGyro appGyro,
                               OutputProps output,
                               JSONReply reply,
                               boolean doPerform,
                               IComplexOperation op,
                               java.util.List<VSComponent> list,
                               java.util.Map<VSComponent,java.lang.Throwable> errors)
                        throws PropException
```
    Processes the reply to populate VirtualSpace.
    Parameters:
    appGyro - The application session gyro in the server, null for Designer.
    output - The output properties.
    reply - The JSON reply.
    doPerform - Flag to perform the operation, or just for testing.
    op - The Complex Operation, or null for none.
    list - List filled with propagated items, null for none.
    errors - Map filled with errors, null for none.
    Throws:
    PropException - For property errors.

Constructor	Description
`JSONReplyDocument()`	Creates the property container without a name.
`JSONReplyDocument(Atom propertyAtom)`	Creates the property container.

Class JSONReplyDocument

Field Summary

Fields inherited from class com.iizix.prop.PropCnr

Fields inherited from class com.iizix.prop.GProp

Fields inherited from interface com.iizix.prop.IGProp

Constructor Summary

Method Summary

Methods inherited from class com.iizix.prop.PropCnr

Methods inherited from class com.iizix.prop.GProp

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.prop.IGProp

Methods inherited from interface com.iizix.prop.IPropCnr

Constructor Detail

JSONReplyDocument

JSONReplyDocument

Method Detail

clone

getDescription

shouldCreateProps

getDocumentString

getDocument

setDocument

getWebServiceProp

getOutput

getVirtualSpace

getReplyMatch

processReply

getFailureMessage

processReply