#include <XKMSRequestAbstractType.hpp>
Inheritance diagram for XKMSRequestAbstractType:


The <RequestAbstractType> is an abstract type on which all XKMS Request messages are built.
The schema definition for RequestAbstractType is as follows :
<!-- RequestAbstractType -->
<complexType name="RequestAbstractType" abstract="true">
<complexContent>
<extension base="xkms:MessageAbstractType">
<sequence>
<element ref="xkms:ResponseMechanism" minOccurs="0"
maxOccurs="unbounded"/>
<element ref="xkms:RespondWith" minOccurs="0"
maxOccurs="unbounded"/>
<element ref="xkms:PendingNotification" minOccurs="0"/>
</sequence>
<attribute name="OriginalRequestId" type="NCName"
use="optional"/>
<attribute name="ResponseLimit" type="integer" use="optional"/>
</extension>
</complexContent>
</complexType>
<!-- /RequestAbstractType -->
Constructors and Destructors | |
| virtual | ~XKMSRequestAbstractType () |
| XKMSRequestAbstractType () | |
Public Member Functions | |
Getter Interface Methods | |
| virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * | getElement (void) const =0 |
| virtual const XMLCh * | getOriginalRequestId (void) const =0 |
| Get the Original Request Id for the Message. | |
| virtual unsigned int | getResponseLimit (void) const =0 |
| Get the ResponseLimit size. | |
Setter interface methods | |
| virtual void | setOriginalRequestId (const XMLCh *id)=0 |
| Set the Original Reqeust Id for the Message. | |
| virtual void | setResponseLimit (unsigned int limit)=0 |
| Set the ResponseLimit size. | |
\<RespondWith\> handling | |
| virtual int | getRespondWithSize (void)=0 |
| Number of RespondWith elements in this Request. | |
| virtual XKMSRespondWith * | getRespondWithItem (int item)=0 |
| Get the nth item in the RespondWith list. | |
| virtual const XMLCh * | getRespondWithItemStr (int item)=0 |
| Get the string of the nth item in the RespondWith list. | |
| virtual void | appendRespondWithItem (XKMSRespondWith *item)=0 |
| Append an item to the RespondWith list. | |
| virtual void | appendRespondWithItem (const XMLCh *item)=0 |
| Shortcut for appending an item to the RespondWith list. | |
\<ResponseMechanism\> handling | |
| virtual int | getResponseMechanismSize (void)=0 |
| Number of ResponseMechanism elements in this Request. | |
| virtual XKMSResponseMechanism * | getResponseMechanismItem (int item)=0 |
| Get the nth item in the ResponseMechanism list. | |
| virtual const XMLCh * | getResponseMechanismItemStr (int item)=0 |
| Get the string of the nth item in the ResponseMechanism list. | |
| virtual void | appendResponseMechanismItem (XKMSResponseMechanism *item)=0 |
| Append an item to the ResponseMechanism list. | |
| virtual void | appendResponseMechanismItem (const XMLCh *item)=0 |
| Shortcut for appending an item to the ResponseMechanism list. | |
| virtual void | removeResponseMechanismItem (int item)=0 |
| Remove a ResponseMechanism. | |
|
|
|
|
|
|
|
|
Shortcut for appending an item to the RespondWith list.
|
|
|
Append an item to the RespondWith list.
|
|
|
Shortcut for appending an item to the ResponseMechanism list.
|
|
|
Append an item to the ResponseMechanism list.
|
|
|
Implements XKMSMessageAbstractType. Implemented in XKMSCompoundRequest, XKMSLocateRequest, XKMSPendingRequest, XKMSRegisterRequest, XKMSStatusRequest, and XKMSValidateRequest. |
|
|
Get the Original Request Id for the Message. For transactions that use multipt request/response sessions (e.g. two stage commit or asyncronous processing), this attribute can be used to identify the id of the original message that was processed.
|
|
|
Get the nth item in the RespondWith list.
|
|
|
Get the string of the nth item in the RespondWith list.
|
|
|
Number of RespondWith elements in this Request. Returns the number of RespondWith elements held within this request
|
|
|
Get the ResponseLimit size. A client can limit the number of keys to be returned by the service by setting this value to the required limit.
|
|
|
Get the nth item in the ResponseMechanism list.
|
|
|
Get the string of the nth item in the ResponseMechanism list.
|
|
|
Number of ResponseMechanism elements in this Request. Returns the number of ResponseMechanism elements held within this request
|
|
|
Remove a ResponseMechanism. Removes the identified ResponseMechanism from the item
|
|
|
Set the Original Reqeust Id for the Message. Allows a calling application to set a new original request Id for the message
|
|
|
Set the ResponseLimit size. A client can limit the number of keys to be returned by the service by setting this value to the required limit.
|
1.4.2