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

EPP BrOrgInfoRsp Class. More...

#include <BrOrgInfoRsp.H>

Inheritance diagram for BrOrgInfoRsp:
ContactInfoRsp Response

Public Member Functions

 BrOrgInfoRsp (bool reset=true)
 Default constructor.
 
void copy_parent_data (ContactInfoRsp &parent)
 Copies data from the parent.
 
void set_organization (const string &organization)
 Sets the Organization. More...
 
string get_organization ()
 Returns the Organization. More...
 
void set_responsible (const string &responsible)
 Sets Responsible for the organization. More...
 
string get_responsible ()
 Returns Responsible for the organization. More...
 
void insert_contact (const string &type, const string &id)
 Inserts a Contact into the list. More...
 
map< string, string, less< string > > get_contact_list ()
 Returns the Contact List. More...
 
void set_proxy (const string &proxy)
 Sets the Legal Representative. More...
 
string get_proxy ()
 Returns the Legal Representative. More...
 
void insert_domainName (const string &fqdn)
 Inserts a domain name into the list. More...
 
set< string > get_domainName_list ()
 Returns the domain name list. More...
 
void set_exDate (const string &exDate)
 
string get_exDate () const
 
void insert_asn (const int &asn)
 
set< int > get_asn_list () const
 
void insert_ipRange (const IpRange &ipRange)
 
set< IpRangeget_ipRange_list () const
 
void set_suspended (const bool suspended)
 Sets suspended flag for organizations with payment problems.
 
SuspendedStatus::Value get_suspended () const
 
void set_type (const string &type)
 Sets the organization type. More...
 
string get_type () const
 Returns the organization type. More...
 
void set_epp_status (const string &epp_status)
 Sets the organization epp status. More...
 
string get_epp_status () const
 Returns the organization epp status. More...
 
void insert_epp_ip (const string &ip)
 
vector< string > get_epp_ips () const
 
void insert_renewal_type (const string &type)
 Inserts a renewal type.
 
void set_renewal_types (const vector< string > &types)
 Sets the organization category and characteristics.
 
vector< string > get_renewal_types () const
 Returns list of renewal types of an organization.
 
void set_renewal_date (const string &date)
 Sets the organization billing date.
 
string get_renewal_date () const
 Returns the organization billing date.
 
void set_resources_class (const string &resources_class)
 Sets the organization resources class.
 
string get_resources_class () const
 Returns the organization resources class.
 
void set_password (const string &password)
 Sets the legacy organization password.
 
string get_password () const
 Returns the legacy organization password.
 
void reset ()
 reset attributes
 
- Public Member Functions inherited from ContactInfoRsp
 ContactInfoRsp (bool reset=true)
 Default constructor.
 
void set_roid (const string &roid)
 Sets the repository object id. More...
 
void insert_status (const string &status)
 Inserts a status to the object. More...
 
void set_clID (const string &clID)
 Sets the client id. More...
 
void set_crID (const string &crID)
 Sets the creator client id. More...
 
void set_crDate (const string &crDate)
 Sets the creation date. More...
 
void set_upID (const string &upID)
 Sets the last update client id. More...
 
void set_upDate (const string &upDate)
 Sets the last update. More...
 
void set_trDate (const string &trDate)
 Sets the last transfer date. More...
 
string get_roid () const
 Returns the repository object id. More...
 
set< string > get_status_set () const
 Returns the status list of the object. More...
 
string get_clID () const
 Returns the client id. More...
 
string get_crID () const
 Returns the creator client id. More...
 
string get_crDate () const
 Returns the creation date. More...
 
string get_upID () const
 Returns the last update client id. More...
 
string get_upDate () const
 Returns the last update. More...
 
string get_trDate () const
 Returns the last transfer date. More...
 
void set_common_data (const CommonData &common)
 Sets the common data object. More...
 
CommonData get_common_data () const
 Returns the common data of the object. More...
 
void set_authInfo (const AuthInfo &authInfo)
 Sets authorization information. More...
 
AuthInfo get_authInfo () const
 Returns authorization information. More...
 
void set_reminder (const string &reminder)
 Sets the reminder. More...
 
string get_reminder ()
 Returns the reminder for the contact's password. More...
 
void set_language (const string &language)
 Sets the contact's language. More...
 
string get_language ()
 Returns the contact's preferred language. More...
 
void set_properties (const vector< string > &properties)
 Sets the properties associated with the contact. More...
 
void add_property (const string &property)
 Adds a property to the vector of properties. More...
 
vector< string > get_properties ()
 Returns the vector of properties associated with the contact. More...
 
void set_legacy (const bool legacy)
 Sets the legacy flag of a contact.
 
bool is_legacy () const
 Returns the legacy flag of a contact.
 
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 _organization
 Organization Identifier.
 
string _responsible
 Person responsible for the organization.
 
map< string, string, less< string > > _contact_list
 Human Contacts.
 
string _proxy
 Local Legal Representative.
 
set< string > _domain_list
 Domain names.
 
string _exDate
 Expiration date.
 
set< int > _asn_list
 ASNs.
 
set< IpRange_ipRange_list
 
SuspendedStatus::Value _suspended
 Suspended flag.
 
