OSID - osid.inventory.Stock Service Interface Definition

Interface	osid.inventory.Stock
Implements	`osid.OsidObject`
Implements	`osid.Federateable`
Used By	`osid.checklist.mason.TodoProducer`
	`osid.inventory.Inventory`
	`osid.inventory.Item`
	`osid.inventory.StockAdminSession`
	`osid.inventory.StockList`
	`osid.inventory.StockLookupSession`
	`osid.inventory.StockNode`
	`osid.inventory.shipment.Entry`
	`osid.recipe.Ingredient`
Description	A `Stock` represents a class of items in a warehouse.
Method	getSKU
Description	Gets the sku for this class of items.
Return	`string`		a stock keeping unit
Compliance	`mandatory`		This method must be implemented.
Method	getModelIds
Description	Gets the model `Ids` of the items in this stock.
Return	`osid.id.IdList`		model `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getModels
Description	Gets the models of the items in this stock.
Return	`osid.inventory.ModelList`		a model list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getLocationDescription
Description	Gets the location description in which this stock is located.
Return	`osid.locale.DisplayText`		a location
Compliance	`mandatory`		This method must be implemented.
Method	getLocationIds
Description	Gets the location `Id` to which this stock is located.
Return	`osid.id.IdList`		a location `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getLocations
Description	Gets the location to which this stock is located.
Return	`osid.mapping.LocationList`		a location list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getStockRecord
Description	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	`osid.type.Type`	`stockRecordType`	the type of stock record to retrieve
Return	`osid.inventory.records.StockRecord`		the stock record
Errors	NULL_ARGUMENT		`stockRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(stockRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.