Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsLib.ebXML.Message
Private  Storage   

EnsLib.ebXML.Message


persistent class EnsLib.ebXML.Message extends
%Persistent, Ens.VDoc.Interface, Ens.Util.MessageBodyMethods, %XML.Adaptor

ebXML Message instance for signalling etc. Use MessageWithPayload to include payload/Manifest

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 8 25


Summary


Properties
%Concurrency DocType DocTypeCategory DocTypeName
Headers Identifier IsMutable Name
OriginalDocId RawContent Source TimeCreated
TypeVersion UserValues

Methods
%%OIDGet %1Check %AddJrnObjToSyncSet %AddToSaveSet
%AddToSyncSet %BMEBuilt %BindExport %BuildIndices
%BuildIndicesAsync %BuildIndicesAsyncResponse %BuildIndicesSegment %BuildObjectGraph
%CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion %ClassName
%Close %CompareContents %ComposeOid %ConstructClone
%Delete %DeleteExtent %DeleteId %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DowngradeConcurrency %DrawHTMLForm
%DrawHTMLTable %ExecuteAfterTriggers %ExecuteBeforeTriggers %Exists
%ExistsId %Extends %FileIndices %FileIndicesBuffered
%GUID %GUIDSet %GetContentType %GetLock
%GetParameter %GetSwizzleObject %Id %IncrementCount
%InsertBatch %IsA %IsModified %IsNull
%JournalObject %KillExtent %KillExtentData %LoadFromMemory
%LockExtent %LockId %New %NormalizeObject
%ObjectIsNull %ObjectModified %Oid %OnBeforeAddToSync
%OnDetermineClass %OnTimeout %Open %OpenId
%OriginalNamespace %PackageName %PhysicalAddress %ProcessSubmit
%PurgeIndices %Reload %RemoveFromSaveSet %ResolveConcurrencyConflict
%RollBack %SQLAcquireLock %SQLAcquireTableLock %SQLAfterTriggers
%SQLBeforeTriggers %SQLBuildIndices %SQLBuildPurgeIndexForRow %SQLBuildPurgeIndices
%SQLCheckUnique %SQLCheckUniqueIndices %SQLCheckUniqueKeys %SQLCopyIcolIntoName
%SQLCopyNameIntoIcol %SQLCreateInsDelTables %SQLDefineiDjVars %SQLDelete
%SQLDeleteChildren %SQLDeleteTempStreams %SQLEExit %SQLExists
%SQLFKeyDelLock %SQLFastInsert %SQLFieldValidate %SQLGetLock
%SQLGetOld %SQLGetOldAll %SQLGetOldIndex %SQLInsert
%SQLInsertComputes %SQLInsertStreams %SQLInvalid %SQLInvalid2
%SQLMVDelete %SQLMVIndexDelete %SQLMVIndexInsert %SQLMVIndexUpdate
%SQLMVInsert %SQLMVUpdate %SQLMissing %SQLNormalizeCompFields
%SQLNormalizeFields %SQLPurgeIndices %SQLQuickBulkInsert %SQLQuickBulkLoad
%SQLQuickBulkSave %SQLQuickBulkUpdate %SQLQuickDelete %SQLQuickDeleteChildren
%SQLQuickFindPKeyByRowID %SQLQuickFindRowIDByPKey %SQLQuickInsert %SQLQuickLoad
%SQLQuickLoadChildren %SQLQuickLogicalToOdbc %SQLQuickOdbcToLogical %SQLQuickUpdate
%SQLReleaseLock %SQLReleaseTableLock %SQLStorageValidation %SQLTrigDelTab
%SQLTrigInsTab %SQLUnlock %SQLUnlock2 %SQLUnlockError
%SQLUnlockRef %SQLUpdate %SQLUpdateComputes %SQLUpdateStreams
%SQLValidateCompFields %SQLValidateFields %SQLicompView %SQLnBuild
%Save %SaveDirect %SaveIndices %SerializeObject
%SetModified %ShowContents %ShowContentsHead %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %UpgradeConcurrency %ValidateIndices %ValidateObject
%XMLGenerate BuildAckHeader BuildErrorList BuildReplyHeader
ConstructSchemaClassInstance CopyValues DrawFormButtons DrawHTMLContentsForm
DrawHTMLForm EnumerateDocTypesClose EnumerateDocTypesExecute EnumerateDocTypesFetch
EnumerateTypeCategoriesClose EnumerateTypeCategoriesExecute EnumerateTypeCategoriesFetch EnumerateVDocsClose
EnumerateVDocsExecute EnumerateVDocsFetch GetAlias GetContentArray
GetContentArrayForClass GetContentArrayForProperty GetManagerLinks GetNewManagerLinks
GetNextIndex GetStatsDimension GetValueAt IsAckRequested
IsAcknowledgment IsAcknowledgmentTo IsMutableSet IsResponse
IsResponseTo IsStatusRequest IsSyncReply MapEnsembleErrorToebXMLError
MapebXMLErrorToEnsembleError MessageErrorStatus PokeDocType SetValueAt
TypeVersionGet Validate XMLAfterExport XMLBeforeExport
XMLDTD XMLExport XMLExportInternal XMLExportToStream
XMLExportToString XMLGetSchemaImports XMLImport XMLImportInternal
XMLIsObjectEmpty XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType getTestNewArg showContents showTopLinks

Subclasses
EnsLib.ebXML.MessageWithPayload

Parameters


• parameter SCHEMAPACKAGE = "EnsLib.ebXML.schema";
Parameter allows the base package for the ebXML schema classes to be overriden

