com.logicboxes.foundation.sfnb.order.hosting.web
Class WebHostingOrderData
java.lang.Object
com.logicboxes.foundation.sfnb.order.hosting.web.WebHostingOrderData
public class WebHostingOrderData
- extends java.lang.Object
Method Summary |
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 Web Hosting Order. |
java.util.HashMap |
getHostingMetaData(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID)
This method is used for getting the hosting metadata for a particular reseller
The format of the return hashtable is as follows
hostingMetaDataHash-------------->[mailboxbudgetplanus]--------------->[platform]-----------------[email]
[location]-----------------[us]
[category]-----------------[standard]
[iscustombuildallowed]-----[false] |
java.util.HashMap |
getHostingPlans(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 Web Hosting Plans for a specified reseller. |
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 creationDTRangStart,
java.lang.String creationDTRangEnd,
java.lang.String endTimeRangStart,
java.lang.String endTimeRangEnd,
int numOfRecordPerPage,
int pageNum,
java.lang.String hostingType,
java.lang.String location,
java.lang.String[] orderBy)
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
WebHostingOrderData
public WebHostingOrderData()
getHostingPlans
public java.util.HashMap getHostingPlans(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 Web Hosting Plans for a specified reseller.
- Parameters:
resellerId
- Resellerid / Sub-Resellerid of the caller for who the plans need to be retrieved.productKey
- The product key identifies the type of the Web Hosting Plans.
The current acceptable values for this parameter is
lhbus - Linux Web Hosting in USA
lhbin - Linux Web Hosting in India
w2kus - Windows Web Hosting in USA
w2kin - Windows Web Hosting in India
- Returns:
- HashMap A HashMap returning the details of all the plans for the specified reseller.
The HashMap contains serial numbers for its key and a Details Hash for its value.
An example of the return HashMap is as follows:
retHash -> {
[ssl] -> 5000.00
[excessBandwidthBlockSize] -> 5000
[productkey] -> lhbus
[excessbandwidth] -> 6000.00
[1] -> {
[totalprice] -> 1000.00
[planname] -> Plan A
[packagekey] -> plan1
[lhbus_resellerid] -> resellerid_999999999
[lhbus_webspace] -> webspace_1000
[lhbus_planid] -> planid_5
[lhbus_bandwidth] -> bandwidth_2048
}
[2] -> {
[totalprice] -> 2000.00
[lhbus_noofdbs] -> noofdbs_1
[lhbus_dbspace] -> dbspace_250
[planname] -> Plan B
[packagekey] -> plan2
[lhbus_resellerid] -> resellerid_999999999
[lhbus_webspace] -> webspace_2000
[lhbus_planid] -> planid_6
[lhbus_bandwidth] -> bandwidth_5120
}
[3] -> {
[totalprice] -> 4000.00
[lhbus_noofdbs] -> noofdbs_20
[lhbus_dbspace] -> dbspace_750
[lhbus_ssl] -> ssl
[planname] -> Plan C
[packagekey] -> plan3
[lhbus_resellerid] -> resellerid_999999999
[lhbus_webspace] -> webspace_10000
[lhbus_planid] -> planid_8
[lhbus_bandwidth] -> bandwidth_15360
}
}
- Throws:
LogicBoxesException
getDetails
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)
- Returns details for a particular Web Hosting Order.
- Parameters:
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
- Returns:
- HashMap - key/value pair for all fields depending upon the option
- Throws:
LogicBoxesException
list
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 creationDTRangStart,
java.lang.String creationDTRangEnd,
java.lang.String endTimeRangStart,
java.lang.String endTimeRangEnd,
int numOfRecordPerPage,
int pageNum,
java.lang.String hostingType,
java.lang.String location,
java.lang.String[] orderBy)
- Parameters:
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, Deleteddescription
- 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
endTimeRangEndnumOfRecordPerPage
- No. of Records to be returned. The maximum valoue allowed is 50pageNum
- Page Number for which records are requiredhostingType
- The type of the web hosting orders
Currently accepted values
linux - Linux
w2k - Windows
location
- The Location of the orders
Currently accepted values
budget - indicating USA Budget Hosting
premium - indicating USA Premium HostingorderBy
- 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 order details.
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
- Throws:
LogicBoxesException
getHostingMetaData
public java.util.HashMap getHostingMetaData(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID)
- This method is used for getting the hosting metadata for a particular reseller
The format of the return hashtable is as follows
hostingMetaDataHash-------------->[mailboxbudgetplanus]--------------->[platform]-----------------[email]
[location]-----------------[us]
[category]-----------------[standard]
[iscustombuildallowed]-----[false]
- Returns:
- Returns Product Metadata
- Throws:
LogicBoxesException