com.softlayer.api.service.product.pkg.order.Configuration

@ApiType("SoftLayer_Product_Package_Order_Configuration")
public class Configuration
extends Entity

This datatype describes the item categories that are required for each package to be ordered. For instance, for package 2, there will be many required categories. When submitting an order for a server, there must be at most 1 price for each category whose "isRequired" is set. Examples of required categories: - server - ram - bandwidth - disk0

There are others, but these are the main ones. For each required category, a SoftLayer_Product_Item_Price must be chosen that is valid for the package.

See Also:: SoftLayer_Product_Package_Order_Configuration

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class Configuration.Mask

Field Summary

Fields
Modifier and Type	Field	Description
`protected Boolean`	`bundledFlag`	Signifies that selections associated with the configuration are automatically provided by being bundled to another configurations selection.
`protected boolean`	`bundledFlagSpecified`
`protected Package`	`configurationPackage`	The package to which this instance belongs.
`protected String`	`errorMessage`	The error message displayed if the submitted order does not contain this item category, if it is required.
`protected boolean`	`errorMessageSpecified`
`protected Long`	`id`	The unique identifier for this object.
`protected boolean`	`idSpecified`
`protected Long`	`isRequired`	This is a flag which tells SoftLayer_Product_Order::verifyOrder() whether or not this category is required.
`protected boolean`	`isRequiredSpecified`
`protected Category`	`itemCategory`	The item category for this configuration instance.
`protected Long`	`itemCategoryId`	The SoftLayer_Product_Item_Category.
`protected boolean`	`itemCategoryIdSpecified`
`protected Long`	`orderStepId`	The order step ID for this particular option in the package.
`protected boolean`	`orderStepIdSpecified`
`protected Long`	`packageId`	The PackageId tied to this instance.
`protected boolean`	`packageIdSpecified`
`protected Long`	`sort`	This is an integer used to show the order in which each item Category should be displayed.
`protected boolean`	`sortSpecified`
`protected Step`	`step`	The step to which this instance belongs.
`protected Boolean`	`termFlag`	Whether or not the item category is term-based.
`protected boolean`	`termFlagSpecified`

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

Configuration()

Method Summary

Modifier and Type	Method	Description
`Boolean`	`getBundledFlag()`
`Package`	`getConfigurationPackage()`
`String`	`getErrorMessage()`
`Long`	`getId()`
`Long`	`getIsRequired()`
`Category`	`getItemCategory()`
`Long`	`getItemCategoryId()`
`Long`	`getOrderStepId()`
`Long`	`getPackageId()`
`Long`	`getSort()`
`Step`	`getStep()`
`Boolean`	`getTermFlag()`
`boolean`	`isBundledFlagSpecified()`
`boolean`	`isErrorMessageSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isIsRequiredSpecified()`
`boolean`	`isItemCategoryIdSpecified()`
`boolean`	`isOrderStepIdSpecified()`
`boolean`	`isPackageIdSpecified()`
`boolean`	`isSortSpecified()`
`boolean`	`isTermFlagSpecified()`
`void`	`setBundledFlag(Boolean bundledFlag)`
`void`	`setConfigurationPackage(Package configurationPackage)`
`void`	`setErrorMessage(String errorMessage)`
`void`	`setId(Long id)`
`void`	`setIsRequired(Long isRequired)`
`void`	`setItemCategory(Category itemCategory)`
`void`	`setItemCategoryId(Long itemCategoryId)`
`void`	`setOrderStepId(Long orderStepId)`
`void`	`setPackageId(Long packageId)`
`void`	`setSort(Long sort)`
`void`	`setStep(Step step)`
`void`	`setTermFlag(Boolean termFlag)`
`void`	`unsetBundledFlag()`
`void`	`unsetErrorMessage()`
`void`	`unsetId()`
`void`	`unsetIsRequired()`
`void`	`unsetItemCategoryId()`
`void`	`unsetOrderStepId()`
`void`	`unsetPackageId()`
`void`	`unsetSort()`
`void`	`unsetTermFlag()`

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- itemCategory
  
  @ApiProperty protected Category itemCategory
  
  The item category for this configuration instance.
- configurationPackage
  
  @ApiProperty("package") protected Package configurationPackage
  
  The package to which this instance belongs.
- step
  
  @ApiProperty protected Step step
  
  The step to which this instance belongs.
- bundledFlag
  
  @ApiProperty(canBeNullOrNotSet=true) protected Boolean bundledFlag
  
  Signifies that selections associated with the configuration are automatically provided by being bundled to another configurations selection. The actual bundling is on the product.
