java.lang.Object
- com.softlayer.api.Type
- - com.softlayer.api.service.Entity
  - - com.softlayer.api.service.product.item.Rule

```
@ApiType("SoftLayer_Product_Item_Rule")
public class Rule
extends Entity
```
The item rule data type represents a rule that must be followed when the item assigned to the rule is ordered. The type and operation applied to the resources of the rule will affect how the rule is checked during ordering.

See Also:

SoftLayer_Product_Item_Rule

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Rule.Mask

Field Summary

Fields
Modifier and Type	Field	Description
`protected Item`	`item`	The product item that a rule applies to.
`protected Long`	`itemCategoryResourceCount`	A count of
`protected List<Category>`	`itemCategoryResources`
`protected Long`	`itemId`	The unique identifier of the item that the rule applies to.
`protected boolean`	`itemIdSpecified`
`protected Long`	`itemResourceCount`	A count of
`protected List<Item>`	`itemResources`
`protected Long`	`locationResourceCount`	A count of
`protected List<Location>`	`locationResources`
`protected String`	`message`	An optional message shown for when the rule is found to be invalid when ordering.
`protected boolean`	`messageSpecified`
`protected String`	`operation`
`protected boolean`	`operationSpecified`
`protected Long`	`packageId`	The unique identifier of the service offering that is associated with the rule.
`protected boolean`	`packageIdSpecified`
`protected Long`	`permissionResourceCount`	A count of
`protected List<Permission>`	`permissionResources`
`protected Long`	`resourceCount`	A count of resources for this rule that are validated when ordering.
`protected List<Resource>`	`resources`	Resources for this rule that are validated when ordering.
`protected Package`	`rulePackage`	The package that a rule is applicable to when ordering.
`protected Type`	`type`	The type a rule is.
`protected Long`	`typeId`	The unique identifier of the type of resource rule.
`protected boolean`	`typeIdSpecified`

Fields inherited from class com.softlayer.api.Type
unknownProperties

Constructor Summary

Constructors
Constructor Description

Rule()

Method Summary

Modifier and Type	Method	Description
`Item`	`getItem()`
`Long`	`getItemCategoryResourceCount()`
`List<Category>`	`getItemCategoryResources()`
`Long`	`getItemId()`
`Long`	`getItemResourceCount()`
`List<Item>`	`getItemResources()`
`Long`	`getLocationResourceCount()`
`List<Location>`	`getLocationResources()`
`String`	`getMessage()`
`String`	`getOperation()`
`Long`	`getPackageId()`
`Long`	`getPermissionResourceCount()`
`List<Permission>`	`getPermissionResources()`
`Long`	`getResourceCount()`
`List<Resource>`	`getResources()`
`Package`	`getRulePackage()`
`Type`	`getType()`
`Long`	`getTypeId()`
`boolean`	`isItemIdSpecified()`
`boolean`	`isMessageSpecified()`
`boolean`	`isOperationSpecified()`
`boolean`	`isPackageIdSpecified()`
`boolean`	`isTypeIdSpecified()`
`void`	`setItem(Item item)`
`void`	`setItemCategoryResourceCount(Long itemCategoryResourceCount)`
`void`	`setItemId(Long itemId)`
`void`	`setItemResourceCount(Long itemResourceCount)`
`void`	`setLocationResourceCount(Long locationResourceCount)`
`void`	`setMessage(String message)`
`void`	`setOperation(String operation)`
`void`	`setPackageId(Long packageId)`
`void`	`setPermissionResourceCount(Long permissionResourceCount)`
`void`	`setResourceCount(Long resourceCount)`
`void`	`setRulePackage(Package rulePackage)`
`void`	`setType(Type type)`
`void`	`setTypeId(Long typeId)`
`void`	`unsetItemId()`
`void`	`unsetMessage()`
`void`	`unsetOperation()`
`void`	`unsetPackageId()`
`void`	`unsetTypeId()`

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 Detail

item
```
@ApiProperty
protected Item item
```
The product item that a rule applies to.

itemCategoryResources

@ApiProperty
protected List<Category> itemCategoryResources

itemResources

@ApiProperty
protected List<Item> itemResources

locationResources

@ApiProperty
protected List<Location> locationResources

rulePackage
```
@ApiProperty("package")
protected Package rulePackage
```
The package that a rule is applicable to when ordering. If no package exists, the rule applies to any package.

permissionResources

@ApiProperty
protected List<Permission> permissionResources

resources
```
@ApiProperty
protected List<Resource> resources
```
Resources for this rule that are validated when ordering.

type
```
@ApiProperty
protected Type type
```
The type a rule is. The type affects how the rule is validated when ordering.

