com.logicboxes.foundation.sfnb.order
Class DomContact

java.lang.Object
  extended by com.logicboxes.foundation.sfnb.order.DomContact

public class DomContact
extends java.lang.Object


Constructor Summary
DomContact()
           
 
Method Summary
 int add(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String name, java.lang.String company, java.lang.String emailAddr, java.lang.String address1, java.lang.String address2, java.lang.String address3, java.lang.String city, java.lang.String state, java.lang.String country, java.lang.String zip, java.lang.String telNoCc, java.lang.String telNo, java.lang.String faxNoCc, java.lang.String faxNo, int customerId)
          Deprecated. 
 int addContact(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String name, java.lang.String company, java.lang.String emailAddr, java.lang.String address1, java.lang.String address2, java.lang.String address3, java.lang.String city, java.lang.String state, java.lang.String country, java.lang.String zip, java.lang.String telNoCc, java.lang.String telNo, java.lang.String faxNoCc, java.lang.String faxNo, int customerId, java.lang.String type, java.util.HashMap extraInfo)
          Adds a contact using the details provided for the specified type.
 int addDefaultContact(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId)
          Deprecated. 
 java.util.HashMap addDefaultContacts(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId, java.util.Vector types)
          Added this method for resolving PHP api kit problem Adds a contact using the details of the customer.
 java.util.HashMap delete(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int contactId)
          Deletes contact
 java.util.HashMap getDefaultContacts(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId, java.util.Vector types)
           
 java.util.HashMap getDetails(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int contactId, java.util.Vector option)
          Returns entity details depending upon various option values.Pass All if all details require
 java.util.HashMap list(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId, int[] contactId, java.lang.String[] currentStatus, java.lang.String creationDTRangStart, java.lang.String creationDTRangEnd, java.lang.String contactName, java.lang.String companyName, java.lang.String emailAddr, int numOfRecordPerPage, int pageNum, java.lang.String[] orderBy)
          Deprecated. 
 java.util.HashMap listByType(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId, int[] contactId, java.lang.String[] currentStatus, java.lang.String creationDTRangStart, java.lang.String creationDTRangEnd, java.lang.String contactName, java.lang.String companyName, java.lang.String emailAddr, int numOfRecordPerPage, int pageNum, java.lang.String[] orderBy, java.lang.String type, java.util.Vector requirements)
          This method returns a list of Contacts that match the specified search criteria.
 java.util.HashMap listNames(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId)
          Returns a list of ContactName - CompanyName of all contacts for the specified customerId
 java.util.HashMap listNamesByContactTypes(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId, java.lang.String[] type)
          This method returns a list of Contacts that match the specified search criteria.
 java.util.HashMap mod(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int contactId, java.lang.String name, java.lang.String company, java.lang.String emailAddr, java.lang.String address1, java.lang.String address2, java.lang.String address3, java.lang.String city, java.lang.String state, java.lang.String country, java.lang.String zip, java.lang.String telNoCc, java.lang.String telNo, java.lang.String faxNoCc, java.lang.String faxNo)
          Modifies the details for the specified contact.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DomContact

public DomContact()
Method Detail

listByType

public java.util.HashMap listByType(java.lang.String SERVICE_USERNAME,
                                    java.lang.String SERVICE_PASSWORD,
                                    java.lang.String SERVICE_ROLE,
                                    java.lang.String SERVICE_LANGPREF,
                                    int SERVICE_PARENTID,
                                    int customerId,
                                    int[] contactId,
                                    java.lang.String[] currentStatus,
                                    java.lang.String creationDTRangStart,
                                    java.lang.String creationDTRangEnd,
                                    java.lang.String contactName,
                                    java.lang.String companyName,
                                    java.lang.String emailAddr,
                                    int numOfRecordPerPage,
                                    int pageNum,
                                    java.lang.String[] orderBy,
                                    java.lang.String type,
                                    java.util.Vector requirements)
This method returns a list of Contacts that match the specified search criteria. If you do not want to specify a particular criterion, pass null for that parameter.