- bundledFlagSpecified
  
  protected boolean bundledFlagSpecified
- errorMessage
  
  @ApiProperty(canBeNullOrNotSet=true) protected String errorMessage
  
  The error message displayed if the submitted order does not contain this item category, if it is required.
- errorMessageSpecified
  
  protected boolean errorMessageSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  The unique identifier for this object.
- idSpecified
  
  protected boolean idSpecified
- isRequired
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long isRequired
  
  This is a flag which tells SoftLayer_Product_Order::verifyOrder() whether or not this category is required. If this is set, then the order submitted must contain a SoftLayer_Product_Item_Price with this category as part of the order.
- isRequiredSpecified
  
  protected boolean isRequiredSpecified
- itemCategoryId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long itemCategoryId
  
  The SoftLayer_Product_Item_Category.
- itemCategoryIdSpecified
  
  protected boolean itemCategoryIdSpecified
- orderStepId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long orderStepId
  
  The order step ID for this particular option in the package.
- orderStepIdSpecified
  
  protected boolean orderStepIdSpecified
- packageId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long packageId
  
  The PackageId tied to this instance.
- packageIdSpecified
  
  protected boolean packageIdSpecified
- sort
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long sort
  
  This is an integer used to show the order in which each item Category should be displayed. This is merely the suggested order.
- sortSpecified
  
  protected boolean sortSpecified
- termFlag
  
  @ApiProperty(canBeNullOrNotSet=true) protected Boolean termFlag
  
  Whether or not the item category is term-based.
- termFlagSpecified
  
  protected boolean termFlagSpecified
Constructor Details
- Configuration
  
  public Configuration()
Method Details
- getItemCategory
  
  public Category getItemCategory()
- setItemCategory
  
  public void setItemCategory(Category itemCategory)
- getConfigurationPackage
  
  public Package getConfigurationPackage()
- setConfigurationPackage
  
  public void setConfigurationPackage(Package configurationPackage)
- getStep
  
  public Step getStep()
- setStep
  
  public void setStep(Step step)
- getBundledFlag
  
  public Boolean getBundledFlag()
- setBundledFlag
  
  public void setBundledFlag(Boolean bundledFlag)
- isBundledFlagSpecified
  
  public boolean isBundledFlagSpecified()
- unsetBundledFlag
  
  public void unsetBundledFlag()
- getErrorMessage
  
  public String getErrorMessage()
- setErrorMessage
  
  public void setErrorMessage(String errorMessage)
- isErrorMessageSpecified
  
  public boolean isErrorMessageSpecified()
- unsetErrorMessage
  
  public void unsetErrorMessage()
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- isIdSpecified
  
  public boolean isIdSpecified()
- unsetId
  
  public void unsetId()
- getIsRequired
  
  public Long getIsRequired()
- setIsRequired
  
  public void setIsRequired(Long isRequired)
- isIsRequiredSpecified
  
  public boolean isIsRequiredSpecified()
- unsetIsRequired
  
  public void unsetIsRequired()
- getItemCategoryId
  
  public Long getItemCategoryId()
- setItemCategoryId
  
  public void setItemCategoryId(Long itemCategoryId)
- isItemCategoryIdSpecified
  
  public boolean isItemCategoryIdSpecified()
- unsetItemCategoryId
  
  public void unsetItemCategoryId()
- getOrderStepId
  
  public Long getOrderStepId()
- setOrderStepId
  
  public void setOrderStepId(Long orderStepId)
- isOrderStepIdSpecified
  
  public boolean isOrderStepIdSpecified()
- unsetOrderStepId
  
  public void unsetOrderStepId()
- getPackageId
  
  public Long getPackageId()
- setPackageId
  
  public void setPackageId(Long packageId)
- isPackageIdSpecified
  
  public boolean isPackageIdSpecified()
- unsetPackageId
  
  public void unsetPackageId()
- getSort
  
  public Long getSort()
- setSort
  
  public void setSort(Long sort)
- isSortSpecified
  
  public boolean isSortSpecified()
- unsetSort
  
  public void unsetSort()
- getTermFlag
  
  public Boolean getTermFlag()
- setTermFlag
  
  public void setTermFlag(Boolean termFlag)
- isTermFlagSpecified
  
  public boolean isTermFlagSpecified()
- unsetTermFlag
  
  public void unsetTermFlag()

Class Configuration

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details