itemId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long itemId
```
The unique identifier of the item that the rule applies to.

itemIdSpecified
```
protected boolean itemIdSpecified
```

message
```
@ApiProperty(canBeNullOrNotSet=true)
protected String message
```
An optional message shown for when the rule is found to be invalid when ordering.

messageSpecified
```
protected boolean messageSpecified
```

operation

@ApiProperty(canBeNullOrNotSet=true)
protected String operation

operationSpecified
```
protected boolean operationSpecified
```

packageId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long packageId
```
The unique identifier of the service offering that is associated with the rule.

packageIdSpecified
```
protected boolean packageIdSpecified
```

typeId

@ApiProperty(canBeNullOrNotSet=true)
protected Long typeId

The unique identifier of the type of resource rule.

typeIdSpecified
```
protected boolean typeIdSpecified
```

itemCategoryResourceCount

@ApiProperty
protected Long itemCategoryResourceCount

A count of

itemResourceCount

@ApiProperty
protected Long itemResourceCount

A count of

locationResourceCount

@ApiProperty
protected Long locationResourceCount

A count of

permissionResourceCount

@ApiProperty
protected Long permissionResourceCount

A count of

resourceCount
```
@ApiProperty
protected Long resourceCount
```
A count of resources for this rule that are validated when ordering.

Constructor Detail
- Rule
```
public Rule()
```

Method Detail

getItem
```
public Item getItem()
```

setItem
```
public void setItem(Item item)
```

getItemCategoryResources

public List<Category> getItemCategoryResources()

getItemResources
```
public List<Item> getItemResources()
```

getLocationResources

public List<Location> getLocationResources()

getRulePackage
```
public Package getRulePackage()
```

setRulePackage

public void setRulePackage(Package rulePackage)

getPermissionResources

public List<Permission> getPermissionResources()

getResources
```
public List<Resource> getResources()
```

getType
```
public Type getType()
```

setType
```
public void setType(Type type)
```

getItemId
```
public Long getItemId()
```

setItemId

public void setItemId(Long itemId)

isItemIdSpecified
```
public boolean isItemIdSpecified()
```

unsetItemId
```
public void unsetItemId()
```

getMessage
```
public String getMessage()
```

setMessage

public void setMessage(String message)

isMessageSpecified
```
public boolean isMessageSpecified()
```

unsetMessage
```
public void unsetMessage()
```

getOperation
```
public String getOperation()
```

setOperation

public void setOperation(String operation)

isOperationSpecified
```
public boolean isOperationSpecified()
```

unsetOperation
```
public void unsetOperation()
```

getPackageId
```
public Long getPackageId()
```

setPackageId

public void setPackageId(Long packageId)

isPackageIdSpecified
```
public boolean isPackageIdSpecified()
```

unsetPackageId
```
public void unsetPackageId()
```

getTypeId
```
public Long getTypeId()
```

setTypeId

public void setTypeId(Long typeId)

isTypeIdSpecified
```
public boolean isTypeIdSpecified()
```

unsetTypeId
```
public void unsetTypeId()
```

getItemCategoryResourceCount

public Long getItemCategoryResourceCount()

setItemCategoryResourceCount

public void setItemCategoryResourceCount(Long itemCategoryResourceCount)

getItemResourceCount
```
public Long getItemResourceCount()
```

setItemResourceCount

public void setItemResourceCount(Long itemResourceCount)

getLocationResourceCount

public Long getLocationResourceCount()

setLocationResourceCount

public void setLocationResourceCount(Long locationResourceCount)

getPermissionResourceCount

public Long getPermissionResourceCount()

setPermissionResourceCount

public void setPermissionResourceCount(Long permissionResourceCount)

getResourceCount
```
public Long getResourceCount()
```

setResourceCount

public void setResourceCount(Long resourceCount)

Class Rule

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 Detail

item

itemCategoryResources

itemResources

locationResources

rulePackage

permissionResources

resources

type

itemId

itemIdSpecified

message

messageSpecified

operation

operationSpecified

packageId

packageIdSpecified

typeId

typeIdSpecified

itemCategoryResourceCount

itemResourceCount

locationResourceCount

permissionResourceCount

resourceCount

Constructor Detail

Rule

Method Detail

getItem

setItem

getItemCategoryResources

getItemResources

getLocationResources

getRulePackage

setRulePackage

getPermissionResources

getResources

getType

setType

getItemId

setItemId

isItemIdSpecified

unsetItemId

getMessage

setMessage

isMessageSpecified

unsetMessage

getOperation

setOperation

isOperationSpecified

unsetOperation

getPackageId

setPackageId

isPackageIdSpecified

unsetPackageId

getTypeId

setTypeId

isTypeIdSpecified

unsetTypeId

getItemCategoryResourceCount

setItemCategoryResourceCount

getItemResourceCount

setItemResourceCount

getLocationResourceCount

setLocationResourceCount

getPermissionResourceCount

setPermissionResourceCount

getResourceCount

setResourceCount