org.osid.recipe

Interface CookbookSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CookbookSearch
extends OsidSearch

The search interface for governing cook book searches.

Method Summary

Methods

Modifier and Type	Method and Description
CookbookSearchRecord	getCookbookSearchRecord(Type cookbookSearchRecordType) Gets the cook book search record corresponding to the given cook book 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 cook books.

Methods inherited from interface org.osid.OsidSearch

limitResultSet

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

searchAmongCookbooks

void searchAmongCookbooks(IdList cookbookIds)

Execute this search among the given list of cook books.

Parameters:

cookbookIds - list of cook books

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 - cook book 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 cook book search record corresponding to the given cook book search record Type. This method is used to retrieve an object implementing the requested record interface.

Parameters:

cookbookSearchRecordType - a cook book search record type

Returns:

the cook book search record

Throws:

NullArgumentException - cookbooksearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cookbooksearchRecordType) is false

Compliance:

mandatory - This method must be implemented.