|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.logicboxes.foundation.sfnb.order.sitebuilder.SiteBuilder
public class SiteBuilder
Constructor Summary | |
---|---|
SiteBuilder()
|
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.lang.String productkey,
java.lang.String domainName,
int customerId,
int noOfMonths,
java.util.HashMap orderParams,
java.lang.String invoiceOption)
Places a Sitebuilder Lite order for the specified domain name. |
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)
Deletes order referenced by passed orderID |
java.util.HashMap |
getAllPackDetails(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID)
Return various costs and parameters associated with every pack |
java.util.HashMap |
getDeletionRefundAmount(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)
Returns the refund details on deleting a specified order. |
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)
Returns details for a particular SiteBuilder Order. |
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)
Returns the complete details of a particular order from domainname. |
java.util.HashMap |
getMonthlyCostAndValidate(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 productkey,
java.lang.String packageKey)
Method returns prorata, setup and monthly cost for a pack |
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)
Returns the orderid of a particular order from domainname. |
java.util.HashMap |
modOrderFTPDetails(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 ftphost,
java.lang.String ftpport,
java.lang.String ftpusername,
java.lang.String ftppassword,
java.lang.String ftppath)
|
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,
int orderId,
int renewMonths)
Renews an existing Sitebuilder order. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SiteBuilder()
Method Detail |
---|
public java.util.HashMap getMonthlyCostAndValidate(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 productkey, java.lang.String packageKey)
productkey
- Productkey, valid values are sblite and sbpropackageKey
- : Identifier key of the plan for which the order needs to be added
LogicBoxesException
- If productkey or pack is not validpublic 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.lang.String productkey, java.lang.String domainName, int customerId, int noOfMonths, java.util.HashMap orderParams, java.lang.String invoiceOption)
productkey
- The product key identifies the type of the Sitebuilder Order.
The current acceptable values for this parameter is sblitedomainName
- The domain name for which the order is placed.customerId
- The customer under whom the orders should be added.noOfMonths
- The number of months for which the order is placed.
The minimum period for which the order can be added is 6 months.orderParams
- For adding a pre-defined package, the orderParams Hashtable should contain a "packid" key
having the PlanId (PackageId) as its value.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.
The HashMap will have key-values as follows:
entityid=434 (orderid) description=apitest04.info status=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.LogicBoxesException
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, int orderId, int renewMonths)
orderId
- The OrderId which is to be renewed.renewMonths
- The no of months for which the order is to be renewed
LogicBoxesException
public java.util.HashMap getDeletionRefundAmount(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)
orderId
- The OrderId for which the Refund details are required.
childtype - Could be customer or reseller. If the order being deleted belongs to a direct customer, the childtype would be customer If the order being deleted belongs to a sub reseller, the childtype would be reseller
childcompany - The company of the customer / sub reseller
childname - Name of the customer / sub reseller
childrefund - The amount that will be refunded to the customer / sub reseller
userrefund - The amount that will be refunded to the reseller
LogicBoxesException
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)
entityId
- order identifier which has to be deleted
LogicBoxesException
- if order does not belong to reseller who has invoked this methodpublic 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)
orderId
- The Orderid for which the details are required.option
- Vector of different option for details listing. Allowed Option values are
All, StatusDetails, PricingDetails, ExecutionInfoParams, OrderDetails
LogicBoxesException
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)
domainName
- The domainName for which details are requiredoption
- The various details that are required for the order.
Valid entries are:
OrderDetails
StatusDetails
ContactIds
RegistrantContactDetails
AdminContactDetails
TechContactDetails
BillingContactDetails
NsDetails
DomainStatus
PricingDetails
All
LogicBoxesException
- if option value is null or Invalid
SqlException if any Database related Exception occurs
LogicBoxesException if any internal errors occurpublic 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)
domainName
- The domainName for which details are requiredproductkey
- Productkey i.e. domcno, domorg, dotin etc
LogicBoxesException
- if option value is null or Invalid
SqlException if any Database related Exception occurs
LogicBoxesException if any internal errors occurpublic java.util.HashMap getAllPackDetails(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID)
LogicBoxesException
-
Example Usuage
HashMap details = SiteBuilderLite.getAllPackDetails();
for( int count = 1; count <= details.size(); count++ )
{
HashMap packDetails = (HashMap)details.get( "" + count )
String monthlycost = (String)packDetails.get( "monthlycost" );
...
}
public java.util.HashMap modOrderFTPDetails(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 ftphost, java.lang.String ftpport, java.lang.String ftpusername, java.lang.String ftppassword, java.lang.String ftppath)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |