OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.Product
Implementsosid.OsidObject
Used Byosid.billing.Item
osid.ordering.Item
osid.ordering.ProductAdminSession
osid.ordering.ProductList
osid.ordering.ProductLookupSession
Description

A Product represents something ordered.

MethodgetCode
Description

Gets the product code.

Returnstring a product code
Compliancemandatory This method must be implemented.
MethodgetPriceScheduleIds
Description

Gets the price schedule Ids.

Returnosid.id.IdList a price schedule Id
Compliancemandatory This method must be implemented.
MethodgetPriceSchedules
Description

Gets the price schedules.

Returnosid.ordering.PriceScheduleList the price schedules
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodhasAvailability
Description

Tests if an availability is available for this product.

Returnboolean true if an available is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetAvailability
Description

Gets the availability.

Returncardinal the availability
ErrorsILLEGAL_STATE hasAvailability() is false
Compliancemandatory This method must be implemented.
MethodgetProductRecord
Description

Gets the product record corresponding to the given Product record Type.This method is used to retrieve an object implementing the requested record. The productRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(productRecordType) is true.

Parametersosid.type.TypeproductRecordType the type of product record to retrieve
Returnosid.ordering.records.ProductRecord the product record
ErrorsNULL_ARGUMENT productRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(productRecordType) is false
Compliancemandatory This method must be implemented.