org.osid.inventory

Interface Stock

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidObject

public interface Stock
extends OsidObject, Federateable

A Stock represents a kit and kaboodle.

Method Summary

Methods

Modifier and Type	Method and Description
DisplayText	getLocationDescription() Gets the location description in which this stock is located.
IdList	getLocationIds() Gets the location Id to which this stock is located.
LocationList	getLocations() Gets the location to which this stock is located.
IdList	getModelIds() Gets the model Ids of the items in this stock.
ModelList	getModels() Gets the models of the items in this stock.
java.lang.String	getSKU() Gets the sku for this class of items.
StockRecord	getStockRecord(Type stockRecordType) Gets the stock record corresponding to the given Stock record Type.

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

getSKU

java.lang.String getSKU()

Gets the sku for this class of items.

Returns:

a stock keeping unit

Compliance:

mandatory - This method must be implemented.

getModelIds

IdList getModelIds()

Gets the model Ids of the items in this stock.

Returns:

model Ids

Compliance:

mandatory - This method must be implemented.

getModels

ModelList getModels()
                    throws OperationFailedException

Gets the models of the items in this stock.

Returns:

a model list

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getLocationDescription

DisplayText getLocationDescription()

Gets the location description in which this stock is located.

Returns:

a location

Compliance:

mandatory - This method must be implemented.

getLocationIds

IdList getLocationIds()

Gets the location Id to which this stock is located.

Returns:

a location Id

Compliance:

mandatory - This method must be implemented.

getLocations

LocationList getLocations()
                          throws OperationFailedException

Gets the location to which this stock is located.

Returns:

a location list

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getStockRecord

StockRecord getStockRecord(Type stockRecordType)
                           throws OperationFailedException

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

Parameters:

stockRecordType - the type of stock record to retrieve

Returns:

the stock record

Throws:

NullArgumentException - stockRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stockRecordType) is false

Compliance:

mandatory - This method must be implemented.