public interface Inventory extends OsidObject, Subjugateable
An Inventory
represents a cost object for a organization
unit or other inventory.
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. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getStockId()
Id
of the Stock.
Id
mandatory
- This method must be implemented. Stock getStock() throws OperationFailedException
Id
of the Stock.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getDate()
mandatory
- This method must be implemented. java.math.BigDecimal getQuantity()
mandatory
- This method must be implemented. InventoryRecord getInventoryRecord(Type inventoryRecordType) throws OperationFailedException
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
.inventoryRecordType
- the type of inventory record to retrieveNullArgumentException
- inventoryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inventoryRecordType)
is false
mandatory
- This method must be implemented.