Properties


• property DocType as %String(XMLPROJECTION="NONE");
Reference to associated Schema Id
• property DocTypeCategory as %String(XMLPROJECTION="NONE");
the category portion of the DocType
• property DocTypeName as %String(XMLPROJECTION="NONE");
Stored raw document type name ; the secondary type name portion of the DocType
• property Headers as array of EnsLib.ebXML.SOAPHeader(CLASSNAME=1);
SOAP Headers associated with this ebXML message
• property Identifier as %String(XMLPROJECTION="NONE");
Unique document identification string found in document content
• property Name as %String(XMLPROJECTION="NONE");
Raw type name of document as declared in document content
• property RawContent as %String(XMLPROJECTION="NONE");
• property TypeVersion as %String(XMLPROJECTION="NONE");
Raw type version of document if declared in document content

Methods


• method %GetContentType() as %String
This method is called by the Management Portal to determine the content type that will be returned by the %ShowContents method.
• method %ShowContents(pZenOutput As %Boolean = 0)
This method is called by the Management Portal to display a message-specific content viewer.
This method displays its content by writing out to the current device.
• method %ShowContentsHead(pZenOutput As %Boolean = 0)
Write out style information for the HTML display produced by the %ShowContents method.
• method BuildAckHeader(pInAckTo As EnsLib.ebXML.Message, pMessageId As %String, pAction As %String = $$$EnsebXMLMessageServiceAcknowledgmentAction, pService As %String = $$$EnsebXMLMessageService) as %Status
Construct an acknowledgment message to this message
• method BuildErrorList(pInRefTo As EnsLib.ebXML.Message, pMessageId As %String, pAction As %String = $$$EnsebXMLMessageServiceMessageErrorAction, pService As %String = $$$EnsebXMLMessageService, pStatus As %Status, pSeverity As %String = $$$EnsebXMLErrorSeverityError) as %Status
Construct an error response message to this message
• method BuildReplyHeader(pInReplyTo As EnsLib.ebXML.Message, pMessageId As %String, pAction As %String, pService As %String, pAckRequested As %Boolean = 0) as %Status
Construct reply message headers
• method ConstructSchemaClassInstance(pClassName As %String) as %RegisteredObject
Method to construct instances of ebXML schema classes. Can be overriden for custom schema classes/packages.
• classmethod GetContentArray(Output pContents, pMode As %String = "source", pDocType As %String = "", pLevel As %Integer = 0, pIncludeBase As %Boolean = 0) as %Status
Returns array of properties that make up the contents of this object.
This method in implemented within the document class.
The content array is in the form:
pContents(n,"type")="%String"
pContents(n,"name")="Field"
pContents(n,"alias")=alias code
If pContents(n) is non-zero then the property is a composite type with
sub-properties. The sub-properties are indexed with a similar structure under
pContents(n,m) where m is the index of the subtype property.
• classmethod GetContentArrayForClass(Output pContents, pClassName As %String, pPropertyName As %String = $P(pClassName, ".", $L(pClassName, ".")), pInherit As %Boolean = 0) as %Status
Helper method for GetContentArray()
• classmethod GetContentArrayForProperty(Output pContents, pClass As %String, pProperty As %String, pRecurse As %Boolean = 1) as %Status
Generate a content array entry for the specified class/property
• method GetValueAt(pPath As %String, pFormat As %String, ByRef pStatus As %Status) as %String
VDoc style accessor
• method IsAckRequested() as %Boolean
Returns true if the message is requesting an Acknowledgement
• method IsAcknowledgment(pRefToMessageId As %String = "") as %Boolean
Returns true if the message is an Acknowledgement If pRefToMessageId is supplied, then there is an additional constraint of matching the RefToMessageId.
• method IsAcknowledgmentTo(pMessage As EnsLib.ebXML.Message) as %Boolean
Returns true if the message is an Acknowledgement If pRefToMessageId is supplied, then there is an additional constraint of matching the RefToMessageId.
• method IsResponse(pRefToMessageId As %String = "") as %Boolean
Returns true if the message appears to be in reply to another message If pRefToMessageId is supplied, then there is an additional constraint of matching the RefToMessageId.
• method IsResponseTo(pMessage As EnsLib.ebXML.Message) as %Boolean
Returns true if this message is a reply to the specified message.
• method IsStatusRequest() as %Boolean
Returns true if this is a status request
• method IsSyncReply() as %Boolean
Returns true if the message has a SyncReply header. Note that in a valid ebXML message, the presence of SyncReply must be consistent with the CPA's syncReplyMode setting.
• method MapEnsembleErrorToebXMLError(pStatusCode As %String) as %String
Convert InterSystems IRIS status codes into ebXML Error codes
• method MapebXMLErrorToEnsembleError(pebXMLCode As %String) as %String
Convert an ebXML Error code into an appropriate InterSystems IRIS status code
• method MessageErrorStatus() as %Status
Check the ebXML message for an error list, and if present, convert into a %Status value
• method SetValueAt(pValue As %String, pPath As %String, pKey As %String = "", pAction As %String = "set") as %Status
This method sets the value of the given property.
This is implemented by the document class.
pPath contains the property name.
pAction contains an action code: "set", etc..
pKey contains an optional key value.
• private classmethod escapeXMLStream(pStream As %Stream.Object)
Escape XML stream data for HTML display
• method showContents()
HTML display helper to simplify output of message properties.
• method showTopLinks()
HTML display helper to simplify output of links.