All Superinterfaces:: Maskable, ResultLimitable, Service

Enclosing class:: Item

@ApiService("SoftLayer_Billing_Order_Item")
public static interface Item.Service
extends Service

The SoftLayer_Billing_Order_Item datatype provides information regarding a single ordered item. When a server order or any other order is placed, the information about that order is stored as SoftLayer_Billing_Order_items.

This also provides information about software or hardware related to an ordered item,what package the item is in, and all pricing information related to this ordered item.

See Also:: SoftLayer_Billing_Order_Item

Method Summary

Modifier and Type	Method	Description
`Item.ServiceAsync`	`asAsync()`	Get an async version of this service
`Item`	`getBillingItem()`	The SoftLayer_Billing_Item tied to the order item.
`List<Item>`	`getBundledItems()`	The other items included with an ordered item.
`Category`	`getCategory()`	The item category tied to an order item.
`List<Item>`	`getChildren()`	The child order items for an order item.
`String`	`getGlobalIdentifier()`	A hardware's universally unique identifier.
`Generic`	`getHardwareGenericComponent()`	The component type tied to an order item.
`Item`	`getItem()`	The SoftLayer_Product_Item tied to an order item.
`List<Answer>`	`getItemCategoryAnswers()`	This is an item's category answers.
`Package`	`getItemPackage()`	The SoftLayer_Product_Package an order item is a part of.
`Price`	`getItemPrice()`	The SoftLayer_Product_Item_Price tied to an order item.
`Location`	`getLocation()`	The location of an ordered item.
`List<Item>`	`getNextOrderChildren()`
`Item`	`getObject()`	getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service.
`Item`	`getOldBillingItem()`	This is only populated when an upgrade order is placed.
`Order`	`getOrder()`	The order to which this item belongs.
`GregorianCalendar`	`getOrderApprovalDate()`
`Item`	`getParent()`	The parent order item ID for an item.
`Preset`	`getPreset()`	The SoftLayer_Product_Package_Preset related to this order item.
`Promotion`	`getPromoCode()`
`Long`	`getRedundantPowerSupplyCount()`	A count of power supplies contained within this SoftLayer_Billing_Order
`Description`	`getSoftwareDescription()`	For ordered items that are software items, a full description of that software can be found with this property.
`List<Order>`	`getStorageGroups()`	The drive storage groups that are attached to this billing order item.
`BigDecimal`	`getTotalRecurringAmount()`	The recurring fee of an ordered item.
`Item`	`getUpgradeItem()`	The next SoftLayer_Product_Item in the upgrade path for this order item.
`void`	`setMask(Item.Mask mask)`
`Item.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Item.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details
- asAsync
  
  Item.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Item.Mask withNewMask()
  
  Description copied from interface: Maskable
  
  Overwrite the existing mask on this service with a new one and return it
  
  Specified by:
  
  withNewMask in interface Maskable
- withMask
  
  Item.Mask withMask()
  
  Description copied from interface: Maskable
  
  Use the existing mask on this service or create it if not present
  
  Specified by:
  
  withMask in interface Maskable
- setMask
  
  void setMask(Item.Mask mask)
- getObject
  
  @ApiMethod(instanceRequired=true) Item getObject()
  
  getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are "parent" billing items and "child" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered "child" billing items.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getObject
- getBillingItem
  
  @ApiMethod(instanceRequired=true) Item getBillingItem()
  
  The SoftLayer_Billing_Item tied to the order item.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getBillingItem
- getBundledItems
  
  @ApiMethod(instanceRequired=true) List<Item> getBundledItems()
  
  The other items included with an ordered item.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getBundledItems
- getCategory
  
  @ApiMethod(instanceRequired=true) Category getCategory()
  
  The item category tied to an order item.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getCategory
- getChildren
  
  @ApiMethod(instanceRequired=true) List<Item> getChildren()
  
  The child order items for an order item. All server order items should have children. These children are considered a part of the server.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getChildren
- getGlobalIdentifier
  
  @ApiMethod(instanceRequired=true) String getGlobalIdentifier()
  
  A hardware's universally unique identifier.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getGlobalIdentifier
- getHardwareGenericComponent
  
  @ApiMethod(instanceRequired=true) Generic getHardwareGenericComponent()
  
  The component type tied to an order item. All hardware-specific items should have a generic hardware component.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getHardwareGenericComponent
- getItem
  
  @ApiMethod(instanceRequired=true) Item getItem()
  
  The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getItem
- getItemCategoryAnswers
  
  @ApiMethod(instanceRequired=true) List<Answer> getItemCategoryAnswers()
  
  This is an item's category answers.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getItemCategoryAnswers
- getItemPrice
  
  @ApiMethod(instanceRequired=true) Price getItemPrice()
  
  The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getItemPrice
- getLocation
  
  @ApiMethod(instanceRequired=true) Location getLocation()
  
  The location of an ordered item. This is usually the same as the server it is being ordered with. Otherwise it describes the location of the additional service being ordered.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getLocation
- getNextOrderChildren
  
  @ApiMethod(instanceRequired=true) List<Item> getNextOrderChildren()
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getNextOrderChildren
- getOldBillingItem
  
  @ApiMethod(instanceRequired=true) Item getOldBillingItem()
  
  This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getOldBillingItem
- getOrder
  
  @ApiMethod(instanceRequired=true) Order getOrder()
  
  The order to which this item belongs. The order contains all the information related to the items included in an order
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getOrder
- getOrderApprovalDate
  
  @ApiMethod(instanceRequired=true) GregorianCalendar getOrderApprovalDate()
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getOrderApprovalDate
- getItemPackage
  
  @ApiMethod(instanceRequired=true) Package getItemPackage()
  
  The SoftLayer_Product_Package an order item is a part of.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getItemPackage
- getParent
  
  @ApiMethod(instanceRequired=true) Item getParent()
  
  The parent order item ID for an item. Items that are associated with a server will have a parent. The parent will be the server item itself.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getParent
- getPreset
  
  @ApiMethod(instanceRequired=true) Preset getPreset()
  
  The SoftLayer_Product_Package_Preset related to this order item.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getPreset
- getPromoCode
  
  @ApiMethod(instanceRequired=true) Promotion getPromoCode()
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getPromoCode
- getRedundantPowerSupplyCount
  
  @ApiMethod(instanceRequired=true) Long getRedundantPowerSupplyCount()
  
  A count of power supplies contained within this SoftLayer_Billing_Order
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getRedundantPowerSupplyCount
- getSoftwareDescription
  
  @ApiMethod(instanceRequired=true) Description getSoftwareDescription()
  
  For ordered items that are software items, a full description of that software can be found with this property.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getSoftwareDescription
- getStorageGroups
  
  @ApiMethod(instanceRequired=true) List<Order> getStorageGroups()
  
  The drive storage groups that are attached to this billing order item.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getStorageGroups
- getTotalRecurringAmount
  
  @ApiMethod(instanceRequired=true) BigDecimal getTotalRecurringAmount()
  
  The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getTotalRecurringAmount
- getUpgradeItem
  
  @ApiMethod(instanceRequired=true) Item getUpgradeItem()
  
  The next SoftLayer_Product_Item in the upgrade path for this order item.
  
  See Also:
  
  SoftLayer_Billing_Order_Item::getUpgradeItem

Interface Item.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details