Home > Class Reference > ENSLIB namespace > EnsLib.SOAP.GenericMessage
Private  Storage   

EnsLib.SOAP.GenericMessage


persistent class EnsLib.SOAP.GenericMessage extends EnsLib.HTTP.GenericMessage

Transport contents of a SOAP request or response through Ensemble

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 4 2 1


Summary


Properties
Attributes Doc EnvelopeDoc EnvelopeStream
HTTPHeaders OriginalFilename Stream Type

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %CompareContents
%ComposeOid %ConstructClone %Delete %DeleteExtent
%DeleteId %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawHTMLForm %DrawHTMLTable %Exists %ExistsId
%Extends %GUID %GUIDSet %GetContentType
%GetLock %GetParameter %GetSwizzleObject %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%OnNew %OnTimeout %Open %OpenId
%OriginalNamespace %PackageName %PhysicalAddress %ProcessSubmit
%PurgeIndices %Reload %RemoveFromSaveSet %ResolveConcurrencyConflict
%RollBack %Save %SaveDirect %SaveIndices
%SerializeObject %SetModified %ShowContents %ShowContentsHead
%SortBegin %SortEnd %SyncObjectIn %SyncTransport
%UnlockExtent %UnlockId %ValidateIndices %ValidateObject
GetStatsDimension SetAttributes SetHTTPHeaders StreamGet
StreamSet XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLSchema XMLSchemaNamespace XMLSchemaType


Parameters


• parameter XMLNAME = "SOAPMessage";
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
• parameter XMLTYPE = "SOAPMessage";
This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties


• property Doc as EnsLib.EDI.XML.Document(XMLPROJECTION="NONE");
If both Stream and Doc exist, Stream is definitive for output
• property EnvelopeDoc as EnsLib.EDI.XML.Document(XMLPROJECTION="NONE");
If both EnvelopeStream and EnvelopeDoc exist, EnvelopeStream is definitive for output
• property EnvelopeStream as %GlobalCharacterStream;
• property HTTPHeaders as array of %String(MAXLEN="");
An array of strings containing any HTTP header values

Methods


• method %OnNew(pBodyStream As %CacheString = $$$NULLOREF, pAttributes As %Collection.ArrayOfDT = $$$NULLOREF, pHTTPHeaders As %Collection.ArrayOfDT = $$$NULLOREF, pEnvelopeStream As %AbstractStream = $$$NULLOREF, pBodyDoc=$$$NULLOREF, pEnvelopeDoc=$$$NULLOREF) as %Status
This callback method is invoked by the %New method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.


Triggers


•trigger OnDelete (BEFORE event DELETE)