XKMSStatusResult Class Reference
[XML Key Management System Implementation]

#include <XKMSStatusResult.hpp>

Inheritance diagram for XKMSStatusResult:

[legend]Collaboration diagram for XKMSStatusResult:

[legend]List of all members.

---

Detailed Description

Interface definition for the StatusResult elements.

The <StatusResult> is used for Asynchronous processing and allows a client to determing whether a Pending response is ready for return.

The schema definition for StatusResponse is as follows :

   <!-- StatusResult -->
   <element name="StatusResult" type="xkms:StatusResultType"/>
   <complexType name="StatusResultType">
      <complexContent>
         <extension base="xkms:ResultType">
            <attribute name="Success" type="integer" use="optional"/>
            <attribute name="Failure" type="integer" use="optional"/>
            <attribute name="Pending" type="integer" use="optional"/>
         </extension>
      </complexContent>
   </complexType>
   <!-- /StatusResult -->

Constructors and Destructors
virtual	~XKMSStatusResult ()
	XKMSStatusResult ()
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.
Count handling
virtual int	getSuccessCount (void) const =0
	Find number of Success messages.
virtual int	getFailureCount (void) const =0
	Find number of Failed messages.
virtual int	getPendingCount (void) const =0
	Find number of Pending messages.
virtual void	setSuccessCount (int count)=0
	Set the number of Success messages.
virtual void	setFailureCount (int count)=0
	Set the number of Failed messages.
virtual void	setPendingCount (int count)=0
	Set the number of Pending messages.

---

Constructor & Destructor Documentation

XKMSStatusResult::XKMSStatusResult (   )  [inline, protected]

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

---

Member Function Documentation

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

Return the element at the base of the message. Implements XKMSMessageAbstractType.

virtual int XKMSStatusResult::getFailureCount (  void   )  const [pure virtual]

Find number of Failed messages. A StatusResult can have a count of messages within a pending CompoundResponse with a Failure result type. Returns: the number of Failed messages in a pending CompoundResponse

virtual int XKMSStatusResult::getPendingCount (  void   )  const [pure virtual]

Find number of Pending messages. A StatusResult can have a count of messages within a pending CompoundResponse with a Pending result code. Returns: the number of Pending messages in a pending CompoundResponse

virtual int XKMSStatusResult::getSuccessCount (  void   )  const [pure virtual]

Find number of Success messages. A StatusResult can have a count of messages within a pending CompoundResponse with a Success result code. Returns: the number of Success messages in a pending CompoundResponse

virtual void XKMSStatusResult::setFailureCount (  int  count  )  [pure virtual]

Set the number of Failed messages. A StatusResult can have a count of messages within a pending CompoundResponse with a Failed result code. Parameters: count  the number of Failed messages in a pending CompoundResponse

virtual void XKMSStatusResult::setPendingCount (  int  count  )  [pure virtual]

Set the number of Pending messages. A StatusResult can have a count of messages within a pending CompoundResponse with a Pending result code. Parameters: count  the number of Pending messages in a pending CompoundResponse

virtual void XKMSStatusResult::setSuccessCount (  int  count  )  [pure virtual]

Set the number of Success messages. A StatusResult can have a count of messages within a pending CompoundResponse with a Success result code. Parameters: count  the number of Success messages in a pending CompoundResponse

---

The documentation for this class was generated from the following file:

• XKMSStatusResult.hpp

---