org.osid.inventory

Interface Warehouse

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Warehouse
extends OsidCatalog

A Warehouse represents a collection of inventories.

Method Summary

Methods

Modifier and Type	Method and Description
WarehouseRecord	getWarehouseRecord(Type warehouseRecordType) Gets the warehouse record corresponding to the given Warehouse 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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getWarehouseRecord

WarehouseRecord getWarehouseRecord(Type warehouseRecordType)
                                   throws OperationFailedException

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

Parameters:

warehouseRecordType - the type of warehouse record to retrieve

Returns:

the warehouse record

Throws:

NullArgumentException - warehouseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(warehouseRecordType) is false

Compliance:

mandatory - This method must be implemented.