org.osid.inventory

Interface Inventory

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Subjugateable

public interface Inventory
extends OsidObject, Subjugateable

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

Method Summary

Methods

Modifier and Type	Method and Description
DateTime	getDate() Gets the inventory date.
InventoryRecord	getInventoryRecord(Type inventoryRecordType) Gets the inventory record corresponding to the given Inventory record Type.
java.math.BigDecimal	getQuantity() Gets the quantity of the items in the stock.
Stock	getStock() Gets the Id of the Stock.
Id	getStockId() Gets the Id of the Stock.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getStockId

Id getStockId()

Gets the Id of the Stock.

Returns:

the stock Id

Compliance:

mandatory - This method must be implemented.

getStock

Stock getStock()
               throws OperationFailedException

Gets the Id of the Stock.

Returns:

the stock

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getDate

DateTime getDate()

Gets the inventory date.

Returns:

the inventory date

Compliance:

mandatory - This method must be implemented.

getQuantity

java.math.BigDecimal getQuantity()

Gets the quantity of the items in the stock.

Returns:

the quantity

Compliance:

mandatory - This method must be implemented.

getInventoryRecord

InventoryRecord getInventoryRecord(Type inventoryRecordType)
                                   throws OperationFailedException

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 .

Parameters:

inventoryRecordType - the type of inventory record to retrieve

Returns:

the inventory record

Throws:

NullArgumentException - inventoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inventoryRecordType) is false

Compliance:

mandatory - This method must be implemented.