Parameters:
customerId - The customerId for which list of details are required
contactId - Array of ContactIds for listing of specific contacts or null for all contacts
currentStatus - Array for listing contacts of specific CurrentStatus or null for all. Valid values are: InActive, Active, Suspended, Deleted
creationDTRangStart - UNIX TimeStamp (epoch) for listing contacts created after creationDTRangStart or null for all contacts
creationDTRangEnd - UNIX TimeStamp (epoch) for listing contacts created before creationDTRangEnd or null for all contacts
contactName - Searches for contacts whose name contains 'contactName'
companyName - Searches for contacts whose company contains 'companyName'
emailAddr - Searches for contacts whose email address contains 'emailAddr'
numOfRecordPerPage - Number of Records to be returned. The maximum valoue allowed is 50.
pageNum - Page Number for which records are required.
orderBy - Array of Field names for sorting listing of contacts or null for default by contactId
type - Type of contact (Contact, CoopContact, UkContact, EuContact, Sponsor)
requirements - A Vector which Specify other requirement for contact. for eg. if you want to retirieve the NexusCatagory & ApplicationPurpose information associated with a contact, then put the value as nexusInfoRequired.
Returns:
Map which contains contact details


listNames

public java.util.HashMap listNames(java.lang.String SERVICE_USERNAME,
                                   java.lang.String SERVICE_PASSWORD,
                                   java.lang.String SERVICE_ROLE,
                                   java.lang.String SERVICE_LANGPREF,
                                   int SERVICE_PARENTID,
                                   int customerId)
Returns a list of ContactName - CompanyName of all contacts for the specified customerId

Parameters:
customerId - the customer for whom the list should be returned
Returns:
Hashtable which contains contact details

The Key for the Hashtable is index starting from 1. The Value is another Hashtable which contains key-value pairs of contact information with the following keys:

contactid name company emailaddr

Throws:
LogicBoxesException - if option value is null or Invalid SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

delete

public java.util.HashMap delete(java.lang.String SERVICE_USERNAME,
                                java.lang.String SERVICE_PASSWORD,
                                java.lang.String SERVICE_ROLE,
                                java.lang.String SERVICE_LANGPREF,
                                int SERVICE_PARENTID,
                                int contactId)
Deletes contact

Parameters:
contactId - The contact id to be deleted.
Returns:
Hahstable having key value pairs about the deletion action.

listNamesByContactTypes

public java.util.HashMap listNamesByContactTypes(java.lang.String SERVICE_USERNAME,
                                                 java.lang.String SERVICE_PASSWORD,
                                                 java.lang.String SERVICE_ROLE,
                                                 java.lang.String SERVICE_LANGPREF,
                                                 int SERVICE_PARENTID,
                                                 int customerId,
                                                 java.lang.String[] type)
This method returns a list of Contacts that match the specified search criteria. If you do not want to specify a particular criterion, pass null for that parameter.

Parameters:
customerId - The customerId for which list of details are required
type - The type of the contact you want to list. This can have the following values : Contact -> In case the conatct is a normal contact : Sponsor -> If the contact is a sponsor also : euregistrantcontact -> If the contact is added as a registrant contact in the .EU registry : eutechnicalcontact -> If the contact is added as a technical contact in the .EU registry
Returns:
Hashtable which contains contact details

The Key for the Hashtable is index starting from 1. The Value is another Hashtable which contains key-value pairs of contact information.


getDetails

public java.util.HashMap getDetails(java.lang.String SERVICE_USERNAME,
                                    java.lang.String SERVICE_PASSWORD,
                                    java.lang.String SERVICE_ROLE,
                                    java.lang.String SERVICE_LANGPREF,
                                    int SERVICE_PARENTID,
                                    int contactId,
                                    java.util.Vector option)
Returns entity details depending upon various option values.Pass All if all details require

Parameters:
contactId - - ContactId for which details required
option - - Vector of different option for details listing.Allowed Option values are All, StatusDetails, PricingDetails or ExecutionInfoParams
Returns:
Hashtable - key/value pair for all fields depending upon option
Throws:
LogicBoxesException - if option value is null or Invalid SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

addDefaultContact

@Deprecated
public int addDefaultContact(java.lang.String SERVICE_USERNAME,
                                        java.lang.String SERVICE_PASSWORD,
                                        java.lang.String SERVICE_ROLE,
                                        java.lang.String SERVICE_LANGPREF,
                                        int SERVICE_PARENTID,
                                        int customerId)
Deprecated. 