string _type
 Define the organization type.
 
string _epp_status
 Determine if the organization is blocked for EPP access.
 
vector< string > _epp_ips
 
vector< string > _renewal_types
 List of category and characteristics of the organization.
 
string _renewal_date
 Billing date for organizations that have resources.
 
string _resources_class
 
string _password
 Authenticate updates of legacy organizations.
 
- Protected Attributes inherited from ContactInfoRsp
string _roid
 Repository id.
 
set< string > _status_set
 Status list.
 
string _clID
 Sponsoring client id.
 
string _crID
 Creator client id.
 
string _crDate
 Creation date and time.
 
string _upID
 last client id that updated the object
 
string _upDate
 Last modification date and time.
 
string _trDate
 Last transfer date and time.
 
CommonData _common
 Common data object.
 
AuthInfo _authInfo
 authorization information
 
string _reminder
 tip for the contact's password (lacnic contact extension)
 
string _language
 contact's preferred language (lacnic contact extension)
 
vector< string > _properties
 current properties associated with the contact (lacnic contact extension)
 
bool _legacy
 
- 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 BrOrgInfoRsp Class.

Member Function Documentation

set<int> BrOrgInfoRsp::get_asn_list ( ) const
inline

Returns Autonomous System object associated with this organization

References _asn_list.

map< string, string, less<string> > BrOrgInfoRsp::get_contact_list ( )
inline

Returns the Contact List.

Returns
Contact List

References _contact_list.

set<string> BrOrgInfoRsp::get_domainName_list ( )
inline

Returns the domain name list.

Returns
domain name list

References _domain_list.

vector<string> BrOrgInfoRsp::get_epp_ips ( ) const
inline

Returns list of IPs or ranges that will be allowed in the EPP server

References _epp_ips.

string BrOrgInfoRsp::get_epp_status ( ) const
inline

Returns the organization epp status.

Returns
organization epp status

References _epp_status.

string BrOrgInfoRsp::get_exDate ( ) const
inline

Returns date and time identifying the end of the organization object's registration period

Returns
expiration date

References _exDate.

set<IpRange> BrOrgInfoRsp::get_ipRange_list ( ) const
inline

Returns IP addresses of network objects associated with this organization

string BrOrgInfoRsp::get_organization ( )
inline

Returns the Organization.

Returns
Organization Identifier

References _organization.

string BrOrgInfoRsp::get_proxy ( )
inline

Returns the Legal Representative.

Returns
Local Legal Representative

References _proxy.

string BrOrgInfoRsp::get_responsible ( )
inline

Returns Responsible for the organization.

Returns
Person Responsible

References _responsible.

SuspendedStatus::Value BrOrgInfoRsp::get_suspended ( ) const
inline

Returns the suspended flag for organizations with payment problems

References _suspended.

string BrOrgInfoRsp::get_type ( ) const
inline

Returns the organization type.

Returns
organization type

References _type.

void BrOrgInfoRsp::insert_asn ( const int &  asn)
inline

Inserts Autonomous System object associated with this organization

References _asn_list.

void BrOrgInfoRsp::insert_contact ( const string &  type,
const string &  id 
)
inline

Inserts a Contact into the list.

Parameters
idContact Id
typeContact Type

References _contact_list.

void BrOrgInfoRsp::insert_domainName ( const string &  fqdn)
inline

Inserts a domain name into the list.

Parameters
fqdnfully qualified domain name

References _domain_list.

void BrOrgInfoRsp::insert_epp_ip ( const string &  ip)
inline

Inserts an EPP IP or range that will be allowed in the EPP server

References _epp_ips.

void BrOrgInfoRsp::insert_ipRange ( const IpRange ipRange)
inline

Inserts IP addresses of network objects associated with this organization

void BrOrgInfoRsp::set_epp_status ( const string &  epp_status)
inline

Sets the organization epp status.

Parameters
epp_statusorganization epp status

References _epp_status.

void BrOrgInfoRsp::set_exDate ( const string &  exDate)
inline

Sets date and time identifying the end of the organization object's registration period

Parameters
exDateexpiration date

References _exDate.

void BrOrgInfoRsp::set_organization ( const string &  organization)
inline

Sets the Organization.

Parameters
organizationOrganization Identifier

References _organization.

void BrOrgInfoRsp::set_proxy ( const string &  proxy)
inline

Sets the Legal Representative.

Parameters
proxyLocal Legal Representative

References _proxy.

void BrOrgInfoRsp::set_responsible ( const string &  responsible)
inline

Sets Responsible for the organization.

Parameters
responsiblePerson Responsible

References _responsible.

void BrOrgInfoRsp::set_type ( const string &  type)
inline

Sets the organization type.

Parameters
typeorganization type

References _type.

Member Data Documentation

vector<string> BrOrgInfoRsp::_epp_ips
protected

IP addresses or ranges that are allowed to connect to the EPP interface

Referenced by get_epp_ips(), insert_epp_ip(), and reset().

string BrOrgInfoRsp::_resources_class
protected

There are some options when categorizing an organization. We can use all resouces to categorize or only the non legacy resources. The possible values are "all-resources" and "non-legacy-only"

Referenced by get_resources_class(), reset(), and set_resources_class().


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