Home > Class Reference > HSLIB namespace > HS.Types.RequestInfo

HS.Types.RequestInfo

class HS.Types.RequestInfo extends HS.Types.AuthorizationInfo, HS.Util.CopyFrom, %Library.RegisteredObject, %XML.Adaptor, %ZEN.DataModel.ObjectDataModel

Property Inventory

Method Inventory

Parameters

parameter DOMAIN = HS;
Inherited description: Localization domain. DataModel classes that wish to support localization must provide a value for this within subclasses.
parameter XMLIGNOREINVALIDTAG = 1;
Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.

Properties

property AdditionalInfo as array of HS.Types.AdditionalInfoItem;
Additional request information
Property methods: AdditionalInfoBuildValueArray(), AdditionalInfoCollectionToDisplay(), AdditionalInfoCollectionToOdbc(), AdditionalInfoDisplayToCollection(), AdditionalInfoDisplayToLogical(), AdditionalInfoGet(), AdditionalInfoGetObject(), AdditionalInfoGetObjectId(), AdditionalInfoGetSwizzled(), AdditionalInfoIsValid(), AdditionalInfoLogicalToDisplay(), AdditionalInfoLogicalToOdbc(), AdditionalInfoNormalize(), AdditionalInfoOdbcToCollection(), AdditionalInfoSet(), AdditionalInfoSetObject(), AdditionalInfoSetObjectId()
property BreakTheGlass as %Boolean (ZENHIDDEN = 1) [ InitialExpression = 0 ];
Enabling this may be in violation of federal law ... check with your lawyers
Property methods: BreakTheGlassDisplayToLogical(), BreakTheGlassGet(), BreakTheGlassIsValid(), BreakTheGlassLogicalToDisplay(), BreakTheGlassLogicalToXSD(), BreakTheGlassNormalize(), BreakTheGlassSet(), BreakTheGlassXSDToLogical()
property ClinicalTypes as %String);
Clinical types
Property methods: ClinicalTypesDisplayToLogical(), ClinicalTypesGet(), ClinicalTypesIsValid(), ClinicalTypesLogicalToDisplay(), ClinicalTypesLogicalToOdbc(), ClinicalTypesNormalize(), ClinicalTypesSet()
Consent information
Property methods: ConsentDisplayToLogical(), ConsentGet(), ConsentIsValid(), ConsentLogicalToDisplay(), ConsentLogicalToOdbc(), ConsentNormalize(), ConsentSet()
property CustomAuditInfo as array of %String);
Data passed in here will be copied to CustomPairs when audited
Property methods: CustomAuditInfoBuildValueArray(), CustomAuditInfoCollectionToDisplay(), CustomAuditInfoCollectionToOdbc(), CustomAuditInfoDisplayToCollection(), CustomAuditInfoDisplayToLogical(), CustomAuditInfoGet(), CustomAuditInfoGetObject(), CustomAuditInfoGetObjectId(), CustomAuditInfoGetSwizzled(), CustomAuditInfoIsValid(), CustomAuditInfoLogicalToDisplay(), CustomAuditInfoLogicalToOdbc(), CustomAuditInfoNormalize(), CustomAuditInfoOdbcToCollection(), CustomAuditInfoSet(), CustomAuditInfoSetObject(), CustomAuditInfoSetObjectId()
property RequestId as %String (MAXLEN = 128, ZENHIDDEN = 1);
Request Audit ID *** Must always be set and passed around ***
Property methods: RequestIdDisplayToLogical(), RequestIdGet(), RequestIdIsValid(), RequestIdLogicalToDisplay(), RequestIdLogicalToOdbc(), RequestIdNormalize(), RequestIdSet()
property RequestingForProxyID as %String (ZENHIDDEN = 1);
If this is for a proxy, the internal ID of the proxied user
Property methods: RequestingForProxyIDDisplayToLogical(), RequestingForProxyIDGet(), RequestingForProxyIDIsValid(), RequestingForProxyIDLogicalToDisplay(), RequestingForProxyIDLogicalToOdbc(), RequestingForProxyIDNormalize(), RequestingForProxyIDSet()
property RequestingForProxyUserID as %String (ZENHIDDEN = 1);
If this is for a proxy, the $username of the proxied user
Property methods: RequestingForProxyUserIDDisplayToLogical(), RequestingForProxyUserIDGet(), RequestingForProxyUserIDIsValid(), RequestingForProxyUserIDLogicalToDisplay(), RequestingForProxyUserIDLogicalToOdbc(), RequestingForProxyUserIDNormalize(), RequestingForProxyUserIDSet()
property RequestingGateway as %String (MAXLEN = 256, ZENHIDDEN = 1) [ InitialExpression = ##Class(HS.Util.Installer.ConfigItem).GetThisComponentName() ];
An identifier for the access gateway that initiated the request
Property methods: RequestingGatewayDisplayToLogical(), RequestingGatewayGet(), RequestingGatewayIsValid(), RequestingGatewayLogicalToDisplay(), RequestingGatewayLogicalToOdbc(), RequestingGatewayNormalize(), RequestingGatewaySet()
property RequestingUser as %String (ZENHIDDEN = 1) [ InitialExpression = $USERNAME ];
The requesting user
Property methods: RequestingUserDisplayToLogical(), RequestingUserGet(), RequestingUserIsValid(), RequestingUserLogicalToDisplay(), RequestingUserLogicalToOdbc(), RequestingUserNormalize(), RequestingUserRolesDisplayToLogical(), RequestingUserRolesGet(), RequestingUserRolesIsValid(), RequestingUserRolesLogicalToDisplay(), RequestingUserRolesLogicalToOdbc(), RequestingUserRolesNormalize(), RequestingUserRolesSet(), RequestingUserSet()
property RequestingUserRoles as %String) [ InitialExpression = $ROLES ];
The roles for the requesting user
Property methods: RequestingUserRolesDisplayToLogical(), RequestingUserRolesGet(), RequestingUserRolesIsValid(), RequestingUserRolesLogicalToDisplay(), RequestingUserRolesLogicalToOdbc(), RequestingUserRolesNormalize(), RequestingUserRolesSet()
property SAMLData as HS.IHE.XUA.SAMLData;
Contains SAML user / rhio / token
Property methods: SAMLDataGet(), SAMLDataGetObject(), SAMLDataGetObjectId(), SAMLDataGetSwizzled(), SAMLDataIsEmpty(), SAMLDataIsValid(), SAMLDataNewObject(), SAMLDataSet(), SAMLDataSetObject(), SAMLDataSetObjectId(), SAMLDataUnSwizzle()
property Signature as %String);
Signature for this request
Property methods: SignatureDisplayToLogical(), SignatureGet(), SignatureIsValid(), SignatureLogicalToDisplay(), SignatureLogicalToOdbc(), SignatureNormalize(), SignatureSet()
property Type as %String (MAXLEN = 512, ZENHIDDEN = 1);
Type for increasing the specificity of a request
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()

Methods

classmethod GetUserInfo(pSource As %RegisteredObject, Output pUserName As %String = $Username, Output pUserRoles As %String = $Roles, Output pBreakTheGlass As %Boolean = 0, pPropertyName As %String = "AdditionalInfo") as %Status [ Language = objectscript ]
Get the user information for a RequestInfo or XMLMessage object
classmethod RequestInfoToXMLMessage(pSource As HS.Types.RequestInfo, pTarget As %RegisteredObject, pPropertyName As %String = "AdditionalInfo") as %Status [ Language = objectscript ]
Insert/Update request info from any message with an AdditionalInfo array. Keys supported: "USER:UserID", "USER:Roles" and "BreakTheGlass".
classmethod XMLMessageToRequestInfo(pSource As %RegisteredObject, pTarget As HS.Types.RequestInfo, pPropertyName As %String = "AdditionalInfo") as %Status [ Language = objectscript ]
Copy request info from any message with an AdditionalInfo array. Keys supported: "USER:UserID", "USER:Roles" and "BreakTheGlass".

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new window