com.logicboxes.foundation.sfnb.order.dnsbox
Class ZoneOrder

java.lang.Object
  extended by com.logicboxes.foundation.sfnb.order.dnsbox.ZoneOrder

public class ZoneOrder
extends java.lang.Object


Constructor Summary
ZoneOrder()
           
 
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 del(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 zoneid, java.util.Vector options)
          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. 
 int getOrderIdByDomain(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.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 description, java.lang.String recordtype, java.lang.String source, java.lang.String destination, 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 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 zoneid, int modnoofrecords, int modnoofyears)
          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 setupDNSService(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 DNS Service for the domain name
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ZoneOrder

public ZoneOrder()
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 description,
                                         java.lang.String recordtype,
                                         java.lang.String source,
                                         java.lang.String destination,
                                         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 zone orders those matches the specified search criteria.

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: InActive, Active, Suspended, Deleted
description - Domainname for listing Orders under specific Domain
recordtype - String value indicating the recordtype Valid values are : A,CNAME,MX,NS Pass null to ignore this criteria
source -
destination -
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:

entity.entityid orders.orderid entity.customerid entity.entitytypeid entity.currentstatus entity.description orders.endtime orders.creationtime orders.creationdt orders.timestamp entitytype.entitytypename entitytype.entitytypekey


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 the specified domain name(s) for the Managed DNS Service

Parameters:
domainHash - This should contain the domain name(s) which are to be added. The HashMap should have the domainname as the key, and the no of Years as the value. 500 Records would be alloted for each domain. Number of Records will be ignored.
customerId - The customer under whom the orders should be added
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. OnlyAdd - The order will simply be added but NOT executed in the system. A customer invoice will be generated. However, the invoice will not be paid. 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 Addition. The HashMap has the domainnames as the key, and a HashMap as the value. The inner HashMap will have key-values as follows:

entityid=435 description=apitest04.com actiontype=RenewDomain actiontypedesc=Renewal of apitest04.com for 1 years actionstatus=Success actionstatusdesc=Domain renewed successully status=Success eaqid=1169

Incase you have chosen "KeepInvoice" or "PayInvoice", the return HashMap will also contain the following data:

customerid=8 invoiceid=727 sellingcurrencysymbol=INR sellingamount=-500.000 unutilisedsellingamount=-500.000

invoiceid is the Id that you will need to pass to Fund.payCustomerTransaction if you wish to pay the invoice at a later date. selllingamount is the Invoice amount in your Selling Currency unutilisedselllingamount is the Pending Invoice amount in your Selling Currency. In case of "KeepInvoice", the pending amount will always be equal to the invoice amount. In case of "PayInvoice", if the Customer does not have sufficient funds to pay the entire invoice amount, unutilisedsellingamount will reflect the balance amount that is pending. If the invoice has been completely paid, the unutilisedsellingamount will be 0.


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 zone order 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 ofyears, expirydate = expiry date in seconds } } e.g. { directi.com = { orderid = 123, noofyears = 1, expirydate = 2000 } }

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

del

@Deprecated
public java.util.HashMap del(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. 

Deletes the Managed DNS Service for the specified domain

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

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 zoneid,
                                               java.util.Vector options)
Deprecated. 

Gets the Details of the specified order based on given option(s)

Parameters:
zoneid - The zoneid under which the details are to be listed
options - 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 customerdetails= resellerdetails= orderdetails=
Each further returns an AssociativeArray containing repective details


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 zoneid,
                                        int modnoofrecords,
                                        int modnoofyears)
Deprecated. 

Modifies the Details of the specified zone order based on given option(s)

Parameters:
zoneid - The zoneid for which zone order to be modified
modnoofrecords - No of records to be modified
modnoofyears - No of years
Returns:
A HashMap with the modified details of the zone order

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 zone order based on given domainname.

Parameters:
domainName - The domainname under which the details are to be listed
option - Vector for listing Orders with various options *
Valid values are: All,ConflictDetails,PricingDetails,StatusDetails,OrderDetails, ExecutionInfoParams,OrderDetails
Returns:
A HashMap with the result

Values returned by the HashMap are customerdetails= resellerdetails= orderdetails=
Each further returns an AssociativeArray containing repective details


getOrderIdByDomain

@Deprecated
public int getOrderIdByDomain(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.lang.String productkey)
Deprecated. 

Gets the OrderId of zoneorder for the given domainname

Parameters:
domainName - The domainname for which the orderid is to be listed
Returns:
OrderId of domainname

setupDNSService

public java.util.HashMap setupDNSService(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 DNS Service for the domain name

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