Class XMLReplyDocument

    • Constructor Detail

      • XMLReplyDocument

        public XMLReplyDocument()
        Creates the property container without a name.
      • XMLReplyDocument

        public XMLReplyDocument​(Atom propertyAtom)
        Creates the property container.
        propertyAtom - the name of the component, unique within it's parent.
    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Gets the description of this this processor, with a default text.
        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.
        shouldCreateProps in class PropCnr
        element - The element in question.
        true to create properties out of it, false to ignore the element.
      • getDocumentString

        protected java.lang.String getDocumentString()
        Gets the Document String.
        The Document String when called in the Designer, null otherwise.
      • getDocument

        protected org.w3c.dom.Document getDocument()
        Gets the XML document. This method can only be used in the Designer.
        The XML Document, null when not used in the Designer.
      • setDocument

        protected boolean setDocument​(org.w3c.dom.Document doc)
        Sets the Document from a Reply. This method can only be used in the Designer.
        true for changed document string, false for same contents or failure to save document.
      • getWebServiceProp

        public WebServiceProp getWebServiceProp()
        Gets the Web Service property.
        The Web Service property, or null if not attached to it.
      • getOutput

        public OutputProps getOutput()
        Gets the output properties.
        The output properties.
      • getVirtualSpace

        public VirtualSpace getVirtualSpace()
        Gets the VirtualSpace.
        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
        reply - The reply contents.
        null for match, or an error message.
      • getFailureMessage

        public java.lang.String getFailureMessage()
        Gets the failure message for the reply.
        Specified by:
        getFailureMessage in interface IReplyProcessor
        null to proceed processing, or a String as message to throw to abort the web service.
      • processReply

        protected boolean processReply​(IAppSessionGyro appGyro,
                                       OutputProps output,
                                       XMLReply 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.
        appGyro - The application session gyro in the server, null for Designer.
        output - The output properties.
        reply - The XML 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.
        PropException - For property errors.