Greeting Class Reference

EPP Greeting Class. More...

#include <Greeting.H>

List of all members.

Public Types

enum  Access {
  UNSET_AC = -1, ALL = 0, NONE_AC, NULL_AC,
  PERSONAL, PERSONAL_AND_OTHER, OTHER_AC
}
 For details about the following codes, see RFC 3730 - Session 2.4.
enum  Purpose { ADMIN = 0, CONTACT, PROV, OTHER_PR }
 For details about the following codes, see RFC 3730 - Session 2.4.
enum  Recipient {
  OTHER_RC = 0, OURS, PUBLIC, SAME,
  UNRELATED
}
 For details about the following codes, see RFC 3730 - Session 2.4.
enum  Retention {
  UNSET_RT = -1, BUSINESS = 0, INDEFINITE, LEGAL,
  NONE_RT, STATED
}
 For details about the following codes, see RFC 3730 - Session 2.4.

Public Member Functions

void set_svID (const string &svID)
 Sets the svID.
void set_svDate (const string &svDate)
 Sets the server's current date and time.
void set_version (const string &version)
 Sets the protocol version.
void set_lang (const string &lang)
 Sets the language supported by the server.
void set_objURI (const string &objURI)
 Sets the object the server supports.
void set_extURI (const string &extURI)
 Sets object extensions the server supports.
void set_access (const Access &access)
 Sets the server's Access parameter.
void set_purpose (const Purpose &purpose)
 Sets the server's Purpose parameter.
void set_recipient (const Recipient &recipient)
 Sets the server's Recipient parameter.
void set_recDesc (const string &recDesc)
 Sets the server's Recipient description.
void set_retention (const Retention &retention)
 Sets the server's Retention parameter.
void set_expiry (const int &type, const string &expiry)
 Sets the server's policy expiry.
string get_svID ()
 Returns the svID.
string get_svDate ()
 Returns the server's current date and time.
set< string > get_version ()
 Returns the protocol version.
set< string > get_lang ()
 Returns the language supported by the server.
set< string > get_objURI ()
 Returns the object the server supports.
set< string > get_extURI ()
 Returns the object extensions the server supports.
Access get_access ()
 Returns the server's Access parameter.
set< Purposeget_purpose ()
 Returns the server's Purpose parameter.
set< Recipientget_recipient ()
 Returns the server's Recipient parameter.
string get_recDesc ()
 Returns the server's Recipient description.
Retention get_retention ()
 Returns the server's Retention parameter.
int get_type_expiry ()
 Returns the server's policy expiry type.
string get_expiry ()
 Returns the server's policy expiry.
void reset ()
 reset attributes

Protected Attributes

string _svID
 Server Name.
string _svDate
 Server Current Date and Time (UTC).
set< string > _version
 Protocol versions supported by the server.
set< string > _lang
 Languages known by the server.
set< string > _objURI
 Objects that the server is capable of managing.
set< string > _extURI
 Object extensions supported by the server (optional).
Access _access
 Access provided by the server (optional).
set< Purpose_purpose
 Data collection purposes (optional).
set< Recipient_recipient
 Data recipients (optional).
string _recDesc
 Recipient description (optional).
Retention _retention
 Data retention (optional).
int _type_expiry
 Expiry type (absolute = 0, relative = 1) (optional).
string _expiry
 Policy lifetime (optional).


Detailed Description

EPP Greeting Class.


Member Function Documentation

Access Greeting::get_access  ) 
 

Returns the server's Access parameter.

Returns:
access

string Greeting::get_expiry  ) 
 

Returns the server's policy expiry.

Returns:
expiry

set<string> Greeting::get_extURI  ) 
 

Returns the object extensions the server supports.

Returns:
extURI

set<string> Greeting::get_lang  ) 
 

Returns the language supported by the server.

Returns:
lang

set<string> Greeting::get_objURI  ) 
 

Returns the object the server supports.

Returns:
objURI

set<Purpose> Greeting::get_purpose  ) 
 

Returns the server's Purpose parameter.

Returns:
purpose

string Greeting::get_recDesc  ) 
 

Returns the server's Recipient description.

Returns:
recDesc

set<Recipient> Greeting::get_recipient  ) 
 

Returns the server's Recipient parameter.

Returns:
recipient

Retention Greeting::get_retention  ) 
 

Returns the server's Retention parameter.

Returns:
retention

string Greeting::get_svDate  ) 
 

Returns the server's current date and time.

Returns:
svDate

string Greeting::get_svID  ) 
 

Returns the svID.

Returns:
svID

int Greeting::get_type_expiry  ) 
 

Returns the server's policy expiry type.

Returns:
expiry type (absolute = 0, relative = 1)

set<string> Greeting::get_version  ) 
 

Returns the protocol version.

Returns:
version

void Greeting::set_access const Access access  ) 
 

Sets the server's Access parameter.

Parameters:
access Access provided by the server

void Greeting::set_expiry const int &  type,
const string &  expiry
 

Sets the server's policy expiry.

Parameters:
type 0 = absolute, 1 = relative
expiry Policy lifetime

void Greeting::set_extURI const string &  extURI  ) 
 

Sets object extensions the server supports.

Parameters:
extURI Object extensions supported by the server

void Greeting::set_lang const string &  lang  ) 
 

Sets the language supported by the server.

Parameters:
lang Languages known by the server (format defined by RFC3066)

void Greeting::set_objURI const string &  objURI  ) 
 

Sets the object the server supports.

Parameters:
objURI Objects that the server is capable of managing

void Greeting::set_purpose const Purpose purpose  ) 
 

Sets the server's Purpose parameter.

Parameters:
purpose Data collection purposes

void Greeting::set_recDesc const string &  recDesc  ) 
 

Sets the server's Recipient description.

Parameters:
recDesc Recipient description

void Greeting::set_recipient const Recipient recipient  ) 
 

Sets the server's Recipient parameter.

Parameters:
recipient Data recipients

void Greeting::set_retention const Retention retention  ) 
 

Sets the server's Retention parameter.

Parameters:
retention Data retention

void Greeting::set_svDate const string &  svDate  ) 
 

Sets the server's current date and time.

Parameters:
svDate Server Current Date and Time (UTC)

void Greeting::set_svID const string &  svID  ) 
 

Sets the svID.

Parameters:
svID Server Name

void Greeting::set_version const string &  version  ) 
 

Sets the protocol version.

Parameters:
version Protocol versions supported by the server


The documentation for this class was generated from the following file:
Generated on Thu Jun 8 17:40:01 2006 for libepp_nicbr by  doxygen 1.4.6