OSID Logo
OSID Specifications
inventory package
Version 3.1.0
Interfaceosid.inventory.Inventory
Implementsosid.OsidObject
osid.Subjugateable
Used Byosid.inventory.InventoryAdminSession
osid.inventory.InventoryList
osid.inventory.InventoryLookupSession
Description

An Inventory is count of the stock at a point in time.

MethodgetStockId
Description

Gets the Id of the Stock.

Returnosid.id.Id the stock Id
Compliancemandatory This method must be implemented.
MethodgetStock
Description

Gets the Id of the Stock.

Returnosid.inventory.Stock the stock
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetDate
Description

Gets the inventory date.

Returnosid.calendaring.DateTime the inventory date
Compliancemandatory This method must be implemented.
MethodgetQuantity
Description

Gets the quantity of the items in the stock.

Returndecimal the quantity
Compliancemandatory This 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.TypeinventoryRecordType the type of inventory record to retrieve
Returnosid.inventory.records.InventoryRecord the inventory record
ErrorsNULL_ARGUMENT inventoryRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(inventoryRecordType) is false
Compliancemandatory This method must be implemented.