Interface WarehouseSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface WarehouseSearch
extends OsidSearch

The search interface for governing warehouse searches.

Method Summary

Modifier and Type	Method	Description
WarehouseSearchRecord	getWarehouseSearchRecord(Type warehouSesearchRecordType)	Gets the warehouse search record corresponding to the given warehouse search record Type.
void	orderWarehouseResults(WarehouseSearchOrder warehouseSearchOrder)	Specify an ordering to the search results.
void	searchAmongWarehouses(IdList warehouseIds)	Execute this search among the given list of warehouses.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongWarehouses

void searchAmongWarehouses(IdList warehouseIds)

Execute this search among the given list of warehouses.

Parameters:

warehouseIds - list of warehouses

Throws:

NullArgumentException - warehouseIds is null

Compliance:

mandatory - This method must be implemented.

orderWarehouseResults

void orderWarehouseResults(WarehouseSearchOrder warehouseSearchOrder)

Specify an ordering to the search results.

Parameters:

warehouseSearchOrder - warehouse search order

Throws:

NullArgumentException - warehousesearchOrder is null

UnsupportedException - warehousesearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getWarehouseSearchRecord

WarehouseSearchRecord getWarehouseSearchRecord(Type warehouSesearchRecordType)
                                        throws OperationFailedException

Gets the warehouse search record corresponding to the given warehouse search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

warehouSesearchRecordType - a warehouse search record type

Returns:

the warehouse search record

Throws:

NullArgumentException - warehouseSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(warehouseSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.