Added this method for relosving PHP api kit problem Adds a contact using the details of the customer. A contact is created with the same details (such as email address, postal address, etc) as the customer.

Parameters:
customerId - The customer under whom the contact is to be created
Returns:
contactId The Contact Id of the newly added contact.
Throws:
LogicBoxesException - if option value is null or Invalid SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

add

@Deprecated
public int add(java.lang.String SERVICE_USERNAME,
                          java.lang.String SERVICE_PASSWORD,
                          java.lang.String SERVICE_ROLE,
                          java.lang.String SERVICE_LANGPREF,
                          int SERVICE_PARENTID,
                          java.lang.String name,
                          java.lang.String company,
                          java.lang.String emailAddr,
                          java.lang.String address1,
                          java.lang.String address2,
                          java.lang.String address3,
                          java.lang.String city,
                          java.lang.String state,
                          java.lang.String country,
                          java.lang.String zip,
                          java.lang.String telNoCc,
                          java.lang.String telNo,
                          java.lang.String faxNoCc,
                          java.lang.String faxNo,
                          int customerId)
Deprecated. 

Adds a contact using the details provided.

Parameters:
customerId - The customer under whom the contact is to be created
name - Name OF Contact
company - Name Of the company
emailAddr - Email address of the contact e.g urname@domainname.com
address1 - Address line1
address2 - Address line2
address3 - Address line3
city - Name of the City
state - Name of the state
country - Country
zip - zipcode
telNoCc - telephone no country code e.g. 91
telNo - telephone no. e.g. 9892478335
faxNoCc - fax no. country code
faxNo - fax no.
Returns:
contactId The Contact Id of the newly added contact.
Throws:
LogicBoxesException - if option value is null or Invalid SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

mod

public java.util.HashMap mod(java.lang.String SERVICE_USERNAME,
                             java.lang.String SERVICE_PASSWORD,
                             java.lang.String SERVICE_ROLE,
                             java.lang.String SERVICE_LANGPREF,
                             int SERVICE_PARENTID,
                             int contactId,
                             java.lang.String name,
                             java.lang.String company,
                             java.lang.String emailAddr,
                             java.lang.String address1,
                             java.lang.String address2,
                             java.lang.String address3,
                             java.lang.String city,
                             java.lang.String state,
                             java.lang.String country,
                             java.lang.String zip,
                             java.lang.String telNoCc,
                             java.lang.String telNo,
                             java.lang.String faxNoCc,
                             java.lang.String faxNo)
Modifies the details for the specified contact.

Parameters:
contactId - the contact whose details are to be modified.
name - Name OF Contact
company - Name Of the company
emailAddr - Email address of the contact e.g urname@domainname.com
address1 - Address line1
address2 - Address line2
address3 - Address line3
city - Name of the City
state - Name of the state
country - Country
zip - zipcode
telNoCc - telephone no country code e.g. 91
telNo - telephone no. e.g. 9892478335
faxNoCc - fax no. country code
faxNo - fax no.
Returns:
Hashtable A Hashtable with the result of the modification.

entityid=245 description=DomainContact actiontype=Mod actiontypedesc=Modification of Contact Details in the Registry actionstatus=Success actionstatusdesc=Contact modification completed successfully in all registry status=Success

Throws:
LogicBoxesException - if option value is null or Invalid SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

list

@Deprecated
public java.util.HashMap list(java.lang.String SERVICE_USERNAME,
                                         java.lang.String SERVICE_PASSWORD,
                                         java.lang.String SERVICE_ROLE,
                                         java.lang.String SERVICE_LANGPREF,
                                         int SERVICE_PARENTID,
                                         int customerId,
                                         int[] contactId,
                                         java.lang.String[] currentStatus,
                                         java.lang.String creationDTRangStart,
                                         java.lang.String creationDTRangEnd,
                                         java.lang.String contactName,
                                         java.lang.String companyName,
                                         java.lang.String emailAddr,
                                         int numOfRecordPerPage,
                                         int pageNum,
                                         java.lang.String[] orderBy)
Deprecated. 

This method returns a list of Contacts that match the specified search criteria. If you do not want to specify a particular criterion, pass null for that parameter.

