OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.Item
Implementsosid.OsidRelationship
Description

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.

MethodgetOrderId
Description

Gets the order Id for this item.

Returnosid.id.Idthe order Id
CompliancemandatoryThis method must be implemented.
MethodgetOrder
Description

Gets the order for this item.

Returnosid.ordering.Orderthe order
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodisDerived
Description

Tests if the item is a derived item as opposed to one that has been explicitly selected.

Returnboolean true if this item is derived, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProductId
Description

Gets the product Id for this item.

Returnosid.id.Idthe product Id
CompliancemandatoryThis method must be implemented.
MethodgetProduct
Description

Gets the product for this item.

Returnosid.ordering.Productthe product
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetUnitPriceIds
Description

Gets the price Ids for this item.

Returnosid.id.IdListthe price Ids
CompliancemandatoryThis method must be implemented.
MethodgetUnitPrices
Description

Gets the prices for this item. There may be different price types for a single item.

Returnosid.ordering.PriceListthe prices
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetQuantity
Description

Gets the quantity of the product.

Returncardinalthe quantity of the product
CompliancemandatoryThis method must be implemented.
MethodgetCosts
Description

Gets the line item costs.

Returnosid.ordering.CostListthe costs.
CompliancemandatoryThis method must be implemented.
MethodgetItemRecord
Description

Gets the item record corresponding to the given 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 .

Parametersosid.type.TypeitemRecordTypethe type of item record to retrieve
Returnosid.ordering.records.ItemRecordthe item record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.