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

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

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.