class EppSvcsub

This EppSvcsub class implements EPP Svcsub objects.

Inheritance:


Public Fields

[more]static const char* CONTACT_TYPE_ADMIN
Contact type for administration contact ("admin");
[more]static const char* CONTACT_TYPE_BILLING
Contact type for billing contact ("billing");
[more]static const char* CONTACT_TYPE_TECH
Contact type for technical contact ("tech")
[more]static const char* CONTACT_TYPE_PRIMARY
Contact type for primary contact ("primary")
[more]static const char* CONTACT_TYPE_SECONDARY
Contact type for secondary contact ("secondary")
[more]static const char* CONTACT_TYPE_BIZLOCK
Contact type for BIZlock contact ("bizlock")
[more]static const char* STATUS_CLIENT_DELETE_PROHIBITED
Svcsub status - clientDeleteProhibited
[more]static const char* STATUS_CLIENT_SUSPENDED
Svcsub status - clientSuspended
[more]static const char* STATUS_CLIENT_RENEW_PROHIBITED
Svcsub status - clientRenewProhibited
[more]static const char* STATUS_CLIENT_TRANSFER_PROHIBITED
Svcsub status - clientTransferProhibited
[more]static const char* STATUS_CLIENT_UPDATE_PROHIBITED
Svcsub status - clientUpdateProhibited
[more]static const char* STATUS_INACTIVE
Svcsub status - inactive
[more]static const char* STATUS_OK
Svcsub status - ok
[more]static const char* STATUS_PENDING_DELETE
Svcsub status - pendingDelete
[more]static const char* STATUS_PENDING_TRANSFER
Svcsub status - pendingTransfer
[more]static const char* STATUS_PENDING_VERIFICATION
Svcsub status - pendingVerification
[more]static const char* STATUS_SERVER_DELETE_PROHIBITED
Svcsub status - serverDeleteProhibited
[more]static const char* STATUS_SERVER_SUSPENDED
Svcsub status - serverSuspended
[more]static const char* STATUS_SERVER_RENEW_PROHIBITED
Svcsub status - serverRenewProhibited
[more]static const char* STATUS_SERVER_TRANSFER_PROHIBITED
Svcsub status - serverTransferProhibited
[more]static const char* STATUS_SERVER_UPDATE_PROHIBITED
Svcsub status - serverUpdateProhibited

Public Methods

[more] EppSvcsub()
Creates an EppSvcsub object
[more] EppSvcsub( DOMString id )
Creates an EppSvcsub object with a service subscription id
[more] EppSvcsub( DOMString id, DOMString service )
Creates an EppSvcsub object with a service subscription id and service name
[more] ~EppSvcsub()
Destructor
[more]virtual int getEntityType()
Returns the run-time type of an EppEntity object
[more]DOMString getId()
Gets the service subscription id
[more]void setId( DOMString id )
Sets the service subscription id
[more]DOMString getService()
Gets the service name
[more]void setService( DOMString service )
Sets the service name
[more]ValueVectorOf<EppSvcsubParam> * getParam()
Gets a list of parameters associated with the service subscription object
[more]ValueVectorOf<DOMString> * getParamValue( DOMString name )
Extracts a list of the parameter values associated with the service subscription object based on the parameter name.
[more]ValueVectorOf<DOMString> * getContactId( DOMString type )
Extracts a list of the contact ids associated with the service subscription object based on the contact type
[more]void addParam( EppSvcsubParam param )
Add a service parameter to be associated with the subscription
[more]void addParam( DOMString name, DOMString value )
Add a service parameter to be associated with the subscription, given a parameter name and its value
[more]ValueVectorOf<EppContactType> * getContact()
Gets a list of contacts associated with the service subscription object
[more]void addContact( EppContactType contact )
Adds a contact for the service subscription object
[more]void addContact( DOMString id, DOMString type )
Adds a contact for the domain, given a contact id and its type
[more]EppPeriod* getPeriod()
Gets registration period for the subscription
[more]void setPeriod( EppPeriod period )
Sets registration period for the subscription
[more]DOMString getRegistrant()
Gets the contact id of the registrant which owns the subscription
[more]void setRegistrant( DOMString registrant )
Sets the contact id of the registrant which owns the subscription
[more]DOM_Element toXML( DOM_Document& doc, const DOMString& tag )
Converts the EppSvcsub object into an XML element
[more]static EppSvcsub* fromXML( const DOM_Node& root )
Converts an XML element into an EppSvcsub object.
[more]static EppCommandDeleteSvcsub remove( DOMString id, DOMString xid )
Creates an EppCommandDeleteSvcsub object for deleting an EPP Svcsub object from the registry.
[more]static EppCommandInfoSvcsub info( DOMString id, DOMString xid )
Creates an EppCommandInfoSvcsub object for querying the details of an EPP Svcsub object
[more]static EppCommandCheckSvcsub check( DOMString xid )
Creates an EppCommandCheckSvcsub object for checking the existance of EPP Svcsub objects in the registry.
[more]static EppCommandTransferSvcsub transfer( DOMString id, EppPeriod& period, DOMString xid )
Creates an EppCommandTransferSvcsub object for transfering an EPP Svcsub object in the registry.
[more]static EppCommandUpdateSvcsub update( DOMString id, DOMString xid )
Creates an EppCommandUpdateSvcsub object for updating an EPP Svcsub object in the registry.
[more]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.


Inherited from EppObject:

Public Fields

ostatic const int CONTACT
ostatic const int DOMAIN
ostatic const int HOST
ostatic const int SVCSUB

