#include <XKMSResultType.hpp>
Inheritance diagram for XKMSResultType:
The <ResultType> is the base type on which Result messages are built. (The <Result> element is a direct implementation)
The schema definition for ResultType is as follows :
<!-- ResultType --> <element name="Result" type="xkms:ResultType"/> <complexType name="ResultType"> <complexContent> <extension base="xkms:MessageAbstractType"> <sequence> <element ref="xkms:RequestSignatureValue" minOccurs="0"/> </sequence> <attribute name="ResultMajor" type="QName" use="required"/> <attribute name="ResultMinor" type="QName" use="optional"/> <attribute name="RequestId" type="NCName" use="optional"/> </extension> </complexContent> </complexType> <!-- /ResultType -->
Constructors and Destructors | |
virtual | ~XKMSResultType () |
XKMSResultType () | |
Public Types | |
enum | ResultMajor { NoneMajor = 0, Success, VersionMismatch, Sender, Receiver, Represent, Pending } |
Definition of Major Result codes. More... | |
enum | ResultMinor { NoneMinor = 0, NoMatch, TooManyResponses, Incomplete, Failure, Refused, NoAuthentication, MessageNotSupported, UnknownResponseId, RepresentRequired, NotSynchronous } |
Public Member Functions | |
Getter Interface Methods | |
virtual ResultMajor | getResultMajor (void) const =0 |
Get the ResultMajor code for the message. | |
virtual ResultMinor | getResultMinor (void) const =0 |
Get the ResultMinor code for the message. | |
virtual const XMLCh * | getRequestId (void) const =0 |
Obtain the RequestId attribute. | |
virtual const XMLCh * | getRequestSignatureValue (void) const =0 |
Obtain the value of the RequestSignatureValue element. | |
Setter interface methods | |
virtual void | setResultMajor (ResultMajor rmaj)=0 |
Set a new value for the ResultMajor of this response. | |
virtual void | setResultMinor (ResultMinor rmin)=0 |
Set a new value for the ResultMinor of this response. | |
virtual void | setRequestId (const XMLCh *id)=0 |
Set the Request Id for the Message. | |
virtual void | setRequestSignatureValue (const XMLCh *value)=0 |
Set the value of the RequestSignatureValue element. |
|
|
|
|
|
|
|
|
Obtain the RequestId attribute. The RequestId attribute matches the Id of the request message to which this response is related.
|
|
Obtain the value of the RequestSignatureValue element. A request can have a ResponseMechanism of RequestSignatureValue. When this is set, the service can place the text within the SignatureValue element into the Result. This call allows a consumer of the result to find the value
|
|
Get the ResultMajor code for the message. All result messages contain a Major Result code defining the overall status of the request performed by the client
|
|
Get the ResultMinor code for the message. Messages may contain a minor result code that better defines the result returned in the ResultMajor code
|
|
Set the Request Id for the Message. Allows a calling application to set a new request Id for the message
|
|
Set the value of the RequestSignatureValue element. A request can have a ResponseMechanism of RequestSignatureValue. When this is set, the service can place the text within the SignatureValue element into the Result. This call allows a service to set this value in a response
|
|
Set a new value for the ResultMajor of this response.
|
|
Set a new value for the ResultMinor of this response.
|