com.logicboxes.foundation.sfnb.order.domainfwd
Class DomFwdOrder

java.lang.Object
  extended by com.logicboxes.foundation.sfnb.order.domainfwd.DomFwdOrder

public class DomFwdOrder
extends java.lang.Object


Constructor Summary
DomFwdOrder()
           
 
Method Summary
 java.util.HashMap 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.util.HashMap domainHash, int customerId, java.lang.String invoiceOption)
          Deprecated. 
 java.util.HashMap deleteService(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int entityId)
          Deprecated. 
 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 orderId, java.util.Vector option)
          Deprecated. 
 java.util.HashMap getDetailsByDomain(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 domainName, java.util.Vector option, java.lang.String productkey)
          Deprecated. 
 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[] orderId, int[] resellerId, int[] customerId, boolean showChildOrders, java.lang.String[] currentStatus, java.lang.String domainname, java.lang.String forward, java.lang.String checkUrlMasking, java.lang.String checkPathForwarding, java.lang.String checkSubDomainForwarding, java.lang.String creationDTRangStart, java.lang.String creationDTRangEnd, java.lang.String endTimeRangStart, java.lang.String endTimeRangEnd, int numOfRecordPerPage, int pageNum, java.lang.String[] orderBy)
          Deprecated. 
 java.util.HashMap manage(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int entityId, java.lang.String forward, boolean urlMasking, boolean subdomainForwarding, java.lang.String noframes, java.lang.String headerTags)
          Deprecated. 
 void manageDomainForwardService(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 domainName, boolean urlMasking, boolean subdomainForwarding, java.lang.String forward, java.lang.String noframes, java.lang.String headerTags)
          Modifies the Domain forward service
 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 entityId, java.lang.String forward, boolean urlMasking, boolean subdomainForwarding, java.lang.String noframes, java.lang.String headerTags)
          Deprecated. 
 java.util.HashMap renew(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.util.HashMap domainHash, java.lang.String invoiceOption)
          Deprecated. 
 java.util.HashMap setupDomainFwdService(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int orderID)
          Setup Free Domain Forwarding Service for the domain name
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DomFwdOrder

public DomFwdOrder()
Method Detail

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[] orderId,
                                         int[] resellerId,
                                         int[] customerId,
                                         boolean showChildOrders,
                                         java.lang.String[] currentStatus,
                                         java.lang.String domainname,
                                         java.lang.String forward,
                                         java.lang.String checkUrlMasking,
                                         java.lang.String checkPathForwarding,
                                         java.lang.String checkSubDomainForwarding,
                                         java.lang.String creationDTRangStart,
                                         java.lang.String creationDTRangEnd,
                                         java.lang.String endTimeRangStart,
                                         java.lang.String endTimeRangEnd,
                                         int numOfRecordPerPage,
                                         int pageNum,
                                         java.lang.String[] orderBy)
Deprecated. 

Returns a list of Domain Names that match the specified search criteria. If you do not want to specify a particular criteria, pass null for object parameters and 0 for numeric parameters

Parameters:
orderId - Array of OrderIds for listing Specific Orders
resellerId - Array of ResellerIds for listing Orders under specific Sub-Reseller(s)
customerId - Array of CustomerIds for listing Orders belonging to specific Customer(s)
showChildOrders - boolean value to indicate whether to list sub-resellers/ customers orders
currentStatus - Array for listing Orders having specific Current Status Valid values are: Active, Suspended, Pending, Deleted
domainname - Domainname for listing Orders under specific Domain
forward - String for listing OrderTest having specific forward URL
checkUrlMasking - String to indicate whether to check for URL masking enabled Domains Valid values are: true, false null value will indicates that URL Masking is not to be considered
checkPathForwarding - String to indicate whether to check for Path Forwarding enabled Domains Valid values are: true, false null value will indicates that Path Forwarding is not to be considered
checkSubDomainForwarding - String to indicate whether to check for SubDomain Forwarding enabled Domains Valid values are: true, false null value will indicates that SubDomain Forwarding is not to be considered
creationDTRangStart - UNIX TimeStamp (epoch) for listing Orders created after creationDTRangStart
creationDTRangEnd - UNIX TimeStamp (epoch) for listing Orders created before creationDTRangEnd
endTimeRangStart - UNIX TimeStamp (epoch) for listing Orders ending after endTimeRangStart
endTimeRangEnd - UNIX TimeStamp (epoch) for listing Orders ending before endTimeRangEnd
numOfRecordPerPage - No. 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 Orders. Default sorting is by orderId.
Returns:
HashMap which contains list of orders matching the search criteria

The Keys for the HashMap are values from 1 to n. The Value is another HashMap which contains key-value pairs of domain information. The outer HashMap also contains two additional parameters -