Public Methods

oDOMString getRoid()
ovoid setRoid( DOMString roid )
oDOMString getClientId()
ovoid setClientId( DOMString clientId )
oDOMString getClientIdCreated()
ovoid setClientIdCreated( DOMString clientId )
otime_t getDateCreated()
ovoid setDateCreated( time_t cal )
oDOMString getClientIdUpdated()
ovoid setClientIdUpdated( DOMString clientId )
otime_t getDateUpdated()
ovoid setDateUpdated( time_t cal )
otime_t getDateExpired()
ovoid setDateExpired( time_t cal )
otime_t getDateTransferred()
ovoid setDateTransferred( time_t cal )
oEppAuthInfo* getAuthInfo()
ovoid setAuthInfo( EppAuthInfo authInfo )
oValueVectorOf<EppStatus> * getStatus()
ovoid addStatus( EppStatus status )
ostatic EppCommandCreate create( EppObject* object, DOMString xid )

Protected Fields

oDOMString roid
oValueVectorOf<EppStatus> * status
oDOMString clID
oDOMString crID
otime_t crDate
oDOMString upID
otime_t upDate
otime_t exDate
otime_t trDate
oEppAuthInfo* authInfo

Protected Methods

ovoid fromXMLCommon( const DOM_Node& node, const DOMString name )
ovoid toXMLCommon( DOM_Document& doc, DOM_Element& body )
ovoid freeCommon()


Inherited from EppEntity:

Public Methods

obool instanceOf( const int type )
ovirtual DOMString toString()

Protected Methods

oDOMString 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.

ostatic const char* CONTACT_TYPE_ADMIN
Contact type for administration contact ("admin");

ostatic const char* CONTACT_TYPE_BILLING
Contact type for billing contact ("billing");

ostatic const char* CONTACT_TYPE_TECH
Contact type for technical contact ("tech")

ostatic const char* CONTACT_TYPE_PRIMARY
Contact type for primary contact ("primary")

ostatic const char* CONTACT_TYPE_SECONDARY
Contact type for secondary contact ("secondary")

ostatic const char* CONTACT_TYPE_BIZLOCK
Contact type for BIZlock contact ("bizlock")

ostatic const char* STATUS_CLIENT_DELETE_PROHIBITED
Svcsub status - clientDeleteProhibited

ostatic const char* STATUS_CLIENT_SUSPENDED
Svcsub status - clientSuspended

ostatic const char* STATUS_CLIENT_RENEW_PROHIBITED
Svcsub status - clientRenewProhibited

ostatic const char* STATUS_CLIENT_TRANSFER_PROHIBITED
Svcsub status - clientTransferProhibited

ostatic const char* STATUS_CLIENT_UPDATE_PROHIBITED
Svcsub status - clientUpdateProhibited

ostatic const char* STATUS_INACTIVE
Svcsub status - inactive

ostatic const char* STATUS_OK
Svcsub status - ok

ostatic const char* STATUS_PENDING_DELETE
Svcsub status - pendingDelete

ostatic const char* STATUS_PENDING_TRANSFER
Svcsub status - pendingTransfer

ostatic const char* STATUS_PENDING_VERIFICATION
Svcsub status - pendingVerification

ostatic const char* STATUS_SERVER_DELETE_PROHIBITED
Svcsub status - serverDeleteProhibited

ostatic const char* STATUS_SERVER_SUSPENDED
Svcsub status - serverSuspended

ostatic const char* STATUS_SERVER_RENEW_PROHIBITED
Svcsub status - serverRenewProhibited

ostatic const char* STATUS_SERVER_TRANSFER_PROHIBITED
Svcsub status - serverTransferProhibited

ostatic const char* STATUS_SERVER_UPDATE_PROHIBITED
Svcsub status - serverUpdateProhibited

o EppSvcsub()
Creates an EppSvcsub object

o EppSvcsub( DOMString id )
Creates an EppSvcsub object with a service subscription id

o EppSvcsub( DOMString id, DOMString service )
Creates an EppSvcsub object with a service subscription id and service name

o ~EppSvcsub()
Destructor

ovirtual int getEntityType()
Returns the run-time type of an EppEntity object

oDOMString getId()
Gets the service subscription id

ovoid setId( DOMString id )
Sets the service subscription id

oDOMString getService()
Gets the service name

ovoid setService( DOMString service )
Sets the service name

oValueVectorOf<EppSvcsubParam> * getParam()
Gets a list of parameters associated with the service subscription object

oValueVectorOf<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

oValueVectorOf<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

ovoid addParam( EppSvcsubParam param )
Add a service parameter to be associated with the subscription

ovoid addParam( DOMString name, DOMString value )
Add a service parameter to be associated with the subscription, given a parameter name and its value

oValueVectorOf<EppContactType> * getContact()
Gets a list of contacts associated with the service subscription object

ovoid addContact( EppContactType contact )
Adds a contact for the service subscription object

ovoid addContact( DOMString id, DOMString type )
Adds a contact for the domain, given a contact id and its type

oEppPeriod* getPeriod()
Gets registration period for the subscription

ovoid setPeriod( EppPeriod period )
Sets registration period for the subscription

oDOMString getRegistrant()
Gets the contact id of the registrant which owns the subscription

ovoid setRegistrant( DOMString registrant )
Sets the contact id of the registrant which owns the subscription

oDOM_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

ostatic 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

ostatic 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

ostatic 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

ostatic 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

ostatic 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

ostatic 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

ostatic 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.