EppSvcsub
This EppSvcsub
class implements EPP Svcsub objects.
Inheritance:
Public Fields
-
static const char* CONTACT_TYPE_ADMIN
- Contact type for administration contact ("admin");
-
static const char* CONTACT_TYPE_BILLING
- Contact type for billing contact ("billing");
-
static const char* CONTACT_TYPE_TECH
- Contact type for technical contact ("tech")
-
static const char* CONTACT_TYPE_PRIMARY
- Contact type for primary contact ("primary")
-
static const char* CONTACT_TYPE_SECONDARY
- Contact type for secondary contact ("secondary")
-
static const char* CONTACT_TYPE_BIZLOCK
- Contact type for BIZlock contact ("bizlock")
-
static const char* STATUS_CLIENT_DELETE_PROHIBITED
- Svcsub status - clientDeleteProhibited
-
static const char* STATUS_CLIENT_SUSPENDED
- Svcsub status - clientSuspended
-
static const char* STATUS_CLIENT_RENEW_PROHIBITED
- Svcsub status - clientRenewProhibited
-
static const char* STATUS_CLIENT_TRANSFER_PROHIBITED
- Svcsub status - clientTransferProhibited
-
static const char* STATUS_CLIENT_UPDATE_PROHIBITED
- Svcsub status - clientUpdateProhibited
-
static const char* STATUS_INACTIVE
- Svcsub status - inactive
-
static const char* STATUS_OK
- Svcsub status - ok
-
static const char* STATUS_PENDING_DELETE
- Svcsub status - pendingDelete
-
static const char* STATUS_PENDING_TRANSFER
- Svcsub status - pendingTransfer
-
static const char* STATUS_PENDING_VERIFICATION
- Svcsub status - pendingVerification
-
static const char* STATUS_SERVER_DELETE_PROHIBITED
- Svcsub status - serverDeleteProhibited
-
static const char* STATUS_SERVER_SUSPENDED
- Svcsub status - serverSuspended
-
static const char* STATUS_SERVER_RENEW_PROHIBITED
- Svcsub status - serverRenewProhibited
-
static const char* STATUS_SERVER_TRANSFER_PROHIBITED
- Svcsub status - serverTransferProhibited
-
static const char* STATUS_SERVER_UPDATE_PROHIBITED
- Svcsub status - serverUpdateProhibited
Public Methods
-
EppSvcsub()
- Creates an
EppSvcsub
object
-
EppSvcsub( DOMString id )
- Creates an
EppSvcsub
object with a service subscription id
-
EppSvcsub( DOMString id, DOMString service )
- Creates an
EppSvcsub
object with a service subscription id and service name
-
~EppSvcsub()
- Destructor
-
virtual int getEntityType()
- Returns the run-time type of an EppEntity object
-
DOMString getId()
- Gets the service subscription id
-
void setId( DOMString id )
- Sets the service subscription id
-
DOMString getService()
- Gets the service name
-
void setService( DOMString service )
- Sets the service name
-
ValueVectorOf<EppSvcsubParam> * getParam()
- Gets a list of parameters associated with the service subscription object
-
ValueVectorOf<DOMString> * getParamValue( DOMString name )
- Extracts a list of the parameter values associated with the service subscription object based on the parameter name.
-
ValueVectorOf<DOMString> * getContactId( DOMString type )
- Extracts a list of the contact ids associated with the service subscription object based on the contact type
-
void addParam( EppSvcsubParam param )
- Add a service parameter to be associated with the subscription
-
void addParam( DOMString name, DOMString value )
- Add a service parameter to be associated with the subscription, given a parameter name and its value
-
ValueVectorOf<EppContactType> * getContact()
- Gets a list of contacts associated with the service subscription object
-
void addContact( EppContactType contact )
- Adds a contact for the service subscription object
-
void addContact( DOMString id, DOMString type )
- Adds a contact for the domain, given a contact id and its type
-
EppPeriod* getPeriod()
- Gets registration period for the subscription
-
void setPeriod( EppPeriod period )
- Sets registration period for the subscription
-
DOMString getRegistrant()
- Gets the contact id of the registrant which owns the subscription
-
void setRegistrant( DOMString registrant )
- Sets the contact id of the registrant which owns the subscription
-
DOM_Element toXML( DOM_Document& doc, const DOMString& tag )
- Converts the
EppSvcsub
object into an XML element
-
static EppSvcsub* fromXML( const DOM_Node& root )
- Converts an XML element into an
EppSvcsub
object.
-
static EppCommandDeleteSvcsub remove( DOMString id, DOMString xid )
- Creates an
EppCommandDeleteSvcsub
object for deleting an EPP Svcsub object from the registry.
-
static EppCommandInfoSvcsub info( DOMString id, DOMString xid )
- Creates an
EppCommandInfoSvcsub
object for querying the details of an EPP Svcsub object
-
static EppCommandCheckSvcsub check( DOMString xid )
- Creates an
EppCommandCheckSvcsub
object for checking the existance of EPP Svcsub objects in the registry.
-
static EppCommandTransferSvcsub transfer( DOMString id, EppPeriod& period, DOMString xid )
- Creates an
EppCommandTransferSvcsub
object for transfering an EPP Svcsub object in the registry.
-
static EppCommandUpdateSvcsub update( DOMString id, DOMString xid )
- Creates an
EppCommandUpdateSvcsub
object for updating an EPP Svcsub object in the registry.
-
static EppCommandRenewSvcsub renew( DOMString id, time_t curExpDate, EppPeriod& period, DOMString xid )
- Creates an
EppCommandRenewSvcsub
object for renewing the registration of an EPP Svcsub object in the registry.
Public Fields
-
static const int CONTACT
-
static const int DOMAIN
-
static const int HOST
-
static const int SVCSUB
Public Methods
-
DOMString getRoid()
-
void setRoid( DOMString roid )
-
DOMString getClientId()
-
void setClientId( DOMString clientId )
-
DOMString getClientIdCreated()
-
void setClientIdCreated( DOMString clientId )
-
time_t getDateCreated()
-
void setDateCreated( time_t cal )
-
DOMString getClientIdUpdated()
-
void setClientIdUpdated( DOMString clientId )
-
time_t getDateUpdated()
-
void setDateUpdated( time_t cal )
-
time_t getDateExpired()
-
void setDateExpired( time_t cal )
-
time_t getDateTransferred()
-
void setDateTransferred( time_t cal )
-
EppAuthInfo* getAuthInfo()
-
void setAuthInfo( EppAuthInfo authInfo )
-
ValueVectorOf<EppStatus> * getStatus()
-
void addStatus( EppStatus status )
-
static EppCommandCreate create( EppObject* object, DOMString xid )
Protected Fields
-
DOMString roid
-
ValueVectorOf<EppStatus> * status
-
DOMString clID
-
DOMString crID
-
time_t crDate
-
DOMString upID
-
time_t upDate
-
time_t exDate
-
time_t trDate
-
EppAuthInfo* authInfo
Protected Methods
-
void fromXMLCommon( const DOM_Node& node, const DOMString name )
-
void toXMLCommon( DOM_Document& doc, DOM_Element& body )
-
void freeCommon()
Public Methods
-
bool instanceOf( const int type )
-
virtual DOMString toString()
Protected Methods
-
DOMString toString( const DOMString &tag )
Documentation
This EppSvcsub
class implements EPP Svcsub objects. The EPP
command mapping for EPP Svcsub objects can be found at
http://epp-ver-04.sourceforge.net/IETF/EPP-04/draft-zhang-epp-svcsub-00.txt.
- static const char* CONTACT_TYPE_ADMIN
-
Contact type for administration contact ("admin");
- static const char* CONTACT_TYPE_BILLING
-
Contact type for billing contact ("billing");
- static const char* CONTACT_TYPE_TECH
-
Contact type for technical contact ("tech")
- static const char* CONTACT_TYPE_PRIMARY
-
Contact type for primary contact ("primary")
- static const char* CONTACT_TYPE_SECONDARY
-
Contact type for secondary contact ("secondary")
- static const char* CONTACT_TYPE_BIZLOCK
-
Contact type for BIZlock contact ("bizlock")
- static const char* STATUS_CLIENT_DELETE_PROHIBITED
-
Svcsub status - clientDeleteProhibited
- static const char* STATUS_CLIENT_SUSPENDED
-
Svcsub status - clientSuspended
- static const char* STATUS_CLIENT_RENEW_PROHIBITED
-
Svcsub status - clientRenewProhibited
- static const char* STATUS_CLIENT_TRANSFER_PROHIBITED
-
Svcsub status - clientTransferProhibited
- static const char* STATUS_CLIENT_UPDATE_PROHIBITED
-
Svcsub status - clientUpdateProhibited
- static const char* STATUS_INACTIVE
-
Svcsub status - inactive
- static const char* STATUS_OK
-
Svcsub status - ok
- static const char* STATUS_PENDING_DELETE
-
Svcsub status - pendingDelete
- static const char* STATUS_PENDING_TRANSFER
-
Svcsub status - pendingTransfer
- static const char* STATUS_PENDING_VERIFICATION
-
Svcsub status - pendingVerification
- static const char* STATUS_SERVER_DELETE_PROHIBITED
-
Svcsub status - serverDeleteProhibited
- static const char* STATUS_SERVER_SUSPENDED
-
Svcsub status - serverSuspended
- static const char* STATUS_SERVER_RENEW_PROHIBITED
-
Svcsub status - serverRenewProhibited
- static const char* STATUS_SERVER_TRANSFER_PROHIBITED
-
Svcsub status - serverTransferProhibited
- static const char* STATUS_SERVER_UPDATE_PROHIBITED
-
Svcsub status - serverUpdateProhibited
- EppSvcsub()
-
Creates an
EppSvcsub
object
- EppSvcsub( DOMString id )
-
Creates an
EppSvcsub
object with a service subscription id
- EppSvcsub( DOMString id, DOMString service )
-
Creates an
EppSvcsub
object with a service subscription
id and service name
- ~EppSvcsub()
-
Destructor
- virtual int getEntityType()
-
Returns the run-time type of an EppEntity object
- DOMString getId()
-
Gets the service subscription id
- void setId( DOMString id )
-
Sets the service subscription id
- DOMString getService()
-
Gets the service name
- void setService( DOMString service )
-
Sets the service name
- ValueVectorOf<EppSvcsubParam> * getParam()
-
Gets a list of parameters associated with the service subscription
object
- ValueVectorOf<DOMString> * getParamValue( DOMString name )
-
Extracts a list of the parameter values associated with the service
subscription object based on the parameter name.
Note: the caller must free the returned list if not null
- ValueVectorOf<DOMString> * getContactId( DOMString type )
-
Extracts a list of the contact ids associated with the service
subscription object based on the contact type
Note: the caller must free the returned list if not null
- void addParam( EppSvcsubParam param )
-
Add a service parameter to be associated with the subscription
- void addParam( DOMString name, DOMString value )
-
Add a service parameter to be associated with the subscription,
given a parameter name and its value
- ValueVectorOf<EppContactType> * getContact()
-
Gets a list of contacts associated with the service subscription object
- void addContact( EppContactType contact )
-
Adds a contact for the service subscription object
- void addContact( DOMString id, DOMString type )
-
Adds a contact for the domain, given a contact id and its type
- EppPeriod* getPeriod()
-
Gets registration period for the subscription
- void setPeriod( EppPeriod period )
-
Sets registration period for the subscription
- DOMString getRegistrant()
-
Gets the contact id of the registrant which owns the subscription
- void setRegistrant( DOMString registrant )
-
Sets the contact id of the registrant which owns the subscription
- DOM_Element toXML( DOM_Document& doc, const DOMString& tag )
-
Converts the
EppSvcsub
object into an XML element
- Parameters:
- doc - the XML
DOM_Element
object
tag - the tag/element name for the EppSvcsub
object
- Returns:
- an
DOM_Element
object
- static EppSvcsub* fromXML( const DOM_Node& root )
-
Converts an XML element into an
EppSvcsub
object.
The caller of this method must make sure that the root node is of
the EPP Svcsub type.
- Parameters:
- root - root node for an
EppSvcsub
object in
XML format
- Returns:
- an
EppSvcsub
object, or null if the node
is invalid
- static EppCommandDeleteSvcsub remove( DOMString id, DOMString xid )
-
Creates an
EppCommandDeleteSvcsub
object for
deleting an EPP Svcsub object from the registry.
- Parameters:
- id - the id of the subscription object to be deleted
xid - the client transaction id associated with the operation
- static EppCommandInfoSvcsub info( DOMString id, DOMString xid )
-
Creates an
EppCommandInfoSvcsub
object for
querying the details of an EPP Svcsub object
- Parameters:
- id - the id of the subscription object to be queried
xid - the client transaction id associated with the operation
- static EppCommandCheckSvcsub check( DOMString xid )
-
Creates an
EppCommandCheckSvcsub
object for
checking the existance of EPP Svcsub objects in the registry.
Names of EPP Svcsub objects can be added via the
add
or addName
methods.
- Parameters:
- xid - the client transaction id associated with the operation
- static EppCommandTransferSvcsub transfer( DOMString id, EppPeriod& period, DOMString xid )
-
Creates an
EppCommandTransferSvcsub
object for
transfering an EPP Svcsub object in the registry. The operation
type, registration period and authorization information associated
with the operation should be specified via setPeriod
,
setOperation
and setAuthInfo
method.
- Parameters:
- id - the id of the subscription object to be transferred
- period the extended registration period of the subscription
object, or null if there is no change in the expiration
timestamp of the subscription object after the transfer
operation
xid - the client transaction id associated with the operation
- static EppCommandUpdateSvcsub update( DOMString id, DOMString xid )
-
Creates an
EppCommandUpdateSvcsub
object for
updating an EPP Svcsub object in the registry. The actual update
information should be specified via the various methods defined
for the EppCommandUpdateSvcsub
object.
- Parameters:
- id - the id of the subscription object to be updated
xid - the client transaction id associated with the operation
- static EppCommandRenewSvcsub renew( DOMString id, time_t curExpDate, EppPeriod& period, DOMString xid )
-
Creates an
EppCommandRenewSvcsub
object for
renewing the registration of an EPP Svcsub object in the registry.
- Parameters:
- id - the id of the subscription object to be renewed
- curExpDate the current expiration date of the subscription object
- period the new registration period of the subscription object,
or null if using the value specified by the
registry
xid - the client transaction id associated with the
operation
- This class has no child classes.
- Author:
- Ning Zhang ning.zhang@neustar.com
- Version:
- $Revision$
Alphabetic index HTML hierarchy of classes or Java
Copyright © 2001-2002 NeuStar, Inc. All Rights Reserved.