recsonpage = The no of records returned in this HashMap recsindb = The total no of records available that match the search criteria

Keys in the inner HashMap per order:

orders.orderid=186 entity.currentstatus=Deleted entity.customerid=25 entitytype.entitytypekey=domainfwd entity.entityid=186 entitytype.entitytypename=Domain Forward Service entity.description=domainname.com orders.creationtime=1075466931, orders.creationdt=1075814072 entity.entitytypeid=14 orders.timestamp=2004-02-03 13:14:31.706839

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 java.util.HashMap 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.util.HashMap domainHash,
                                        int customerId,
                                        java.lang.String invoiceOption)
Deprecated. 

Adds a contact using the details provided.

Parameters:
domainHash - domainhash contains domainname and key as no. of years.
customerId - numeric id of the customer.
invoiceOption - This parameter will decide how the Customer Invoices will be handled.

NoInvoice - If this value is passed, then no customer invoice will be generated for the domains. PayInvoice - If this value is passed, then a customer invoice will be generated for the domains in the first step. If there is sufficient balance in the Customer's Debit Account, then the invoices will be paid and the domains will be registered. If a customer has less balance than required, then as many domains as possible will be registered with the existing funds. All other orders will remain pending in the system. KeepInvoice- If this value is passed, then a customer invoice will be generated for the domains. However, these invoices will not be paid. They will be kept pending, while the orders will be executed.

Returns:
HashTable A Hashtable with the result of the addition.
Throws:
LogicBoxesException - if option value is null or Invalid SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

mod

@Deprecated
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 entityId,
                                        java.lang.String forward,
                                        boolean urlMasking,
                                        boolean subdomainForwarding,
                                        java.lang.String noframes,
                                        java.lang.String headerTags)
Deprecated. 

Modifies the Domain forward service

Parameters:
entityId - The entityId under which the service to be modifed is created
forward - The url forward String that need to be set
urlMasking - Boolean value indicating whether to avail urlMasking
subdomainForwarding - Boolean value indicating whether to avail subdomainForwarding
noframes - The NoFrame tag to be set. Set it empty if not required
headerTags - The headerTag to be set
Returns:
HashMap A HashMap with the result of the modification.

actionstatusdesc=Modification Completed Successfully., actiontypedesc=Modification of Domain Forward OrderTest for domainname.info, currentaction=221211, eaqid=221211, entityid=6801, description=domainname.info, actiontype=ModForward, status=Success, actionstatus=Success

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

renew

@Deprecated
public java.util.HashMap renew(java.lang.String SERVICE_USERNAME,
                                          java.lang.String SERVICE_PASSWORD,
                                          java.lang.String SERVICE_ROLE,
                                          java.lang.String SERVICE_LANGPREF,
                                          int SERVICE_PARENTID,
                                          java.util.HashMap domainHash,
                                          java.lang.String invoiceOption)
Deprecated. 

Renews the Service for the specified domain name(s)

Parameters:
domainHash - This should contain the domain name(s) which are to be renewed.

In domainHash one has to send HashMap containing Inside one more HashMap. It contains following info.

{ domain name = { entityid = orderId, noofyears = No ofears, expirydate = expiry date in seconds } } e.g. { directi.com = { entityid = 123, noofyears = 1, expirydate = 2000 } } { reseller.com = { entityid = 125, noofyears = 4, expirydate = 4000 } }

invoiceOption - This parameter will decide how the Customer Invoices will be handled.

NoInvoice If this value is passed, then no customer invoice will be generated for the domains. PayInvoice - If this value is passed, then a customer invoice will be generated for the domains in the first step. If there is sufficient balance in the Customer's Debit Account, then the invoices will be paid and the domains will be registered. If a customer has less balance than required, then as many domains as possible will be registered with the existing funds. All other orders will remain pending in the system. KeepInvoice - If this value is passed, then a customer invoice will be generated for the domains. However, these invoices will not be paid. They will be kept pending, while the orders will be executed.

Returns:
HashMap A HashMap with the result of the Renwwal. The HashMap has the

domainnames as the key, and a HashMap as the value. The inner HashMap will have key-values as follows:

actionstatusdesc=Domain Forward renewal completed successfully, actiontypedesc=Renewal of Domain Forward OrderTest for oogle.info for 1 years, eaqid=221210, unutilisedsellingamount=-0.440, status=Success, sellingcurrencysymbol=USD, customerid=2925, sellingamount=-0.440, entityid=6801, description=oogle.info, actiontype=RenewForward, invoiceid=3437, actionstatus=Success

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

manage

