org.osid.recipe

Interface RecipeSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RecipeSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
RecipeQueryInspector	getRecipeQueryInspector() Gets the inspector for the query to examine the terms used in the search.
RecipeList	getRecipes() Gets the recipe list resulting from a search.
RecipeSearchResultsRecord	getRecipeSearchResultsRecord(Type recipeSearchRecordType) Gets the recipe search results record corresponding to the given recipe search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getRecipes

RecipeList getRecipes()

Gets the recipe list resulting from a search.

Returns:

the recipe list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getRecipeQueryInspector

RecipeQueryInspector getRecipeQueryInspector()

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

Returns:

the recipe query inspector

Compliance:

mandatory - This method must be implemented.

getRecipeSearchResultsRecord

RecipeSearchResultsRecord getRecipeSearchResultsRecord(Type recipeSearchRecordType)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

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

Parameters:

recipeSearchRecordType - a recipe search record type

Returns:

the recipe search results record

Throws:

NullArgumentException - recipeSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(recipeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.