Parameters:
customerId - The customerId for which list of details are required
contactId - Array of ContactIds for listing of specific contacts or null for all contacts
currentStatus - Array for listing contacts of specific CurrentStatus or null for all. Valid values are: InActive, Active, Suspended, Deleted
creationDTRangStart - UNIX TimeStamp (epoch) for listing contacts created after creationDTRangStart or null for all contacts
creationDTRangEnd - UNIX TimeStamp (epoch) for listing contacts created before creationDTRangEnd or null for all contacts
contactName - Searches for contacts whose name contains 'contactName'
companyName - Searches for contacts whose company contains 'companyName'
emailAddr - Searches for contacts whose email address contains 'emailAddr'
numOfRecordPerPage - Number of Records to be returned. The maximum valoue allowed is 50.
pageNum - Page Number for which records are required.
orderBy - Array of Field names for sorting listing of contacts or null for default by contactId
Returns:
Hashtable which contains contact details

The Key for the Hashtable is index starting from 1. The Value is another Hashtable which contains key-value pairs of contact information.


addDefaultContacts

public java.util.HashMap addDefaultContacts(java.lang.String SERVICE_USERNAME,
                                            java.lang.String SERVICE_PASSWORD,
                                            java.lang.String SERVICE_ROLE,
                                            java.lang.String SERVICE_LANGPREF,
                                            int SERVICE_PARENTID,
                                            int customerId,
                                            java.util.Vector types)
Added this method for resolving PHP api kit problem Adds a contact using the details of the customer. A contact is created with the same details (such as email address, postal address, etc) as the customer.

Parameters:
customerId - The customer under whom the contact is to be created
types - A Vector of all the types for which you want to add default contacts for the customer. This can take following values : Contact, CoopContact, UkContact, EuContact, Sponsor
Returns:
Hashtable containing the key value pairs of the type and the corresponding default ContactId of that type.

getDefaultContacts

public java.util.HashMap getDefaultContacts(java.lang.String SERVICE_USERNAME,
                                            java.lang.String SERVICE_PASSWORD,
                                            java.lang.String SERVICE_ROLE,
                                            java.lang.String SERVICE_LANGPREF,
                                            int SERVICE_PARENTID,
                                            int customerId,
                                            java.util.Vector types)
Parameters:
customerId - The customerId of the customer of which you want to get the default contacts.
types - The vector of types of the contacts. This can take following values : Contact, CoopContact, UkContact, EuContact, Sponsor
Returns:
An hashtable contaning the each type as the key and a corresponding contact hash of size 4 as value. The contact hash corresponding to each type, contains the admin, tech, billing, and regsitrant conatct information.
Throws:
LogicBoxesException

addContact

public int addContact(java.lang.String SERVICE_USERNAME,
                      java.lang.String SERVICE_PASSWORD,
                      java.lang.String SERVICE_ROLE,
                      java.lang.String SERVICE_LANGPREF,
                      int SERVICE_PARENTID,
                      java.lang.String name,
                      java.lang.String company,
                      java.lang.String emailAddr,
                      java.lang.String address1,
                      java.lang.String address2,
                      java.lang.String address3,
                      java.lang.String city,
                      java.lang.String state,
                      java.lang.String country,
                      java.lang.String zip,
                      java.lang.String telNoCc,
                      java.lang.String telNo,
                      java.lang.String faxNoCc,
                      java.lang.String faxNo,
                      int customerId,
                      java.lang.String type,
                      java.util.HashMap extraInfo)
Adds a contact using the details provided for the specified type. Also,

Parameters:
name - Name OF Contact
company - Name Of the company
emailAddr - Email address of the contact e.g urname@domainname.com
address1 - Address line1
address2 - Address line2
address3 - Address line3
city - Name of the City
state - Name of the state
country - Country
zip - zipcode
telNoCc - telephone no country code e.g. 91
telNo - telephone no. e.g. 9892478335
faxNoCc - fax no. country code
faxNo - fax no.
customerId - The customer under whom the contact is to be created
type - The contact type. This can take following values : Contact, CoopContact, UkContact, EuContact, Sponsor
extraInfo - This hash will contain any extra information for a particular contact, that is being added. The following variables need to be passed:
1. purpose, category (to associate the contact with a .US domain name)
2. sponsor1, sponsor2 (to associate the contact with a .COOP domain name)
Returns:
contactId The Contact Id of the newly added contact. If a contact exists with same name and company then it returns existing contactid.