HS.Message.Push.DocumentRequest
persistent class HS.Message.Push.DocumentRequest extends HS.Util.EnsRequest
SQL Table Name: HS_Message_Push.DocumentRequest
Property Inventory
Parameters
parameter RESPONSECLASSNAME = HS.Message.Push.DocumentResponse;
Default response class
Properties
property DocumentId as %String;
Property methods: DocumentIdDisplayToLogical(), DocumentIdGet(), DocumentIdGetStored(), DocumentIdIsValid(), DocumentIdLogicalToDisplay(), DocumentIdLogicalToOdbc(), DocumentIdNormalize(), DocumentIdSet()
property Gateway as %String (MAXLEN = 500);
Property methods: GatewayDisplayToLogical(), GatewayGet(), GatewayGetStored(), GatewayIsValid(), GatewayLogicalToDisplay(), GatewayLogicalToOdbc(), GatewayNormalize(), GatewaySet()
property GetPayload as %Integer [ InitialExpression = 1 ];
0 - don't return a payload
1 - return the payload in the individual stream properties (XMLData, HTMLData, BinaryData, OtherData)
This is used to support delivery options that can't handle attachments.
If the document has attachments, we'll attempt to export the first attachment into one of
these properties, depending on its Mime Type.
2 - return the payload in attachments
Property methods: GetPayloadDisplayToLogical(), GetPayloadGet(), GetPayloadGetStored(), GetPayloadIsValid(), GetPayloadLogicalToDisplay(), GetPayloadNormalize(), GetPayloadSet(), GetPayloadXSDToLogical()
property RequestingGateway as %String (MAXLEN = 256) [ InitialExpression = ##Class(HS.Util.Installer.ConfigItem).GetThisComponentName() ];
An identifier for the access gateway that initiated the request
Property methods: RequestingGatewayDisplayToLogical(), RequestingGatewayGet(), RequestingGatewayGetStored(), RequestingGatewayIsValid(), RequestingGatewayLogicalToDisplay(), RequestingGatewayLogicalToOdbc(), RequestingGatewayNormalize(), RequestingGatewaySet()
property RequestingUser as HS.Types.Username [ InitialExpression = $USERNAME ];
The requesting user
Property methods: RequestingUserDisplayToLogical(), RequestingUserGet(), RequestingUserGetStored(), RequestingUserIsValid(), RequestingUserLogicalToDisplay(), RequestingUserLogicalToOdbc(), RequestingUserNormalize(), RequestingUserSet()
property RequestingUserRoles as %String) [ InitialExpression = $ROLES ];
The roles for the requesting user
Property methods: RequestingUserRolesDisplayToLogical(), RequestingUserRolesGet(), RequestingUserRolesGetStored(), RequestingUserRolesIsValid(), RequestingUserRolesLogicalToDisplay(), RequestingUserRolesLogicalToOdbc(), RequestingUserRolesNormalize(), RequestingUserRolesSet()
Inherited Members
Inherited Properties
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %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()
- %InitExtentData()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %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()
- %ValidateTable()
- GenerateGenericDAOFromObject()
- GetStatsDimension()
- NewResponse()
- OnShowJSONContents()
- OnShowXMLContents()
- OutputFormattedJSON()
- WriteNoJSONFormat()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
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.Push.DocumentRequest)
^Ens.MessageBodyD(ID,"DocumentRequest") |
= | DocumentId
Gateway
RequestingUser
RequestingUserRoles
RequestingGateway
GetPayload
|