org.osid.recipe

Interface RecipeQueryInspector

All Superinterfaces:

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

public interface RecipeQueryInspector
extends OsidObjectQueryInspector, OsidSourceableQueryInspector

This is the query inspector for examining recipe queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAssetIdTerms() Gets the asset query terms.
AssetQueryInspector[]	getAssetTerms() Gets the asset query terms.
IdTerm[]	getCookbookIdTerms() Gets the cook book Id query terms.
CookbookQueryInspector[]	getCookbookTerms() Gets the cook book query terms.
IdTerm[]	getDirectionIdTerms() Gets the direction Id query terms.
DirectionQueryInspector[]	getDirectionTerms() Gets the direction query terms.
RecipeQueryInspectorRecord	getRecipeQueryInspectorRecord(Type recipeRecordType) Gets the recipe query inspector record corresponding to the given Recipe record Type.
DurationRangeTerm[]	getTotalDurationTerms() Gets the total duration query terms.
DurationRangeTerm[]	getTotalEstimatedDurationTerms() Gets the estimated duration query 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

getTotalEstimatedDurationTerms

DurationRangeTerm[] getTotalEstimatedDurationTerms()

Gets the estimated duration query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAssetIdTerms

IdTerm[] getAssetIdTerms()

Gets the asset query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAssetTerms

AssetQueryInspector[] getAssetTerms()

Gets the asset query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDirectionIdTerms

IdTerm[] getDirectionIdTerms()

Gets the direction Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDirectionTerms

DirectionQueryInspector[] getDirectionTerms()

Gets the direction query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTotalDurationTerms

DurationRangeTerm[] getTotalDurationTerms()

Gets the total duration query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCookbookIdTerms

IdTerm[] getCookbookIdTerms()

Gets the cook book Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCookbookTerms

CookbookQueryInspector[] getCookbookTerms()

Gets the cook book query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRecipeQueryInspectorRecord

RecipeQueryInspectorRecord getRecipeQueryInspectorRecord(Type recipeRecordType)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Gets the recipe query inspector record corresponding to the given Recipe record Type.

Parameters:

recipeRecordType - a recipe record type

Returns:

the recipe query inspector record

Throws:

NullArgumentException - recipeRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(recipeRecordType) is false

Compliance:

mandatory - This method must be implemented.