public interface Item extends OsidRelationship
A Item
represents a collection of orders. Like all OSID
objects, a Item
is identified by its Id
and
any persisted references should use the Id.
An Item
may have multiple unit prices
for different types of currencies, such as one for payment and one for
credits. Each line item cost type should be lined up with the unit price
type.
Modifier and Type | Method and Description |
---|---|
CostList |
getCosts()
Gets the line item costs.
|
ItemRecord |
getItemRecord(Type itemRecordType)
Gets the item record corresponding to the given
Item
record Type. |
Order |
getOrder()
Gets the order for this item.
|
Id |
getOrderId()
Gets the order
Id for this item. |
Product |
getProduct()
Gets the product for this item.
|
Id |
getProductId()
Gets the product
Id for this item. |
long |
getQuantity()
Gets the quantity of the product.
|
IdList |
getUnitPriceIds()
Gets the price
Ids for this item. |
PriceList |
getUnitPrices()
Gets the prices for this item.
|
boolean |
isDerived()
Tests if the item is a derived item as opposed to one that has been
explicitly selected.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getOrderId()
Id
for this item. Id
mandatory
- This method must be implemented. Order getOrder() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isDerived()
true
if this item is derived, false
otherwisemandatory
- This method must be implemented. Id getProductId()
Id
for this item. Id
mandatory
- This method must be implemented. Product getProduct() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getUnitPriceIds()
Ids
for this item. Ids
mandatory
- This method must be implemented. PriceList getUnitPrices() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. long getQuantity()
mandatory
- This method must be implemented. CostList getCosts()
mandatory
- This method must be implemented. ItemRecord getItemRecord(Type itemRecordType) throws OperationFailedException
Item
record Type.
This method is used to retrieve an object
implementing the requested record. The itemRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a Type
hierarchy where
hasRecordType(itemRecordType)
is true
.itemRecordType
- the type of item record to retrieveNullArgumentException
- itemRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(itemRecordType)
is false
mandatory
- This method must be implemented.