OSID - osid.ordering.OrderItem Service Interface Definition

Interface	osid.ordering.OrderItem
Implements	`osid.OsidRelationship`
Used By	`osid.ordering.OrderItemAdminSession`
	`osid.ordering.OrderItemList`
	`osid.ordering.OrderItemLookupSession`
Description	A `OrderItem` represents a collection of orders. Like all OSID objects, a `OrderItem` is identified by its `Id` and any persisted references should use the `Id`. An `OrderItem` 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. Like all `OsidObjects`, `OrderItem` is managed by its `OsidSessions` and may not be accessed by concurrent processing threads.
Method	getOrderId
Description	Gets the order `Id` for this order item.
Return	`osid.id.Id`		the order `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getOrder
Description	Gets the order for this order item.
Return	`osid.ordering.Order`		the order
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isDerived
Description	Tests if the order item is a derived order item as opposed to one that has been explicitly selected.
Return	`boolean`		`true` if this order item is derived, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProductId
Description	Gets the product `Id` for this order item.
Return	`osid.id.Id`		the product `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getProduct
Description	Gets the product for this order item.
Return	`osid.ordering.Product`		the product
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getUnitPriceIds
Description	Gets the price `Ids` for this order item.
Return	`osid.id.IdList`		the price `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getUnitPrices
Description	Gets the prices for this order item. There may be different price types for a single order item.
Return	`osid.ordering.PriceList`		the prices
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getQuantity
Description	Gets the quantity of the product.
Return	`cardinal`		the quantity of the product
Compliance	`mandatory`		This method must be implemented.
Method	getCosts
Description	Gets the line item costs.
Return	`osid.ordering.CostList`		the costs.
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemRecord
Description	Gets the order item record corresponding to the given `OrderItem` record `Type`.This method is used to retrieve an object implementing the requested record. The `orderItemRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(itemRecordType)` is `true`.
Parameters	`osid.type.Type`	`orderItemRecordType`	the type of order item record to retrieve
Return	`osid.ordering.records.OrderItemRecord`		the order item record
Errors	NULL_ARGUMENT		`orderItemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(itemRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.