Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

XKMSCompoundResult Class Reference
[XML Key Management System Implementation]

#include <XKMSCompoundResult.hpp>

Inheritance diagram for XKMSCompoundResult:

Inheritance graph
[legend]
Collaboration diagram for XKMSCompoundResult:

Collaboration graph
[legend]
List of all members.

Detailed Description

Interface definition for the CompoundResult elements.

The <CompoundResult> is used to merge a number of separate requests into a single message. It is a very simple type - simply a holding Result that has all the sub-Results held within it.

The schema definition for CompoundResult is as follows :

   <!-- CompoundResult -->
   <element name="CompoundResult" type="xkms:CompoundResultType"/>
   <complexType name="CompoundResultType">
      <complexContent>
         <extension base="xkms:ResultType">
            <choice minOccurs="0" maxOccurs="unbounded">
               <element ref="xkms:LocateResult"/>
               <element ref="xkms:ValidateResult"/>
               <element ref="xkms:RegisterResult"/>
               <element ref="xkms:ReissueResult"/>
               <element ref="xkms:RecoverResult"/>
               <element ref="xkms:RevokeResult"/>
            </choice>
         </extension>
      </complexContent>
   </complexType>
   <!-- /CompoundResult -->


Constructors and Destructors

virtual ~XKMSCompoundResult ()
 XKMSCompoundResult ()

Public Member Functions

Getter Interface Methods
virtual XERCES_CPP_NAMESPACE_QUALIFIER
DOMElement * 		getElement (void) const =0
 Return the element at the base of the message.
virtual int getResultListSize (void)=0
 Obtain the number of results within the compound result.
virtual XKMSResultType * getResultListItem (int item)=0
 Obtain a Result item.
Setter Interface Methods
virtual XKMSLocateResult * createLocateResult (XKMSLocateRequest *request, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
 Create a new <LocateResult> message.
virtual XKMSValidateResult * createValidateResult (XKMSValidateRequest *request, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
 Create a new <ValidateResult> message.
virtual XKMSStatusResult * createStatusResult (XKMSStatusRequest *request, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
 Create a new <StatusResult> message.
virtual XKMSRegisterResult * createRegisterResult (XKMSRegisterRequest *request, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
 Create a new <RegisterResult> message.
virtual XKMSResult * createResult (XKMSRequestAbstractType *request, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
 Create a new <Result> message.

Constructor & Destructor Documentation

XKMSCompoundResult::XKMSCompoundResult (   )  [inline, protected]
 

virtual XKMSCompoundResult::~XKMSCompoundResult (   )  [inline, virtual]
 

Member Function Documentation

virtual XKMSLocateResult* XKMSCompoundResult::createLocateResult (  XKMSLocateRequest *  request,
XKMSResultType::ResultMajor  rmaj,
XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor,
const XMLCh *  id = NULL
)  [pure virtual]
 

Create a new <LocateResult> message.

Generates a new LocateResult message from scratch, building the DOM as it goes. The response will be based on a input LocateRequest message which is used to provide Id etc.

Parameters:
request Request to base response on
id Value to set in the Id field. If NULL, the library will
rmaj Major result code
rmin Minor result code generate a new Unique Id value.
Returns:
the new XKMSLocateResponse structure

virtual XKMSRegisterResult* XKMSCompoundResult::createRegisterResult (  XKMSRegisterRequest *  request,
XKMSResultType::ResultMajor  rmaj,
XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor,
const XMLCh *  id = NULL
)  [pure virtual]
 

Create a new <RegisterResult> message.

Generates a new RegisterResult message from scratch, building the DOM as it goes. The response will be based on a input RegisterRequest message which is used to provide Id etc.

Parameters:
request Request to base response on
id Value to set in the Id field. If NULL, the library will
rmaj Major result code
rmin Minor result code generate a new Unique Id value.
Returns:
the new XKMSRegisterResult structure

virtual XKMSResult* XKMSCompoundResult::createResult (  XKMSRequestAbstractType *  request,
XKMSResultType::ResultMajor  rmaj,
XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor,
const XMLCh *  id = NULL
)  [pure virtual]
 

Create a new <Result> message.

Generates a new Result message from scratch, building the DOM as it goes. The response will be based on an input Request message which is used to provide Id etc.

Parameters:
request Request to base response on
id Value to set in the Id field. If NULL, the library will
rmaj Major result code
rmin Minor result code generate a new Unique Id value.
Returns:
the new XKMSResult structure

virtual XKMSStatusResult* XKMSCompoundResult::createStatusResult (  XKMSStatusRequest *  request,
XKMSResultType::ResultMajor  rmaj,
XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor,
const XMLCh *  id = NULL
)  [pure virtual]
 

Create a new <StatusResult> message.

Generates a new StatusResult message from scratch, building the DOM as it goes. The response will be based on a input StatusRequest message which is used to provide Id etc.

Parameters:
request Request to base response on
id Value to set in the Id field. If NULL, the library will
rmaj Major result code
rmin Minor result code generate a new Unique Id value.
Returns:
the new XKMSStatusResponse structure

virtual XKMSValidateResult* XKMSCompoundResult::createValidateResult (  XKMSValidateRequest *  request,
XKMSResultType::ResultMajor  rmaj,
XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor,
const XMLCh *  id = NULL
)  [pure virtual]
 

Create a new <ValidateResult> message.

Generates a new ValidateResult message from scratch, building the DOM as it goes. The response will be based on a input ValidateRequest message which is used to provide Id etc.

Parameters:
request Request to base response on
id Value to set in the Id field. If NULL, the library will
rmaj Major result code
rmin Minor result code generate a new Unique Id value.
Returns:
the new XKMSLocateResponse structure

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* XKMSCompoundResult::getElement (  void   )  const [pure virtual]
 

Return the element at the base of the message.

Implements XKMSMessageAbstractType.

virtual XKMSResultType* XKMSCompoundResult::getResultListItem (  int  item  )  [pure virtual]
 

Obtain a Result item.

Obtain a particular Result from the list of Results held in this compound object

Returns:
The nominated item

virtual int XKMSCompoundResult::getResultListSize (  void   )  [pure virtual]
 

Obtain the number of results within the compound result.

This class holds a list of results that can be accessed using the getResultListItem method. This method allows an application to determine how many result items there are.

Returns:
The size of the Result list

The documentation for this class was generated from the following file:
Generated on Sun Jul 3 17:44:08 2005 for XML-Security-C by  doxygen 1.4.2