org.osid.recipe

Interface DirectionQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector

public interface DirectionQueryInspector
extends OsidObjectQueryInspector, OsidSubjugateableQueryInspector

This is the query inspector for examining direction 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.
DirectionQueryInspectorRecord	getDirectionQueryInspectorRecord(Type directionRecordType) Gets the direction query inspector record corresponding to the given Direction record Type.
DurationRangeTerm[]	getEstimatedDurationTerms() Gets the estimated duration query terms.
IdTerm[]	getIngredientIdTerms() Gets the ingredient query terms.
IngredientQueryInspector[]	getIngredientTerms() Gets the ingredient query terms.
IdTerm[]	getProcedureIdTerms() Gets the procedure query terms.
ProcedureQueryInspector[]	getProcedureTerms() Gets the procedure query terms.
IdTerm[]	getRecipeIdTerms() Gets the recipe Id query terms.
RecipeQueryInspector[]	getRecipeTerms() Gets the recipe 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

Method Detail

getRecipeIdTerms

IdTerm[] getRecipeIdTerms()

Gets the recipe Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRecipeTerms

RecipeQueryInspector[] getRecipeTerms()

Gets the recipe query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProcedureIdTerms

IdTerm[] getProcedureIdTerms()

Gets the procedure query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProcedureTerms

ProcedureQueryInspector[] getProcedureTerms()

Gets the procedure query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIngredientIdTerms

IdTerm[] getIngredientIdTerms()

Gets the ingredient query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIngredientTerms

IngredientQueryInspector[] getIngredientTerms()

Gets the ingredient query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEstimatedDurationTerms

DurationRangeTerm[] getEstimatedDurationTerms()

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.

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.

getDirectionQueryInspectorRecord

DirectionQueryInspectorRecord getDirectionQueryInspectorRecord(Type directionRecordType)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

Gets the direction query inspector record corresponding to the given Direction record Type.

Parameters:

directionRecordType - a direction record type

Returns:

the direction query inspector record

Throws:

NullArgumentException - directionRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(directionRecordType) is false

Compliance:

mandatory - This method must be implemented.