Interface CookbookSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CookbookSearch
extends OsidSearch

The search interface for governing cookbook searches.

Method Summary

Modifier and Type	Method	Description
CookbookSearchRecord	getCookbookSearchRecord(Type cookbookSearchRecordType)	Gets the cookbook search record corresponding to the given cookbook search record Type.
void	orderCookbookResults(CookbookSearchOrder cookbooksearchOrder)	Specify an ordering to the search results.
void	searchAmongCookbooks(IdList cookbookIds)	Execute this search among the given list of cookbooks.

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

searchAmongCookbooks

void searchAmongCookbooks(IdList cookbookIds)

Execute this search among the given list of cookbooks.

Parameters:

cookbookIds - list of cookbooks

Throws:

NullArgumentException - cookbookIds is null

Compliance:

mandatory - This method must be implemented.

orderCookbookResults

void orderCookbookResults(CookbookSearchOrder cookbooksearchOrder)

Specify an ordering to the search results.

Parameters:

cookbooksearchOrder - cookbook search order

Throws:

NullArgumentException - cookbooksearchOrder is null

UnsupportedException - cookbooksearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCookbookSearchRecord

CookbookSearchRecord getCookbookSearchRecord(Type cookbookSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

cookbookSearchRecordType - a cookbook search record type

Returns:

the cookbook search record

Throws:

NullArgumentException - cookbooksearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cookbooksearchRecordType) is false

Compliance:

mandatory - This method must be implemented.