libepp_nicbr
Public Types | Public Member Functions | Protected Attributes | List of all members
Greeting Class Reference

EPP Greeting Class. More...

#include <Greeting.H>

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

Returns the server's Access parameter.

Returns
access
string Greeting::get_expiry ( ) const

Returns the server's policy expiry.

Returns
expiry
set<string> Greeting::get_extURI ( ) const

Returns the object extensions the server supports.

Returns
extURI
set<string> Greeting::get_lang ( ) const

Returns the language supported by the server.

Returns
lang
set<string> Greeting::get_objURI ( ) const

Returns the object the server supports.

Returns
objURI
set<Purpose> Greeting::get_purpose ( ) const

Returns the server's Purpose parameter.

Returns
purpose
string Greeting::get_recDesc ( ) const

Returns the server's Recipient description.

Returns
recDesc
set<Recipient> Greeting::get_recipient ( ) const

Returns the server's Recipient parameter.

Returns
recipient
Retention Greeting::get_retention ( ) const

Returns the server's Retention parameter.

Returns
retention
string Greeting::get_svDate ( ) const

Returns the server's current date and time.

Returns
svDate
string Greeting::get_svID ( ) const

Returns the svID.

Returns
svID
int Greeting::get_type_expiry ( ) const

Returns the server's policy expiry type.

Returns
expiry type (absolute = 0, relative = 1)
set<string> Greeting::get_version ( ) const

Returns the protocol version.

Returns
version
void Greeting::set_access ( const Access access)

Sets the server's Access parameter.

Parameters
accessAccess provided by the server
void Greeting::set_expiry ( const int &  type,
const string &  expiry 
)

Sets the server's policy expiry.

Parameters
type0 = absolute, 1 = relative
expiryPolicy lifetime
void Greeting::set_extURI ( const string &  extURI)

Sets object extensions the server supports.

Parameters
extURIObject extensions supported by the server
void Greeting::set_lang ( const string &  lang)

Sets the language supported by the server.

Parameters
langLanguages known by the server (format defined by RFC3066)
void Greeting::set_objURI ( const string &  objURI)

Sets the object the server supports.

Parameters
objURIObjects that the server is capable of managing
void Greeting::set_purpose ( const Purpose purpose)

Sets the server's Purpose parameter.

Parameters
purposeData collection purposes
void Greeting::set_recDesc ( const string &  recDesc)

Sets the server's Recipient description.

Parameters
recDescRecipient description
void Greeting::set_recipient ( const Recipient recipient)

Sets the server's Recipient parameter.

Parameters
recipientData recipients
void Greeting::set_retention ( const Retention retention)

Sets the server's Retention parameter.

Parameters
retentionData retention
void Greeting::set_svDate ( const string &  svDate)

Sets the server's current date and time.

Parameters
svDateServer Current Date and Time (UTC)
void Greeting::set_svID ( const string &  svID)

Sets the svID.

Parameters
svIDServer Name
void Greeting::set_version ( const string &  version)

Sets the protocol version.

Parameters
versionProtocol versions supported by the server

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