skip to main content
OpenEdge Development: ADM Reference
Messaging Objects and Their Methods and Properties : Methods for busines to business messaging objects
 
Methods for busines to business messaging objects
This section lists and describes the methods for business to business Messaging objects.
callOutParams
Looks through a table and calls zero or more methods based on the value of pdNode.
Location: b2b.p
Parameters:  
INPUT pdNode AS DECIMAL
Returns: LOGICAL
Notes: None
characterValue
Procedure that traps the event of a text node being parsed.
Location: b2b.p
Parameters:  
INPUT pcPath AS CHARACTER
INPUT pcValue AS CHARACTER
Notes: None
createSchemaAttributes
Returns a new query handle for the schema temp-table to use for navigation through the children or a schema node.
Location: b2b.p
Parameters:  
INPUT piParentNode AS INTEGER
Returns: HANDLE
Note: At present, the caller is responsible for deleting the object.
createSchemaChildren
Returns a new query handle for the schema temp-table to use for navigation through the children of a schema node.
Location: b2b.p
Parameters:  
INPUT piParentNode AS INTEGER
Returns: HANDLE
Note: At present, the caller is responsible for deleting the object.
createSchemaPath
Returns a new query handle for the schema temp-table to use for navigation through the children of a schema node.
Location: b2b.p
Parameters:  
INPUT pcPath AS CHARACTER
Returns: HANDLE
Note: At present, the caller is responsible for deleting the object.
dataSource
Returns the handle of the data source identified by the argument.
Location: b2b.p
Parameters:  
INPUT pcName AS CHARACTER
Returns: HANDLE
Notes: None
defineMapping
Creates a tMapping temp-table record.
Location: b2b.p
Parameters:  
INPUT pcName AS CHARACTER
INPUT pcColumns AS CHARACTER
INPUT pcValues AS CHARACTER
Returns: LOGICAL
Note: This can be called from an override of processMappings( ) to explicitly create tMapping temp-table records rather than using instance properties.
destroyObject
Procedure that overrides in order to delete the schema temp-table.
Location: b2b.p
Parameters: None
Notes: None
endDocument
Procedure that traps the document-processed event and passes all the collected data that has been stored on other events during the processing.
Location: b2b.p
Parameters: None
Note: Collect all the data to ensure that all the updates are done in the order in which the mapped objects are linked to nodes. It is too early on startEvent and even on endEvent because child nodes end before parent nodes (do not save orderlines before the order).
endElement
Procedure that traps the XML-element-processed event. Stub routine meant to be overridden.
Location: b2b.p
Parameters:  
INPUT pcPath AS CHARACTER
Logical path (not the numbered XPath).
INPUT pcNameSpace AS CHARACTER
Namespace (future support).
INPUT pcName AS CHARACTER
Name of the element.
INPUT pcQualName AS CHARACTER
Name qualified with the namespace prefix.
Note: This is just an empty stub to override. It really belongs in xml.p, or xml.p should use no-error.
findDataRow
Finds a row of a mapped DataObject. If any of the KeyFields are blank, use ForeignFields from the object’s DataSource.
Location: b2b.p
Parameters:  
INPUT phObject AS HANDLE
The DataObject who’s row to find in pcKeyValues.
INPUT pcKeyValues AS CHARACTER
CHR(1)-separated list with the exact same number of entries as the KeyFields property of the object.
Returns: LOGICAL
Notes: None
initializeObject
Procedure that loads schema.
Location: b2b.p
Parameters: None
Notes: None
loadProducerSchema
Returns the result of identifying and loading the appropriate producer schema.
Location: b2b.p
Parameters: None
Returns: LOGICAL
Notes: None
loadSchema
Loads the schema temp-table.
Location: b2b.p
Parameters:  
INPUT pcSchema AS CHARACTER
Returns: LOGICAL
Notes: None
mapNode
Maps a node to a procedure, function, or column in a data object.
Location: b2b.p
Parameters:  
INPUT pdNode AS DECIMAL
INPUT phDataSource AS HANDLE
INPUT pcMapType AS CHARACTER
INPUT pcMapName AS CHARACTER
INPUT pcConversion AS CHARACTER
INPUT pcMapParameter AS CHARACTER
INPUT pcNodeType AS CHARACTER
INPUT pcNodeName AS CHARACTER
Returns: DECIMAL
Note: If the node is mapped to more than one parameter of the Data-Source method, the mapping is stored in storeParameters and the data will be processed in callOutParams().
NotFoundError
Returns a useful ‘Record not found’ error message with keyfields.
Location: b2b.p
Parameters:  
INPUT phDataSource AS HANDLE
DataSource.
INPUT pcKeyValues AS CHARACTER
CHR(1) list with keyvalues corresponding to KeyFields.
Returns: CHARACTER
Notes: None
numParameters
Returns the number of parameters for a method.
Location: b2b.p
Parameters:  
INPUT phProc AS HANDLE
Valid procedure handle.
INPUT pcMethod AS CHARACTER
Function or procedure name.
Returns: INTEGER
Notes: None
processMappings
Procedure that creates tMapping temp-table records from DirectionList, NameList, SchemaList, DocTypeList, DestinationList, ReplyReqList, and ReplySelectorList property values.
Location: b2b.p
Parameters: None
Notes: None
processMessages
Procedure that is called from receiveHandler() when an error occurs.
Location: b2b.p
Parameters:  
INPUT pcMessages AS CHARACTER
Chr(3) and chr(4) delimited list, as returned from fetchMessages().
Note: Passes the data from fetchMessages() so the user does not have to do this. Otherwise, the default is exactly as in ShowDataMessages() in other ADM objects. This is called from ReceiveHandler() so RETURN ERROR or ADM-ERROR will make sure that the message is not acknowledged.
produceAttributes
Procedure that produces attributes of schema nodes.
Location: b2b.p
Parameters:  
INPUT piParentSchemaNode AS INTEGER
INPUT pdOwnerNode AS DECIMAL
INPUT phDataSource AS HANDLE
Notes: None
produceChildren
Procedure that produces all child nodes of an element or document.
Location: b2b.p
Parameters:  
INPUT piParentSchemaNode AS INTEGER
Schema parent node.
INPUT pdParentNode AS DECIMAL
Actual parent node.
INPUT phDataSource AS HANDLE
LINKed data source of parent.
Notes: None
produceDocument
Procedure that creates a document and runs produceChildren() on it.
Location: b2b.p
Parameters: None
Notes: None
receiveHandler
Procedure that handles receiving a message.
Location: b2b.p
Parameters:  
INPUT phMessage AS HANDLE
Handle of the JMS message being received.
Note: The xml.p SUPER creates an XML document and loads it from the message.
rowNotFoundError
Returns a “Record not found” error message with key fields.
Location: b2b.p
Parameters:  
INPUT phDataSource AS HANDLE
DataSource.
INPUT pcKeyValues AS CHARACTER
CHR(1) list with KeyValues corresponding to KeyFields.
Returns: CHARACTER
Notes: None
schemaField
Returns the buffer-value of a schema field.
Location: b2b.p
Parameters:  
INPUT phQuery AS HANDLE
Handle of a query defined for the schema.
INPUT pcName AS CHARACTER
Buffer name.
Returns: CHARACTER PRIVATE (buffer-value)
Note: This is intended to be an interim solution.
sendHandler
Procedure for event handler for sending the message.
Location: b2b.p
Parameters:  
INPUT phMsgHandler AS HANDLE NO-UNDO.
Handle of message being sent.
Notes:  
*Gets the actual schema and produces an XML document before calling super, which takes care of the actual saving of the document to the MEMPTR that is transferred to the message object.
*Overrides this to set header and other message information.
sendMessage
Procedure that overrides the msghandler message in order to set message-specific properties.
Location: b2b.p
Parameters: None
Notes: None
startDataRow
Registers the dataRow record used to find, create, or update the data.
Location: b2b.p
Parameters:  
INPUT phDataSource AS HANDLE
DataSource handle.
INPUT pcAction AS CHARACTER
The operation to be carried out: FIND, CREATE, UPDATE, CREATE UPDATE or DELETE.
Returns: LOGICAL
Notes: None
startElement
Procedure that traps the event of a new XML element being processed, checks whether it is mapped to a dataObject, and, if so, registers it.
Location: b2b.p
Parameters:  
INPUT pcPath AS CHARACTER
Logical path (not the numbered XPath).
INPUT pcNameSpace AS CHARACTER
Namespace (future support).
INPUT pcName AS CHARACTER
Name of the element.
INPUT pcQualName AS CHARACTER
Name qualified with the namespace prefix.
Notes: None
storeNodeValue
Store node values for a data source until the endDocument event. (Consume XML).
Location: b2b.p
Parameters:  
INPUT phDataSource AS HANDLE
The data source.
INPUT pcColumnName AS CHARACTER
The name of the node.
INPUT pcNodeValue AS CHARACTER
The value.
Returns: LOGICAL
Notes: None
storeParameterNode
Store mapping information for Output parameters (Produce XML).
Location: b2b.p
Parameters:  
INPUT phDataSource AS HANDLE
The data source.
INPUT pcMethod AS CHARACTER
The mapping procedure/function.
INPUT pdNode AS DECIMAL
The node bearing the value.
INPUT piNum AS INTEGER
The parameter number.
INPUT piNumParam AS INTEGER
The total number of parameters in the method.
Returns: LOGICAL
Note: This information is stored until the parent node of the first parameter is processed. callOutParams() will then call the pcmethod in phDataSource and use the piNum parameter values to populate the node or attribute.
storeParameterValue
Stores values for input parameters.
Location: b2b.p
Parameters:  
INPUT phDataSource AS HANDLE
DataSource.
INPUT pcMethod AS CHARACTER
Procedure or function.
INPUT piNum AS INTEGER
Parameter number.
INPUT piNumParam AS INTEGER
Number of parameters in the method.
INPUT pcValue AS CHARACTER
Value to pass as input.
Returns: LOGICAL
Note: This information is stored until the endDocument call. InParams calls the pcmethod in phDataSource and passes the PcValue as the piNum parameter.
targetProcedure
Procedure used by the router to subscribe to an event of the schema name in order to find whether it is already started.
Location: b2b.p
Parameters:  
OUTPUT phHandle AS HANDLE.
phHandle = TARGET-PROCEDURE.
Notes: None