com.logicboxes.foundation.sfnb.order.mailfwd
Class MailFwdOrder

java.lang.Object
  extended by com.logicboxes.foundation.sfnb.order.mailfwd.MailFwdOrder

public class MailFwdOrder
extends java.lang.Object


Constructor Summary
MailFwdOrder()
           
 
Method Summary
 java.util.HashMap activateMailForwardService(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)
          Activates Free Mail Forward Service for the given orderid.
 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 addForward(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 prefix, java.lang.String forwardTo)
          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 delForward(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 prefix)
          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. 
 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 isBounceBack, 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 entityId, boolean status, java.lang.String defaultForward)
          Deprecated. 
 java.util.HashMap modForward(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 prefix, java.lang.String forwardTo)
          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. 
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MailFwdOrder

public MailFwdOrder()
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 isBounceBack,
                                         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 Domain Names that match 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
isBounceBack - value indicating whether bounceback is set to true or false Valid values are : true, false. Pass null for not considering this option
source - The source URL of the mail
destination - The destination URL of the mail
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 minimum value must be 10
pageNum - Page Number for which records are required i.e. 1
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=2850, entity.currentstatus=Active, entity.customerid=1151, entitytype.entitytypekey=mailfwd, entity.entityid=2850, entitytype.entitytypename=Mail Forward Service, entity.description=domainname.com, orders.creationdt=1083233646, entity.entitytypeid=13, orders.endtime=1107302399, orders.timestamp=2004-04-29 10:14:05.556495


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

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:

actionstatusdesc=OrderTest Locked In Processing., actiontypedesc=Addition of Mail Forward OrderTest for domainname.com for 1 years, customercost=0.61, eaqid=220753, entityid=7394, description=domainname.com, actiontype=AddMailForward, orderid=7394, invoiceid=-2147483648, status=success, actionstatus=InvoicePaid


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 mailforward service for the specified domain name(s)

Parameters:
domainHash - This should contain the domain name(s) for which mail forwarding service to be renewed. In domainHash one has to send HashMap containing Inside one more HashMap.

It contains following info.

{ domain name -> No of years } e.g. { directi.com -> noofyears = 1 }

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. The HashMap has the domainnames as the key, and an inner HashMap as the value.

The inner HashMap will have key-values as follows:

actionstatusdesc=Mail Forward Renew completed successfully, actiontypedesc=Renewal of Mail Forward order of timepass123.com for 1 years, eaqid=220762, entityid=152, description=timepass123.com, actiontype=RenewMailForward, status=Success, actionstatus=Success

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.


addForward

@Deprecated
public java.util.HashMap addForward(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 prefix,
                                               java.lang.String forwardTo)
Deprecated. 

Adds MailForward Service for an existing order

Parameters:
entityId - The entityId under which the mail forward service is to be added
prefix - The prefix attached to the mail address
forwardTo - The url to which it is to be forwarded
Returns:
HashMap A HashMap with the result of the addition.

actionstatusdesc=Mail Forward addition completed successfully, actiontypedesc=Addition of Mail Forwards for abc@domainname.com, currentaction=220896, eaqid=220896, entityid=537, description=domainname.com, actiontype=AddForward, status=Success, actionstatus=Success


modForward

@Deprecated
public java.util.HashMap modForward(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 prefix,
                                               java.lang.String forwardTo)
Deprecated. 

Modifies the mailforward service for an existing order

Parameters:
entityId - The entityId under which the forward service is to be modified
prefix - The prefix attached to the mail address
forwardTo - The new url to which it is to be forwarded
Returns:
HashMap A HashMap with the result of the modification.

actionstatusdesc=Mail Forward Modification completed successfully, actiontypedesc=Modification of Mail Forwards for abc@domainname.com, currentaction=220914, eaqid=220914, entityid=537, description=domainname.com, actiontype=ModForward, status=Success, actionstatus=Success


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,
                                        boolean status,
                                        java.lang.String defaultForward)
Deprecated. 

Sets the default mailforward service for an existing order

Parameters:
entityId - The entityId under which the default forward is to be set
status - A Boolean value indicating whethere to bounce all other email except the forwards explicitly created
defaultForward - Email address(es) and domain name(s), separated by commas. Applicable only when the value of status if false
Returns:
HashMap A HashMap with the result of the modification.

{actionstatusdesc=Mail Forward Manage completed successfully, actiontypedesc=Manage of Default Forwards for domainname.com, currentaction=221189, eaqid=221189, entityid=537, description=domainname.com, actiontype=ManageForward, status=Success, actionstatus=Success}


delForward

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

Deletes the forward url for an existing order

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

{actionstatusdesc=Mail Forward Deletion completed successfully, actiontypedesc=Deletion of Mail Forwards for pppre@ppp.con, currentaction=221190, eaqid=221190, entityid=537, description=ppp.con, actiontype=DelForward, status=Success, actionstatus=Success}


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. 

Attempts to delete the Mail Forward Service for the specified domain

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

actionstatusdesc=Mail Forward OrderTest Deletion completed successfully, actiontypedesc=Deletion of Mail Forwards OrderTest for jungleland.com, currentaction=221207, eaqid=221207, entityid=562, description=jungleland.com, actiontype=DeleteService, status=Success, actionstatus=Success


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. 

Returns details for a particular Mail Forward Order.

Parameters:
orderId - The Orderid for which the details are required.
option - Vector of different option for details listing. Allowed Option values are All, ConflictDetails, PricingDetails, OrderDetails, StatusDetails, OrderDetails, ExecutionInfoParams
Returns:
HashMap - key/value pair for all fields depending upon the option
Throws:
LogicBoxesException

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. 

Returns the complete details of a particular mailforward order from domainname.

Parameters:
domainName - The domainName for which details are required
option - The various details that are required for the order. Valid entries are:

All, ConflictDetails, PricingDetails, OrderDetails, StatusDetails, OrderDetails, ExecutionInfoParams

All

Returns:
Hashtable with name-value pairs for all the details of the order
Throws:
LogicBoxesException - if option value is null or Invalid SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

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. 

Returns the orderid of a mailforward order from domainname.

Parameters:
domainName - The domainName for which details are required
productkey - Productkey i.e. domcno, domorg, dotin etc
Returns:
int orderid of the domain name
Throws:
LogicBoxesException - if option value is null or Invalid SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

activateMailForwardService

public java.util.HashMap activateMailForwardService(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)
Activates Free Mail Forward Service for the given orderid.

Parameters:
orderId - orderid for which service needs to be activated. return returnHash hashtable with the success mesaage
Throws:
LogicBoxesException