|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.logicboxes.foundation.sfnb.order.instahelp.EngageOrder
public class EngageOrder
Constructor Summary | |
---|---|
EngageOrder()
|
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 LiveHelp 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 the LiveHelp service for a specified Order |
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 Engage 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)
Gets the Details of the specified order based on given option(s) |
java.util.HashMap |
getModPricing(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.lang.String packagekey,
int noofmonths)
This method is used to determine the cost of Order Modification, if a particular order param is not modified the existing pricing param needs to be passed. |
java.util.HashMap |
getMonthlyCostAndValidate(java.lang.String userName,
java.lang.String password,
java.lang.String role,
java.lang.String langpref,
int parentid,
java.lang.String packagekey)
|
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)
Gets the OrderId of given domainname |
java.util.HashMap |
getPlanDetails(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID)
Returns all the plan details of LogicBoxes Engage. |
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 orderId,
int noOfMonths,
java.util.HashMap orderParams)
Modifies an existing LiveHelp Order based to the parameters desired. |
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,
java.lang.String invoiceOption,
java.lang.String existingEndTime)
Renews an existing LiveHelp Order. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EngageOrder()
Method Detail |
---|
public java.util.HashMap getMonthlyCostAndValidate(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, java.lang.String packagekey)
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.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 LiveHelp Order.
The current acceptable value for this parameter isdomainName
- 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.orderParams
- It is a HashMap and should contain the predefined pack for which the order needs to be added.
It should have the engage_pack as the key and value must be either of
pack1, pack2, pack3, pack4.
ex. {engage_pack=pack3}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 order.
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 order
will be added.
KeepInvoice -If this value is passed, then a customer invoice will be generated
for the order. However, this invoice will not be paid.
It 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.
LogicBoxesException
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 orderId, int noOfMonths, java.util.HashMap orderParams)
orderId
- The orderid of the Order which is to be modified.noOfMonths
- The no of months for which the order is to be renewed, pass 0 if you do not wish to extend the
duration of the order.orderParams
- The orderParams HashMap should contain Pricing Keys and the desired Pricing Parameters
Existing order pricing parameters need to passed for the pricing keys that require no modifications.
It should have the engage_pack as the key and value must be either of
pack1, pack2, pack3, pack4.
ex. {engage_pack=pack3}
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, java.lang.String invoiceOption, java.lang.String existingEndTime)
orderId
- The OrderId which is to be renewed.renewMonths
- The no of months for which the order is to be renewed.existingEndTime
- The current end time for this order in millisecondsinvoiceOption
- This parameter will decide how the Customer Invoices will be handled. 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.
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
- The Orderid for which the service needs 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 getModPricing(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.lang.String packagekey, int noofmonths)
orderId
- The OrderId which is to be modified.noofmonths
- The no of months for which the order is to be renewed, pass 0 if you do not wish to extend the
duration of the order.
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 under which the details are to be listedoption
- Vector for listing Orders with various options
* 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)
domainName
- The domainname for which the orderid is to be listed
public java.util.HashMap getPlanDetails(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID)
LogicBoxesException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |