Home > Class Reference > ENSLIB namespace > EnsLib.ITK.Framework.RequestData

EnsLib.ITK.Framework.RequestData

persistent class EnsLib.ITK.Framework.RequestData extends EnsLib.ITK.Framework.RequestBase

SQL Table Name: EnsLib_ITK_Framework.RequestData

Request class to carry details and metadata of a Web Request.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property Action as %String);
Holds the underlying ITK Action (WS)
Property methods: ActionDisplayToLogical(), ActionGet(), ActionGetStored(), ActionIsValid(), ActionLogicalToDisplay(), ActionLogicalToOdbc(), ActionNormalize(), ActionSet()
property Created as %String);
When the message was Created (WS-S)
Property methods: CreatedDisplayToLogical(), CreatedGet(), CreatedGetStored(), CreatedIsValid(), CreatedLogicalToDisplay(), CreatedLogicalToOdbc(), CreatedNormalize(), CreatedSet()
property DistributionEnvelope as EnsLib.EDI.XML.Document;
Distribution Envelope (as XML VDOC Document) without any payload Note this is only present if there is a Distribution Envelope
Property methods: DistributionEnvelopeGet(), DistributionEnvelopeGetObject(), DistributionEnvelopeGetObjectId(), DistributionEnvelopeGetStored(), DistributionEnvelopeGetSwizzled(), DistributionEnvelopeIsValid(), DistributionEnvelopeNewObject(), DistributionEnvelopeSet(), DistributionEnvelopeSetObject(), DistributionEnvelopeSetObjectId(), DistributionEnvelopeUnSwizzle()
property DistributionMode as %String;
The mode under which we should distribute entries
Property methods: DistributionModeDisplayToLogical(), DistributionModeGet(), DistributionModeGetStored(), DistributionModeIsValid(), DistributionModeLogicalToDisplay(), DistributionModeLogicalToOdbc(), DistributionModeNormalize(), DistributionModeSet()
property Expires as %String);
When the message expires (WS-S)
Property methods: ExpiresDisplayToLogical(), ExpiresGet(), ExpiresGetStored(), ExpiresIsValid(), ExpiresLogicalToDisplay(), ExpiresLogicalToOdbc(), ExpiresNormalize(), ExpiresSet()
property FaultCode as %String;
Holds the faul code if this request is a fault response
Property methods: FaultCodeDisplayToLogical(), FaultCodeGet(), FaultCodeGetStored(), FaultCodeIsValid(), FaultCodeLogicalToDisplay(), FaultCodeLogicalToOdbc(), FaultCodeNormalize(), FaultCodeSet()
property FaultTo as %String);
Who any fault should be sent to (WS-A)
Property methods: FaultToDisplayToLogical(), FaultToGet(), FaultToGetStored(), FaultToIsValid(), FaultToLogicalToDisplay(), FaultToLogicalToOdbc(), FaultToNormalize(), FaultToSet()
property InvocationPattern as %String;
The invocation pattern based on the business service or the source application registry entry
Property methods: InvocationPatternDisplayToLogical(), InvocationPatternGet(), InvocationPatternGetStored(), InvocationPatternIsValid(), InvocationPatternLogicalToDisplay(), InvocationPatternLogicalToOdbc(), InvocationPatternNormalize(), InvocationPatternSet()
property MessageId as %String);
The ID of the message (WS-A)
Property methods: MessageIdDisplayToLogical(), MessageIdGet(), MessageIdGetStored(), MessageIdIsValid(), MessageIdLogicalToDisplay(), MessageIdLogicalToOdbc(), MessageIdNormalize(), MessageIdSet()
property OriginalRelatesTo as %String);
Only used for responses. Populated by the callback response handler
Property methods: OriginalRelatesToDisplayToLogical(), OriginalRelatesToGet(), OriginalRelatesToGetStored(), OriginalRelatesToIsValid(), OriginalRelatesToLogicalToDisplay(), OriginalRelatesToLogicalToOdbc(), OriginalRelatesToNormalize(), OriginalRelatesToSet()
property Payload as %Stream.GlobalCharacter;
The payload itself
Property methods: PayloadDelete(), PayloadGet(), PayloadGetObject(), PayloadGetObjectId(), PayloadGetStored(), PayloadGetSwizzled(), PayloadIsValid(), PayloadNewObject(), PayloadOid(), PayloadOpen(), PayloadSet(), PayloadSetObject(), PayloadSetObjectId(), PayloadUnSwizzle()
property RelatesTo as %String);
The message this message relates to (WS-A)
Property methods: RelatesToDisplayToLogical(), RelatesToGet(), RelatesToGetStored(), RelatesToIsValid(), RelatesToLogicalToDisplay(), RelatesToLogicalToOdbc(), RelatesToNormalize(), RelatesToSet()
property ReplyTo as %String);
Who any reply should be re-directed to (WS-A)
Property methods: ReplyToDisplayToLogical(), ReplyToGet(), ReplyToGetStored(), ReplyToIsValid(), ReplyToLogicalToDisplay(), ReplyToLogicalToOdbc(), ReplyToNormalize(), ReplyToSet()
property ResolvedEndpoint as %String);
Holds the resolved endpoint
Property methods: ResolvedEndpointDisplayToLogical(), ResolvedEndpointGet(), ResolvedEndpointGetStored(), ResolvedEndpointIsValid(), ResolvedEndpointLogicalToDisplay(), ResolvedEndpointLogicalToOdbc(), ResolvedEndpointNormalize(), ResolvedEndpointSet()
property SequenceNumber as %Integer;
The sequence number (WS-A)
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberGetStored(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet(), SequenceNumberXSDToLogical()
property SourceApplication as %String;
The application that has invoked the (WS-A)
Property methods: SourceApplicationDisplayToLogical(), SourceApplicationGet(), SourceApplicationGetStored(), SourceApplicationIsValid(), SourceApplicationLogicalToDisplay(), SourceApplicationLogicalToOdbc(), SourceApplicationNormalize(), SourceApplicationSet()
property SourceDevice as %String;
Only used for responses. Populated by the callback response handler
Property methods: SourceDeviceDisplayToLogical(), SourceDeviceGet(), SourceDeviceGetStored(), SourceDeviceIsValid(), SourceDeviceLogicalToDisplay(), SourceDeviceLogicalToOdbc(), SourceDeviceNormalize(), SourceDeviceSet()
property Status as %Status;
Holds the status of the request (if the request is a fault this will not be OK)
Property methods: StatusGet(), StatusGetStored(), StatusIsValid(), StatusLogicalToOdbc(), StatusLogicalToXSD(), StatusSet(), StatusXSDToLogical()
property To as %String);
Who the message is addressed to at a SOAP level (WS-A)
Property methods: ToDisplayToLogical(), ToGet(), ToGetStored(), ToIsValid(), ToLogicalToDisplay(), ToLogicalToOdbc(), ToNormalize(), ToSet()

Methods (Including Private)

private classmethod %OnDelete(oid As %ObjectIdentity) as %Status
Need to clean up DistributionEnvelope
method ModifyAction(ByRef action As %String, behaviourType As %String) as %Status