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

EnsLib.SOAP.GenericMessage

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

SQL Table Name: EnsLib_SOAP.GenericMessage

Transport contents of a SOAP request or response through Ensemble

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter XMLNAME = SOAPMessage;
Inherited description: 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;
Inherited description: 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 (Including Private)

property Doc as EnsLib.EDI.XML.Document (XMLPROJECTION = "NONE");
If both Stream and Doc exist, Stream is definitive for output
Property methods: DocGet(), DocGetObject(), DocGetObjectId(), DocGetStored(), DocGetSwizzled(), DocIsValid(), DocNewObject(), DocSet(), DocSetObject(), DocSetObjectId(), DocUnSwizzle()
property EnvelopeDoc as EnsLib.EDI.XML.Document (XMLPROJECTION = "NONE");
If both EnvelopeStream and EnvelopeDoc exist, EnvelopeStream is definitive for output
Property methods: EnvelopeDocGet(), EnvelopeDocGetObject(), EnvelopeDocGetObjectId(), EnvelopeDocGetStored(), EnvelopeDocGetSwizzled(), EnvelopeDocIsValid(), EnvelopeDocNewObject(), EnvelopeDocSet(), EnvelopeDocSetObject(), EnvelopeDocSetObjectId(), EnvelopeDocUnSwizzle()
property EnvelopeStream as %GlobalCharacterStream;
Property methods: EnvelopeStreamDelete(), EnvelopeStreamGet(), EnvelopeStreamGetObject(), EnvelopeStreamGetObjectId(), EnvelopeStreamGetStored(), EnvelopeStreamGetSwizzled(), EnvelopeStreamIsValid(), EnvelopeStreamNewObject(), EnvelopeStreamOid(), EnvelopeStreamOpen(), EnvelopeStreamSet(), EnvelopeStreamSetObject(), EnvelopeStreamSetObjectId(), EnvelopeStreamUnSwizzle()
property HTTPHeaders as array of %String);
An array of strings containing any HTTP header values
Property methods: HTTPHeadersBuildValueArray(), HTTPHeadersCollectionToDisplay(), HTTPHeadersCollectionToOdbc(), HTTPHeadersDisplayToCollection(), HTTPHeadersDisplayToLogical(), HTTPHeadersGet(), HTTPHeadersGetObject(), HTTPHeadersGetObjectId(), HTTPHeadersGetStored(), HTTPHeadersGetSwizzled(), HTTPHeadersIsValid(), HTTPHeadersLogicalToDisplay(), HTTPHeadersLogicalToOdbc(), HTTPHeadersNormalize(), HTTPHeadersOdbcToCollection(), HTTPHeadersSet(), HTTPHeadersSetObject(), HTTPHeadersSetObjectId()

Methods (Including Private)

private classmethod %OnDelete(oid As %ObjectIdentity) as %Status
Need to clean up EnvelopeDoc & Doc
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
Inherited description: 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);

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Storage

Gray indicates storage defined by superclasses.

Storage Model: CacheStorage (Ens.StreamContainer)

^Ens.StreamContainerD(ID,"Attributes",n)
=
Attributes(n)

Storage Model: CacheStorage (Ens.StreamContainer)

^Ens.StreamContainerD(ID)
=
%%CLASSNAME
OriginalFilename
StreamFB
StreamFC
StreamGB
StreamGC
Type
StreamCF
StreamBF
StreamCG
StreamBG
FileCharEncodingTable
CharEncodingTable

Storage Model: CacheStorage (EnsLib.HTTP.GenericMessage)

^Ens.StreamContainerD(ID,"EnsLib.HTTP.GenericMessage.HTTPHeaders",n)
=
HTTPHeaders(n)

Storage Model: CacheStorage (EnsLib.SOAP.GenericMessage)

^Ens.StreamContainerD(ID,"GenericMessage")
=
EnvelopeStream
EnvelopeDoc
Doc

Storage Model: CacheStorage (EnsLib.SOAP.GenericMessage)

^Ens.StreamContainerD(ID,"EnsLib.SOAP.GenericMessage.HTTPHeaders",n)
=
HTTPHeaders(n)