skip to main content
OpenEdge Development: ADM Reference
Messaging Objects and Their Methods and Properties : Methods for XML messaging objects
 
Methods for XML messaging objects
This section lists and describes methods for XML Messaging objects.
assignAttribute
pdOwner node and pcValue for the attribute pcName.
Location: xml.p
Parameters:  
INPUT pdOwner AS DECIMAL
INPUT pcName AS CHARACTER
INPUT pcValue AS CHARACTER
Returns: LOGICAL
Notes: None
assignNodeValue
Value of a node.
Location: xml.p
Parameters:  
INPUT pdNode AS DECIMAL
INPUT pcValue AS CHARACTER
Returns: LOGICAL
Note: This adds the attribute in the document to its owner.
createAttribute
Creates an Attribute in an element and returns its unique id.
Location: xml.p
Parameters:  
INPUT pdOwner AS DECIMAL
NodeId of OwnerElement.
INPUT pcName AS CHARACTER
Name of the attribute.
INPUT pcValue AS CHARACTER
AttributeValue.
Returns: DECIMAL
Note: The attribute is not added to the actual element if pcValue is undefined.
createDocument
Creates an empty document.
Location: xml.p
Parameters: None
Returns: LOGICAL
Notes: None
createElement
Creates an Element in the document and returns its unique id.
Location: xml.p
Parameters:  
INPUT pcParent AS DECIMAL
NodeId of Parent.
INPUT pcName AS CHARACTER
Name of the node.
INPUT pcText AS CHARACTER
Text. (The Unknown value (?) represents no text.)
Returns: DECIMAL
Notes: None
createNode
Creates a Node in the document and returns its id.
Location: xml.p
Parameters:  
INPUT pdParent AS DECIMAL
NodeId of Parent.
INPUT pcName AS CHARACTER
Name of the node.
INPUT pcType AS CHARACTER
Node type (defaults to Element).
Returns: DECIMAL
Notes: None
createText
Creates a Text Node in the document and returns its unique id.
Location: xml.p
Parameters:  
INPUT pdParent AS DECIMAL
NodeId of Parent Element.
INPUT pcText AS CHARACTER
Returns: DECIMAL
Notes: None
deleteDocument
Deletes the document and cleans up all the temp-tables.
Location: xml.p
Parameters: None
Returns: LOGICAL
Notes: None
destroyObject
Procedure that destroys the document. Override this routine to delete the document and temp-table.
Location: xml.p
Parameters: None
Notes: None
nodeHandle
Returns the handle of the node identified by the pdId argument.
Location: xml.p
Parameters:  
INPUT pdId AS DECIMAL
Returns: CHARACTER
Notes: None
nodeType
Returns the type of the node identified by pdId.
Location: xml.p
Parameters:  
INPUT pdId AS DECIMAL
Returns: CHARACTER
Notes: None
ownerElement
Returns the OwnerElement corresponding to pdAttributeNode.
Location: xml.p
Parameters:  
INPUT pdAttributeNode AS DECIMAL
Returns: DECIMAL
Notes: None
parentNode
Returns the ID of pdNode’s parent.
Location: xml.p
Parameters:  
INPUT pdNode AS DECIMAL
ID of the node whose parent is wanted.
Returns: DECIMAL node ID of the parent.
Notes: None
processCDataSection
Procedure that processes a CDATA-Section node.
Location: xml.p
Parameters:  
INPUT phText AS HANDLE
INPUT pcPath AS CHARACTER
Note: This method just passes an event with path and value information.
processComment
Procedure that processes a comment node.
Location: xml.p
Parameters:  
INPUT phText AS HANDLE
INPUT pcPath AS CHARACTER
Note: This method does nothing and must be overridden if you need to process comments.
processDocument
Procedure that starts processing of the current document.
Location: xml.p
Parameters: None
Notes: None
processElement
Procedure that processes an element document.
Location: xml.p
Parameters:  
INPUT phNode AS HANDLE
Current x-noderef handle.
INPUT pcPath AS CHARACTER
Current Document path (This is the logical path and not the numbered XPath).
Notes:  
*Calls startEvent before the children are processed and endEvent after.
*Attributes are NOT processed in xml.p, but all the attribute’s names are passed as parameters to the startEvent. The developer or super-procedure extension is responsible for processing data from attributes.
processRoot
Procedure that starts processing the elements of the document.
Location: xml.p
Parameters: None
Note: This is just a starting point without events.
processText
Procedure that processes a text node.
Location: xml.p
Parameters:  
INPUT phText AS HANDLE
INPUT pcPath AS CHAR
Note: Passes the event with path and value information.
receiveHandler
Procedure that handles receiving a message.
Location: xml.p
Parameters:  
INPUT phMessage AS HANDLE
Note: phMessage is the handle of the JMS message being received. An XML document is created and it is loaded with the memptr from the message. The Document is NOT processed by default. The developer can override this to start processing the document either by calling processDocument or getElementsByTagName or other equivalent methods.
receiveReplyHandler
Procedure that handles any reply to a message that has been sent.
Location: xml.p
Parameters:  
INPUT phMessage AS HANDLE
Handle of the JMS reply message being received.
Note: An override of this procedure should get the Correlation ID of the message to synchronize it to the original message being replied to. It should also get any needed property values and the body of the reply message.
sendHandler
Procedure that sets the body of an outgoing message.
Location: xml.p
Parameters:  
INPUT phMessage AS HANDLE
Handle of the JMS message being sent.
Notes:  
*The document handle is saved into a MEMPTR, and the MEMPTR is used to set the body of the Bytes Message.
*The DocumentHandle is expected to return an XML document.
sendReplyHandler
Procedure that processes a reply to a message.
Location: xml.p
Parameters:  
INPUT phMessage AS HANDLE
Handle of the JMS reply message being sent.
Note: An override of this procedure should set any necessary properties as well as supply the body of the reply message.