public interface Warehouse extends OsidCatalog
A Warehouse
represents a collection of inventories.
Modifier and Type | Method and Description |
---|---|
WarehouseRecord |
getWarehouseRecord(Type warehouseRecordType)
Gets the warehouse record corresponding to the given
Warehouse
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
WarehouseRecord getWarehouseRecord(Type warehouseRecordType) throws OperationFailedException
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
.warehouseRecordType
- the type of warehouse record to retrieveNullArgumentException
- warehouseRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(warehouseRecordType)
is false
mandatory
- This method must be implemented.