Interface ItemSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ItemSearch
extends OsidSearch

ItemSearch defines the interface for specifying item search options.

Method Summary

Modifier and Type	Method	Description
ItemSearchRecord	getItemSearchRecord(Type itemSearchRecordType)	Gets the item search record corresponding to the given item search record Type.
void	orderItemResults(ItemSearchOrder itemSearchOrder)	Specify an ordering to the search results.
void	searchAmongItems(IdList itemIds)	Execute this search among the given list of items.

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

searchAmongItems

void searchAmongItems(IdList itemIds)

Execute this search among the given list of items.

Parameters:

itemIds - list of items

Throws:

NullArgumentException - itemIds is null

Compliance:

mandatory - This method must be implemented.

orderItemResults

void orderItemResults(ItemSearchOrder itemSearchOrder)

Specify an ordering to the search results.

Parameters:

itemSearchOrder - item search order

Throws:

NullArgumentException - itemSearchOrder is null

UnsupportedException - itemSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getItemSearchRecord

ItemSearchRecord getItemSearchRecord(Type itemSearchRecordType)
                              throws OperationFailedException

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

Parameters:

itemSearchRecordType - an item search record type

Returns:

the item search record

Throws:

NullArgumentException - itemSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(itemSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.