libepp_nicbr
Classes | Public Member Functions | Protected Attributes | List of all members
PollRsp Class Reference

EPP PollRsp Class. More...

#include <PollRsp.H>

Inheritance diagram for PollRsp:
Response

Classes

struct  MsgContent
 

Public Member Functions

 PollRsp (bool reset=true)
 Default constructor.
 
void set_count (const string &count)
 Sets the message count. More...
 
void set_id (const string &id)
 Sets the message id. More...
 
void set_qDate (const string &qDate)
 Sets the message date. More...
 
void set_lang (const string &lang)
 Sets the language of the message. More...
 
void set_text (const string &text)
 Sets the message text. More...
 
void set_content (const map< string, MsgContent, less< string > > &content)
 Sets the msg content. More...
 
void set_response (Response *resp, const ActionType type)
 Sets the specific response inside the poll response. More...
 
string get_count () const
 Returns the message count. More...
 
string get_id () const
 Returns the message id. More...
 
string get_qDate () const
 Returns the message date. More...
 
string get_lang () const
 Returns the message language. More...
 
string get_text () const
 Returns the message text. More...
 
map< string, MsgContent, less< string > > get_content () const
 Returns the msg content. More...
 
ActionType get_response_type () const
 Returns the response type of the specific response. More...
 
Responseget_response ()
 Returns the specific response inside the poll response. More...
 
void reset ()
 reset attributes
 
- Public Member Functions inherited from Response
 Response (bool reset=true)
 Default constructor.
 
void set_clTRID (const string &clTRID)
 Sets the client transaction ID. More...
 
void set_svTRID (const string &svTRID)
 Sets the server transaction ID. More...
 
void set_result_lang (const string &result_lang)
 Sets the result message language. More...
 
void insert_result (const ResultCode &code, const string &msg, const string &value="", const string &xmlns="", const string &reason="")
 Sets a result element. More...
 
string get_clTRID () const
 Returns the client transaction ID. More...
 
string get_svTRID () const
 Returns the servers transaction ID. More...
 
string get_result_lang ()
 Returns the result message language. More...
 
map< ResultCode, ResultInfoget_result_list () const
 Returns the list of result elements. More...
 
void reset ()
 reset attributes
 
virtual ~Response ()
 virtual destructor
 

Protected Attributes

string _count
 Counter.
 
string _id
 Contact id.
 
string _qDate
 Date when the message entered in the queue.
 
string _lang
 Language msg.
 
string _text
 Text msg.
 
map< string, MsgContent, less< string > > _content
 Message content.
 
ActionType _type
 Response type.
 
auto_ptr< Response_response
 Response (resData element)
 
- Protected Attributes inherited from Response
string _clTRID
 Client transaction ID.
 
string _svTRID
 Server transaction ID.
 
string _result_lang
 Result language.
 
map< ResultCode, ResultInfo_result_list
 Result elements list.
 

Additional Inherited Members

- Public Types inherited from Response
enum  ResultCode {
  UNSET = -1, OK = 1000, OK_ACTION_PENDING = 1001, OK_NO_MESSAGES = 1300,
  OK_ACK_DEQUEUE = 1301, OK_ENDING_SESSION = 1500, UNKNOWN_COMMAND = 2000, COMMAND_SYNTAX_ERROR = 2001,
  COMMAND_USE_ERROR = 2002, PARAMETER_MISSING = 2003, PARAMETER_RANGE_ERROR = 2004, PARAMETER_SYNTAX_ERROR = 2005,
  UNIMPLEMENTED_VERSION = 2100, UNIMPLEMENTED_COMMAND = 2101, UNIMPLEMENTED_OPTION = 2102, UNIMPLEMENTED_EXTENSION = 2103,
  BILLING_FAILURE = 2104, NOT_RENEWABLE = 2105, NOT_TRANSFERABLE = 2106, AUTHENTICATION_ERROR = 2200,
  AUTHORIZATION_ERROR = 2201, INVALID_AUTHORIZATION_INFO = 2202, PENDING_TRANSFER = 2300, NOT_PENDING_TRANSFER = 2301,
  OBJECT_EXISTS = 2302, OBJECT_DOESNT_EXIST = 2303, STATUS_PROHIBITS_OPERATION = 2304, ASSOCIATION_PROHIBITS_OPERATION = 2305,
  PARAMETER_POLICY_ERROR = 2306, UNIMPLEMENTED_SERVICE = 2307, DATA_MGMT_POLICY_VIOLATION = 2308, COMMAND_FAILED = 2400,
  COMMAND_FAILED_CLOSING_CONN = 2500, AUTHENTICATION_ERROR_CLOSING_CONN = 2501, SESSION_LIMIT_EXCEEDED = 2502
}
 Result Codes - See RFC 3730 - Session 3.
 

Detailed Description

EPP PollRsp Class.

Member Function Documentation

map< string, MsgContent, less<string> > PollRsp::get_content ( ) const
inline

Returns the msg content.

Returns
msg content

References _content.

string PollRsp::get_count ( ) const
inline

Returns the message count.

Returns
message count

References _count.

string PollRsp::get_id ( ) const
inline

Returns the message id.

Returns
message id

References _id.

string PollRsp::get_lang ( ) const
inline

Returns the message language.

Returns
message language

References _lang.

string PollRsp::get_qDate ( ) const
inline

Returns the message date.

Returns
qDate

References _qDate.

Response* PollRsp::get_response ( )
inline

Returns the specific response inside the poll response.

Returns
a pointer to the response

References _response.

ActionType PollRsp::get_response_type ( ) const
inline

Returns the response type of the specific response.

Returns
Response type

References _type.

string PollRsp::get_text ( ) const
inline

Returns the message text.

Returns
message text

References _text.

void PollRsp::set_content ( const map< string, MsgContent, less< string > > &  content)
inline

Sets the msg content.

Parameters
contentmsg

References _content.

void PollRsp::set_count ( const string &  count)
inline

Sets the message count.

Parameters
countmsg queue counter

References _count.

void PollRsp::set_id ( const string &  id)
inline

Sets the message id.

Parameters
idmessage id

References _id.

void PollRsp::set_lang ( const string &  lang)
inline

Sets the language of the message.

Parameters
langlanguage msg

References _lang.

void PollRsp::set_qDate ( const string &  qDate)
inline

Sets the message date.

Parameters
qDatedate when the message entered in the queue

References _qDate.

void PollRsp::set_response ( Response resp,
const ActionType  type 
)
inline

Sets the specific response inside the poll response.

Parameters
respresponse (resData element)
typeresponse type

References _response, and _type.

void PollRsp::set_text ( const string &  text)
inline

Sets the message text.

Parameters
texttext msg

References _text.


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