Home > Class Reference > HSLIB namespace > HS.Message.ECRQueryResponse

HS.Message.ECRQueryResponse

persistent class HS.Message.ECRQueryResponse extends HS.Util.EnsResponse

SQL Table Name: HS_Message.ECRQueryResponse

Property Inventory

Parameters

parameter XMLIGNORENULL = inputonly;
Inherited description: If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

Properties

property Action as %String;
For a pure query edge that is not returning any data, set Action=0 This is for use cases where we are querying even if we don't know if a record exists
Property methods: ActionDisplayToLogical(), ActionGet(), ActionGetStored(), ActionIsValid(), ActionLogicalToDisplay(), ActionLogicalToOdbc(), ActionNormalize(), ActionSet()
property ContentStream as %Stream.GlobalCharacter;
The SDA3 contents returned by the query
Property methods: ContentStreamDelete(), ContentStreamGet(), ContentStreamGetObject(), ContentStreamGetObjectId(), ContentStreamGetStored(), ContentStreamGetSwizzled(), ContentStreamIsValid(), ContentStreamListBuildValueArray(), ContentStreamListCollectionToDisplay(), ContentStreamListCollectionToOdbc(), ContentStreamListDelete(), ContentStreamListDisplayToCollection(), ContentStreamListGet(), ContentStreamListGetObject(), ContentStreamListGetObjectId(), ContentStreamListGetStored(), ContentStreamListGetSwizzled(), ContentStreamListIsValid(), ContentStreamListOdbcToCollection(), ContentStreamListOid(), ContentStreamListOpen(), ContentStreamListSet(), ContentStreamListSetObject(), ContentStreamListSetObjectId(), ContentStreamNewObject(), ContentStreamOid(), ContentStreamOpen(), ContentStreamSet(), ContentStreamSetObject(), ContentStreamSetObjectId(), ContentStreamUnSwizzle()
property ContentStreamList as list of %Stream.GlobalCharacter;
Instead of populating a single ContentStream, the data source can populate a list of SDA3 streams which can be loaded sequentially. This is used, for instance, from an XDSb document repository.
Property methods: ContentStreamListBuildValueArray(), ContentStreamListCollectionToDisplay(), ContentStreamListCollectionToOdbc(), ContentStreamListDelete(), ContentStreamListDisplayToCollection(), ContentStreamListGet(), ContentStreamListGetObject(), ContentStreamListGetObjectId(), ContentStreamListGetStored(), ContentStreamListGetSwizzled(), ContentStreamListIsValid(), ContentStreamListOdbcToCollection(), ContentStreamListOid(), ContentStreamListOpen(), ContentStreamListSet(), ContentStreamListSetObject(), ContentStreamListSetObjectId()
property MPIUpdateFlag as %String;
Flag to control when the MPI should be updated. If unspecified, it's left up to the ECR
Property methods: MPIUpdateFlagDisplayToLogical(), MPIUpdateFlagGet(), MPIUpdateFlagGetStored(), MPIUpdateFlagIsValid(), MPIUpdateFlagLogicalToDisplay(), MPIUpdateFlagLogicalToOdbc(), MPIUpdateFlagNormalize(), MPIUpdateFlagSet()
property NoChange as %Boolean;
For an external system that can do selective updates, if there's nothing to update, it can set this instead of returning a ContentStream
Property methods: NoChangeDisplayToLogical(), NoChangeGet(), NoChangeGetStored(), NoChangeIsValid(), NoChangeLogicalToDisplay(), NoChangeLogicalToXSD(), NoChangeNormalize(), NoChangeSet(), NoChangeXSDToLogical()
property ResponseString as %String);
This is a message returned by the external system when we query this record, which will be passed back the next time we query, so that they can give us selective updates. It typically would have some sort of timestamp. For CacheType=NotifyAndQuery or ExpireAndQuery
Property methods: ResponseStringDisplayToLogical(), ResponseStringGet(), ResponseStringGetStored(), ResponseStringIsValid(), ResponseStringLogicalToDisplay(), ResponseStringLogicalToOdbc(), ResponseStringNormalize(), ResponseStringSet()

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.EnsResponse)

^Ens.MessageBodyD(ID,"EnsResponse")
=
HSCoreVersion
HSMinVersionError

Storage Model: Storage (HS.Message.ECRQueryResponse)

^Ens.MessageBodyD(ID,"ECRQueryResponse")
=
ContentStream
ResponseString
NoChange
ContentStreamList
MPIUpdateFlag
Action
FeedbackOpens in a new window