@Deprecated
public java.util.HashMap manage(java.lang.String SERVICE_USERNAME,
                                           java.lang.String SERVICE_PASSWORD,
                                           java.lang.String SERVICE_ROLE,
                                           java.lang.String SERVICE_LANGPREF,
                                           int SERVICE_PARENTID,
                                           int entityId,
                                           java.lang.String forward,
                                           boolean urlMasking,
                                           boolean subdomainForwarding,
                                           java.lang.String noframes,
                                           java.lang.String headerTags)
Deprecated. 

Manages the Domain forward service

Parameters:
entityId - The entityId under which the service to be modifed is created
forward - The url forward String that need to be set
urlMasking - Boolean value indicating whether to avail urlMasking
subdomainForwarding - Boolean value indicating whether to avail subdomainForwarding
noframes - The NoFrame tag to be set. Set it empty if not required
headerTags - The headerTag to be set
Returns:
HashMap A HashMap with the result of the modification.

actionstatusdesc=Modification Completed Successfully., actiontypedesc=Modification of Domain Forward OrderTest for domainname.info, currentaction=221211, eaqid=221211, entityid=6801, description=domainname.info, actiontype=ManageForward, status=Success, actionstatus=Success

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

deleteService

@Deprecated
public java.util.HashMap deleteService(java.lang.String SERVICE_USERNAME,
                                                  java.lang.String SERVICE_PASSWORD,
                                                  java.lang.String SERVICE_ROLE,
                                                  java.lang.String SERVICE_LANGPREF,
                                                  int SERVICE_PARENTID,
                                                  int entityId)
Deprecated. 

Manages the Domain forward service

Parameters:
entityId - The entityId for which the service to be deleted
Returns:
HashMap A HashMap with the result of the deletion.

actionstatusdesc=Deletion Completed Successfully., actiontypedesc=Deletion of Domain Forward OrderTest for domainname.info, currentaction=221211, eaqid=221211, entityid=6801, description=domainname.info, actiontype=DeleteForward, status=Success, actionstatus=Success

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

getDetails

@Deprecated
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 orderId,
                                               java.util.Vector option)
Deprecated. 

Gets the Details of the specified order based on given option

Parameters:
orderId - The orderId under which the details is to be listed
option - Vector for listing Orders with various options


Valid values are: All,OrderDetails,PricingDetails

Returns:
A HashMap with the result

Values returned by the HashMap are urlmasking=true, productName=Domain Forwarding, orderid=6801, pathforwarding=false, creationtime=1094538648, endtime=1159747199, subdomainforwarding=true, customerid=2925, orderstatus=[], forward=mydomain.com, domainname=domainname.info, headertags=Hello Page, noframes=, parentkey=999999999_1_11

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

getDetailsByDomain

@Deprecated
public java.util.HashMap getDetailsByDomain(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 domainName,
                                                       java.util.Vector option,
                                                       java.lang.String productkey)
Deprecated. 

Gets the Details of the specified order based on given domainname and options

Parameters:
domainName - The doaminname under which the details is to be listed
option - Vector for listing Orders with various options
Valid values are: All,OrderDetails,PricingDetails
Returns:
A HashMap with the result of details

Values returned by the HashMap are urlmasking=true, productName=Domain Forwarding, orderid=6801, pathforwarding=false, creationtime=1094538648, endtime=1159747199, subdomainforwarding=true, customerid=2925, orderstatus=[], forward=mydomain.com, domainname=domainname.info, headertags=Hello Page, noframes=, parentkey=999999999_1_11

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

setupDomainFwdService

public java.util.HashMap setupDomainFwdService(java.lang.String SERVICE_USERNAME,
                                               java.lang.String SERVICE_PASSWORD,
                                               java.lang.String SERVICE_ROLE,
                                               java.lang.String SERVICE_LANGPREF,
                                               int SERVICE_PARENTID,
                                               int orderID)
Setup Free Domain Forwarding Service for the domain name

Parameters:
orderID - Orderid on which the Domain Forwarding Service needs to be activated.
Returns:
Hashtable has the status of the Domain Forwarding Service setup process.

manageDomainForwardService

public void manageDomainForwardService(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 domainName,
                                       boolean urlMasking,
                                       boolean subdomainForwarding,
                                       java.lang.String forward,
                                       java.lang.String noframes,
                                       java.lang.String headerTags)
Modifies the Domain forward service

Parameters:
domainName - The domain name for which the service to be modifed
forward - The url forward String that need to be set
urlMasking - Boolean value indicating whether to avail urlMasking
subdomainForwarding - Boolean value indicating whether to avail subdomainForwarding
noframes - The NoFrame tag to be set. Set it empty if not required
headerTags - The headerTag to be set
Throws:
LogicBoxesException - if option value is null or Invalid SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur