OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.CookbookSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetCookbooks
Description

Gets the cook book list resulting from a search.

Returnosid.recipe.CookbookListthe cook book list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCookbookQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.recipe.CookbookQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCookbookSearchResultsRecord
Description

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

Parametersosid.type.TypecookbookSearchRecordTypea cook book search record type
Returnosid.recipe.records.CookbookSearchResultsRecordthe cook book search results record
ErrorsNULL_ARGUMENT cookbookSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(cookbookSearchRecordType) is false
CompliancemandatoryThis method must be implemented.