org.osid.recipe

Interface CookbookQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface CookbookQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for searching for cook books. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorCookbookIdTerms() Gets the ancestor cook book Id terms.
CookbookQueryInspector[]	getAncestorCookbookTerms() Gets the ancestor cook book terms.
CookbookQueryInspectorRecord	getCookbookQueryInspectorRecord(Type cookbookRecordType) Gets the query inspector record corresponding to the given Cookbook record Type.
IdTerm[]	getDescendantCookbookIdTerms() Gets the descendant cook book Id terms.
CookbookQueryInspector[]	getDescendantCookbookTerms() Gets the descendant cook book terms.
IdTerm[]	getDirectionIdTerms() Gets the direction Id terms.
DirectionQueryInspector[]	getDirectionTerms() Gets the direction terms.
IdTerm[]	getProcedureIdTerms() Gets the procedure Id terms.
ProcedureQueryInspector[]	getProcedureTerms() Gets the procedure terms.
IdTerm[]	getRecipeIdTerms() Gets the recipe Id terms.
RecipeQueryInspector[]	getRecipeTerms() Gets the recipe terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getRecipeIdTerms

IdTerm[] getRecipeIdTerms()

Gets the recipe Id terms.

Returns:

the recipe Id terms

Compliance:

mandatory - This method must be implemented.

getRecipeTerms

RecipeQueryInspector[] getRecipeTerms()

Gets the recipe terms.

Returns:

the recipe terms

Compliance:

mandatory - This method must be implemented.

getProcedureIdTerms

IdTerm[] getProcedureIdTerms()

Gets the procedure Id terms.

Returns:

the procedure Id terms

Compliance:

mandatory - This method must be implemented.

getProcedureTerms

ProcedureQueryInspector[] getProcedureTerms()

Gets the procedure terms.

Returns:

the procedure terms

Compliance:

mandatory - This method must be implemented.

getDirectionIdTerms

IdTerm[] getDirectionIdTerms()

Gets the direction Id terms.

Returns:

the direction Id terms

Compliance:

mandatory - This method must be implemented.

getDirectionTerms

DirectionQueryInspector[] getDirectionTerms()

Gets the direction terms.

Returns:

the direction terms

Compliance:

mandatory - This method must be implemented.

getAncestorCookbookIdTerms

IdTerm[] getAncestorCookbookIdTerms()

Gets the ancestor cook book Id terms.

Returns:

the ancestor cook book Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorCookbookTerms

CookbookQueryInspector[] getAncestorCookbookTerms()

Gets the ancestor cook book terms.

Returns:

the ancestor cook book terms

Compliance:

mandatory - This method must be implemented.

getDescendantCookbookIdTerms

IdTerm[] getDescendantCookbookIdTerms()

Gets the descendant cook book Id terms.

Returns:

the descendant cook book Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantCookbookTerms

CookbookQueryInspector[] getDescendantCookbookTerms()

Gets the descendant cook book terms.

Returns:

the descendant cook book terms

Compliance:

mandatory - This method must be implemented.

getCookbookQueryInspectorRecord

CookbookQueryInspectorRecord getCookbookQueryInspectorRecord(Type cookbookRecordType)
                                                             throws OperationFailedException

Gets the query inspector record corresponding to the given Cookbook record Type.

Parameters:

cookbookRecordType - a cook book record type

Returns:

the cook book query inspector record

Throws:

NullArgumentException - cookbookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cookbookRecordType) is false

Compliance:

mandatory - This method must be implemented.