OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Interfaceosid.recipe.CookbookSearch
Implementsosid.OsidSearch
Used Byosid.recipe.CookbookSearchSession
Description

The search interface for governing cookbook searches.

MethodsearchAmongCookbooks
Description

Execute this search among the given list of cookbooks.

Parametersosid.id.IdListcookbookIdslist of cookbooks
ErrorsNULL_ARGUMENTcookbookIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCookbookResults
Description

Specify an ordering to the search results.

Parametersosid.recipe.CookbookSearchOrdercookbooksearchOrdercookbook search order
ErrorsNULL_ARGUMENTcookbooksearchOrder is null
UNSUPPORTEDcookbooksearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCookbookSearchRecord
Description

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.

Parametersosid.type.TypecookbookSearchRecordTypea cookbook search record type
Returnosid.recipe.records.CookbookSearchRecordthe cookbook search record
ErrorsNULL_ARGUMENTcookbooksearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(cookbooksearchRecordType) is false
CompliancemandatoryThis method must be implemented.