OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.Inventory
Implementsosid.OsidObject
osid.Subjugateable
Description

An Inventory represents a cost object for a organization unit or other inventory.

MethodgetStockId
Description

Gets the Id of the Stock.

Returnosid.id.Idthe stock Id
CompliancemandatoryThis method must be implemented.
MethodgetStock
Description

Gets the Id of the Stock.

Returnosid.inventory.Stockthe stock
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetDate
Description

Gets the inventory date.

Returnosid.calendaring.DateTimethe inventory date
CompliancemandatoryThis method must be implemented.
MethodgetQuantity
Description

Gets the quantity of the items in the stock.

Returndecimalthe quantity
CompliancemandatoryThis method must be implemented.
MethodgetInventoryRecord
Description

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

Parametersosid.type.TypeinventoryRecordTypethe type of inventory record to retrieve
Returnosid.inventory.records.InventoryRecordthe inventory record
ErrorsNULL_ARGUMENT inventoryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inventoryRecordType) is false
CompliancemandatoryThis method must be implemented.