Interface InventorySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface InventorySearch
extends OsidSearch

The search interface for governing inventory searches.

Method Summary

Modifier and Type	Method	Description
InventorySearchRecord	getInventorySearchRecord(Type inventorySearchRecordType)	Gets the inventory search record corresponding to the given inventory search record Type.
void	orderInventoryResults(InventorySearchOrder inventorySearchOrder)	Specify an ordering to the search results.
void	searchAmongInventories(IdList inventoryIds)	Execute this search among the given list of inventories.

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

searchAmongInventories

void searchAmongInventories(IdList inventoryIds)

Execute this search among the given list of inventories.

Parameters:

inventoryIds - list of inventories

Throws:

NullArgumentException - inventoryIds is null

Compliance:

mandatory - This method must be implemented.

orderInventoryResults

void orderInventoryResults(InventorySearchOrder inventorySearchOrder)

Specify an ordering to the search results.

Parameters:

inventorySearchOrder - inventory search order

Throws:

NullArgumentException - inventorySearchOrder is null

UnsupportedException - inventorySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getInventorySearchRecord

InventorySearchRecord getInventorySearchRecord(Type inventorySearchRecordType)
                                        throws OperationFailedException

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

Parameters:

inventorySearchRecordType - an inventory search record type

Returns:

the inventory search record

Throws:

NullArgumentException - inventorySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inventorySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.