Class SOAPOutputMessage

  • All Implemented Interfaces:
    EventListener, IGProp<GProp<?>[]>, IPropCnr, java.lang.Cloneable
    Direct Known Subclasses:
    EditorSOAPOutputMessage

    public class SOAPOutputMessage
    extends PropCnr
    The SOAP output message that identifies the reply transaction and maps the structured data into VSFields and VSTables (or columns).
    Author:
    Christopher Mindus
    • Constructor Detail

      • SOAPOutputMessage

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

        public SOAPOutputMessage​(Atom propertyAtom)
        Creates the property container.
        Parameters:
        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.
        Returns:
        A description.
      • 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 Document String.
        Returns:
        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.
        Returns:
        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.
        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.