OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.Item
Implementsosid.OsidObject
Description

An Item represents a particular item.

MethodgetStockId
Description

Gets the stock Id to which this item belongs.

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

Gets the stock to which this item belongs.

Returnosid.inventory.Stocka stock
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetPropertyTag
Description

Gets the property identification number for this item.

Returnstringa property tag
CompliancemandatoryThis method must be implemented.
MethodgetSerialNumber
Description

Gets the serial number for this item.

Returnstringa serial number
CompliancemandatoryThis method must be implemented.
MethodgetLocationDescription
Description

Gets a display string for the location.

Returnosid.locale.DisplayTexta location descrption
CompliancemandatoryThis method must be implemented.
MethodhasLocation
Description

Tests if this item has a known location.

Returnboolean true if a location is associated with this item, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLocationId
Description

Gets the location Id to which this item belongs.

Returnosid.id.Ida location Id
ErrorsILLEGAL_STATE hasLocation() is false
CompliancemandatoryThis method must be implemented.
MethodgetLocation
Description

Gets the location to which this item belongs.

Returnosid.mapping.Locationa location
ErrorsILLEGAL_STATE hasLocation() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodisPart
Description

Tests if this item is a part of another item.

Returnboolean true if this item is a part of another item, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetItemId
Description

Gets the item Id to which this item belongs.

Returnosid.id.Ida item Id
ErrorsILLEGAL_STATE isPart() is false
CompliancemandatoryThis method must be implemented.
MethodgetItem
Description

Gets the item to which this item belongs.

Returnosid.inventory.Itema item
ErrorsILLEGAL_STATE isPart() is false
OPERATION_FAILEDunable to complete request
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.inventory.records.ItemRecordthe item record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.