1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
|
/*
* Copyright 2004-2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* XSEC
*
* XKMSStatusResult := Interface for StatusResult Messages
*
* $Id: XKMSStatusResult.hpp 351364 2005-06-04 11:30:26Z blautenb $
*
*/
#ifndef XKMSSTATUSRESULT_INCLUDE
#define XKMSSTATUSRESULT_INCLUDE
// XSEC Includes
#include <xsec/framework/XSECDefs.hpp>
#include <xsec/xkms/XKMSResultType.hpp>
class XKMSQueryKeyBinding;
class XKMSUnverifiedKeyBinding;
/**
* @ingroup xkms
*/
/**
* @brief 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 :
*
* \verbatim
<!-- 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 -->\endverbatim
*/
class XKMSStatusResult : public XKMSResultType {
/** @name Constructors and Destructors */
//@{
protected:
XKMSStatusResult() {};
public:
virtual ~XKMSStatusResult() {};
/** @name Getter Interface Methods */
//@{
/**
* \brief Return the element at the base of the message
*/
virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * getElement(void) const = 0;
//@}
/** @name Count handling */
//@{
/**
* \brief 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 int getSuccessCount(void) const = 0;
/**
* \brief 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 getFailureCount(void) const = 0;
/**
* \brief 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 getPendingCount(void) const = 0;
/**
* \brief Set the number of Success messages
*
* A StatusResult can have a count of messages within a pending CompoundResponse
* with a Success result code.
*
* @param count the number of Success messages in a pending CompoundResponse
*/
virtual void setSuccessCount(int count) = 0;
/**
* \brief Set the number of Failed messages
*
* A StatusResult can have a count of messages within a pending CompoundResponse
* with a Failed result code.
*
* @param count the number of Failed messages in a pending CompoundResponse
*/
virtual void setFailureCount(int count) = 0;
/**
* \brief Set the number of Pending messages
*
* A StatusResult can have a count of messages within a pending CompoundResponse
* with a Pending result code.
*
* @param count the number of Pending messages in a pending CompoundResponse
*/
virtual void setPendingCount(int count) = 0;
//@}
private:
// Unimplemented
XKMSStatusResult(const XKMSStatusResult &);
XKMSStatusResult & operator = (const XKMSStatusResult &);
};
#endif /* XKMSSTATUSRESULT_INCLUDE */
|