org.osid.inventory

Interface WarehouseSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface WarehouseSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
WarehouseSearchOrderRecord	getWarehouseSearchOrderRecord(Type warehouseRecordType) Gets the warehouse search order record corresponding to the given course record Type.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getWarehouseSearchOrderRecord

WarehouseSearchOrderRecord getWarehouseSearchOrderRecord(Type warehouseRecordType)
                                                         throws OperationFailedException

Gets the warehouse search order record corresponding to the given course record Type. Multiple retrievals return the same underlying object.

Parameters:

warehouseRecordType - a warehouse record type

Returns:

the warehouse search order record

Throws:

NullArgumentException - warehouseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(warehouseRecordType) is false

Compliance:

mandatory - This method must be implemented.