Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %SOAP.RM.SequenceAcknowledgement
Private  Storage   


class %SOAP.RM.SequenceAcknowledgement extends

SequenceAcknowledgement SOAP header as defined in WS-ReliableMessaging 1.2.

[ [ [  + | 
  ] |
   wsrm:MessageNumberType  + 


Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 5 2


%headerId AcknowledgementRange Fault Final
HeaderBufferIndex Identifier Nack None
XmlId actor mustUnderstand role

%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject %XMLGenerate CreateHeader GetId
ImportHeader RewriteHeader UpdateSession WriteHeader
XMLAfterExport XMLBeforeExport XMLDTD XMLExport
XMLExportInternal XMLExportToStream XMLExportToString XMLGetSchemaImports
XMLImport XMLImportInternal XMLIsObjectEmpty XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType roleGet


• parameter ELEMENTQUALIFIED = 1;
ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
• parameter NAMESPACE = "http://docs.oasis-open.org/ws-rx/wsrm/200702";
NAMESPACE specifies the XML namespace to be used when projecting the class to XML. if NAMESPACE - "", the default namespace is used for the XML schema is used as the namespace for his class.
OUTPUTTYPEATTRIBUTE allows the programmer to force the xsi:type attribute to be included in all elements of a SOAP message which is a web client request or web service response. If specified, this parameter overrides the OUTPUTTYPEATTRIBUTE of the client or service.
• parameter XMLFORMAT = "literal";
The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport methods for XML enabled classes to include code for only literal or only encoded format. This allows the generated routines to be significantly smaller since usually both formats are not needed.
If XMLFORMAT="Literal", then only support for literal format import and export is generated.
If XMLFORMAT="Encoded", then only support for SOAP encoded format import and export is generated.
The default is to generate support for both literal and encoded format.
The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
• parameter XMLPREFIX = "wsrm";
The XMLPREFIX parameter controls the prefix to be used for the XML namespace that is given by the NAMESPACE parameter.


• property AcknowledgementRange as list of %SOAP.RM.AcknowledgementRange(XMLPROJECTION="element");
• property Final as %String;
Should never have a value except empty string. Set to $c(0) to show element and "" to not show element.
• property Identifier as %xsd.anyURI;
• property Nack as list of %SOAP.RM.MessageNumberType(XMLPROJECTION="element");
• property None as %String;
Should never have a value except empty string. Set to $c(0) to show element and "" to not show element.


• classmethod CreateHeader(session As %SYS.RMSession, request As %Boolean) as %SOAP.RM.SequenceAcknowledgement
Create SequenceAcknowledgement header based on WS-ReliableMessaging session
• method UpdateSession(session As %SYS.RMSession)
Update session based on acknowledgement