Skip to main content

HS.Message.IHE.XDSI.RetrieveResponse

persistent class HS.Message.IHE.XDSI.RetrieveResponse extends HS.Util.EnsRequest, HS.Message.XMLMessage

SQL Table Name: HS_Message_IHE_XDSI.RetrieveResponse

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = XDSI-RetrieveResponse;
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

property DocumentResponses as list of HS.Message.IHE.XDSI.DocumentResponse;
List of response documents; do not insert directly, install use AddDocument and AddAttachment
Property methods: DocumentResponsesBuildValueArray(), DocumentResponsesCollectionToDisplay(), DocumentResponsesCollectionToOdbc(), DocumentResponsesDisplayToCollection(), DocumentResponsesGet(), DocumentResponsesGetObject(), DocumentResponsesGetObjectId(), DocumentResponsesGetStored(), DocumentResponsesGetSwizzled(), DocumentResponsesIsValid(), DocumentResponsesOdbcToCollection(), DocumentResponsesSet(), DocumentResponsesSetObject(), DocumentResponsesSetObjectId()
property Errors as HS.Types.IHE.Errors;
List of response errors; do not insert directly, instead use AddError
Property methods: ErrorsGet(), ErrorsGetObject(), ErrorsGetObjectId(), ErrorsGetStored(), ErrorsGetSwizzled(), ErrorsIsEmpty(), ErrorsIsValid(), ErrorsNewObject(), ErrorsSet(), ErrorsSetObject(), ErrorsSetObjectId(), ErrorsUnSwizzle()
property Status as %String (MAXLEN = 255);
Automatically calcuated based on calls to AddError, AddDocument, and AddAttachment
Property methods: StatusDisplayToLogical(), StatusGet(), StatusGetStored(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()

Methods

method AddAttachment(pAttach As HS.IHE.Common.Messages.MIMEAttachment) as %Status
Append attachment, moves stream to temp file (does NOT update status)
method AddDocument(pDocument As HS.Message.IHE.XDSI.DocumentResponse) as %Status
Append document, move inline to attachment, and update status
method AddError(pError As HS.Types.IHE.Error)
Append error, cleanup description, ensure location, and update status
method FinalizeStatus()
Ensure status is set and at least one error message if not successful
method MoveInlineDocument(pDocument As HS.Message.IHE.XDSI.DocumentResponse) as %Status
method MoveInlineDocuments() as %Status
Move any inline documents to attachments

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)

^Ens.MessageBodyD(ID)
=
%%CLASSNAME

Storage Model: Storage (HS.Util.EnsRequest)

^Ens.MessageBodyD(ID,"EnsRequest")
=
HSCoreVersion
HSMinVersion
%ClearFields

Storage Model: Storage (HS.Message.IHE.XDSI.RetrieveResponse)

^Ens.MessageBodyD(ID,"HS.Message.IHE.XDSI.RetrieveResponse.AdditionalInfo",n)
=
AdditionalInfo(n)

Storage Model: Storage (HS.Message.IHE.XDSI.RetrieveResponse)

^Ens.MessageBodyD(ID,"HS.Message.IHE.XDSI.RetrieveResponse.CustomAuditInfo",n)
=
CustomAuditInfo(n)

Storage Model: Storage (HS.Message.IHE.XDSI.RetrieveResponse)

^Ens.MessageBodyD(ID,"RetrieveResponse")
=
Status
DocType
DocumentResponses
ContentStream
StreamCollection
SOAPFault
SAMLData
Errors
Name

Subclasses

FeedbackOpens in a new tab