|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.logicboxes.foundation.sfnb.order.hosting.email.MailHostingOrder
public class MailHostingOrder
Constructor Summary | |
---|---|
MailHostingOrder()
|
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.lang.String packageKey,
java.lang.String invoiceOption)
Places a Email Hosting 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 Email Hosting 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 Email Hosting 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 |
getMailboxPlans(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
int resellerId,
java.lang.String productKey)
Returns plan details of all the Email Hosting Plans for a specified reseller. |
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,
int noOfMonths,
java.lang.String packagekey,
int excessBandwidth)
Deprecated. |
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,
int excessBandwidth)
Performs and Data Validation of the add Order params and returns the monthly and prorated cost of the order |
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 |
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 creationDTRangStart,
java.lang.String creationDTRangEnd,
java.lang.String endTimeRangStart,
java.lang.String endTimeRangEnd,
java.lang.String location,
int numOfRecordPerPage,
int pageNum,
java.lang.String[] orderBy)
Returns list of orders matching the search criteria |
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.lang.String packagekey,
int additionalMailBoxes)
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,
int orderId,
int renewMonths)
Renews an existing Mail Hosting Order. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MailHostingOrder()
Method Detail |
---|
public java.util.HashMap getMailboxPlans(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int resellerId, java.lang.String productKey)
resellerId
- Resellerid / Sub-Resellerid of the caller for who the plans need to be retrieved.productKey
- The product key identifies the type of the Email Hosting Plans.LogicBoxesException
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 creationDTRangStart, java.lang.String creationDTRangEnd, java.lang.String endTimeRangStart, java.lang.String endTimeRangEnd, java.lang.String location, int numOfRecordPerPage, int pageNum, java.lang.String[] orderBy)
orderId
- Array of OrderIds for listing Specific OrdersresellerId
- 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 orderscurrentStatus
- Array for listing Orders having specific Current Status
Valid values are: InActive, Active, Suspended, DeleteddomainName
- Domain name for listing OrderscreationDTRangStart
- UNIX TimeStamp (epoch) for listing Orders created after
creationDTRangStartcreationDTRangEnd
- UNIX TimeStamp (epoch) for listing Orders created before
creationDTRangEndendTimeRangStart
- UNIX TimeStamp (epoch) for listing Orders ending after
endTimeRangStartendTimeRangEnd
- UNIX TimeStamp (epoch) for listing Orders ending before
endTimeRangEndlocation
- The Location of the orders
Currently accepted values
budget - indicating USA Budget Hosting
premium - indicating USA Premium HostingnumOfRecordPerPage
- No. of Records to be returned. The maximum valoue allowed is 50pageNum
- Page Number for which records are requiredorderBy
- Array of Field names for sorting Listing of Orders.
Default sorting is by orderId.
LogicBoxesException
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, int excessBandwidth)
productkey
- The product key identifies the type of the Email Hosting Order.packagekey
- packageKey will be the identifier key of the plan for which the order needs to be added.excessBandwidth
- is the Bandwith which the user wants over and above the bandwidth of the order's current plan.
ValidationException
LogicBoxesException
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.lang.String packageKey, java.lang.String invoiceOption)
productkey
- The product key identifies the type of the Email Hosting Order.
The current acceptable values 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.
The minimum period for which the order can be added is 6 months.packageKey
- packageKey for which Order is placed e.g. plan1.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.
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 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 occur@Deprecated 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, int noOfMonths, java.lang.String packagekey, int excessBandwidth)
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.packagekey
- Identifier key of the plan for which the order needs to be added.excessBandwidth
- is the Bandwith which the user wants over and above the bandwidth of the order's current plan.
LogicBoxesException
@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 orderId, int noOfMonths, java.lang.String packagekey, int additionalMailBoxes)
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.packagekey
- Is the identifier key of the plan to which the order needs to upgraded or downgraded to.additionalMailBoxes
- Is the identifier key of the plan to which the order needs to upgraded or downgraded to.
additionalMailBoxes is the number of addional mail boxes over and above the existing ones in blocks of 100 accounts modifications.
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.
LogicBoxesException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |