Interface DirectionQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSubjugateableQuery, Suppliable

public interface DirectionQuery
extends OsidObjectQuery, OsidSubjugateableQuery

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

Method Summary

Modifier and Type	Method	Description
void	clearAssetIdTerms()	Clears the asset Id query terms.
void	clearAssetTerms()	Clears the asset query terms.
void	clearCookbookIdTerms()	Clears the cookbook Id terms.
void	clearCookbookTerms()	Clears the cookbook query terms.
void	clearEstimatedDurationTerms()	Clears the duration query terms.
void	clearIngredientIdTerms()	Clears the ingredient Id query terms.
void	clearIngredientTerms()	Clears the ingredient query terms.
void	clearProcedureIdTerms()	Clears the procedure Id query terms.
void	clearProcedureTerms()	Clears the procedure query terms.
void	clearRecipeIdTerms()	Clears the recipe Id query terms.
void	clearRecipeTerms()	Clears the recipe query terms.
AssetQuery	getAssetQuery()	Gets the query for an asset.
CookbookQuery	getCookbookQuery()	Gets the query for a cookbook.
DirectionQueryRecord	getDirectionQueryRecord(Type directionRecordType)	Gets the direction query record corresponding to the given Direction record Type .
IngredientQuery	getIngredientQuery()	Gets the query for an ingredient.
ProcedureQuery	getProcedureQuery()	Gets the query for a procedure.
RecipeQuery	getRecipeQuery()	Gets the query for a recipe.
void	matchAnyAsset(boolean match)	Matches directions with any asset.
void	matchAnyEstimatedDuration(boolean match)	Matches directions with any estimated duration.
void	matchAnyIngredient(boolean match)	Matches directions with any ingredient.
void	matchAnyProcedure(boolean match)	Matches directions with any procedure.
void	matchAssetId(Id assetId, boolean match)	Sets the asset Id for this query.
void	matchCookbookId(Id cookbookId, boolean match)	Sets the award Id for this query to match directions assigned to cookbooks.
void	matchEstimatedDuration(Duration start, Duration end, boolean match)	Matches directions with an estimated duration between the given range inclusive.
void	matchIngredientId(Id ingredientId, boolean match)	Sets the ingredient Id .
void	matchProcedureId(Id procedureId, boolean match)	Sets the procedure Id for this query.
void	matchRecipeId(Id recipeId, boolean match)	Sets the recipe Id for this query.
boolean	supportsAssetQuery()	Tests if an AssetQuery is available.
boolean	supportsCookbookQuery()	Tests if a CookbookQuery is available.
boolean	supportsIngredientQuery()	Tests if an IngredientkQuery is available.
boolean	supportsProcedureQuery()	Tests if a ProcedureQuery is available.
boolean	supportsRecipeQuery()	Tests if a RecipeQuery is available.

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 OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchRecipeId

void matchRecipeId(Id recipeId,
 boolean match)

Sets the recipe Id for this query.

Parameters:

recipeId - the recipe Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - recipeId is null

Compliance:

mandatory - This method must be implemented.

clearRecipeIdTerms

void clearRecipeIdTerms()

Clears the recipe Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRecipeQuery

boolean supportsRecipeQuery()

Tests if a RecipeQuery is available.

Returns:

true if a recipe query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRecipeQuery

RecipeQuery getRecipeQuery()

Gets the query for a recipe. Multiple retrievals produce a nested OR term.

Returns:

the recipe query

Throws:

UnimplementedException - supportsRecipeQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRecipeQuery()} is {@code true} .

clearRecipeTerms

void clearRecipeTerms()

Clears the recipe query terms.

Compliance:

mandatory - This method must be implemented.

matchProcedureId

void matchProcedureId(Id procedureId,
 boolean match)

Sets the procedure Id for this query.

Parameters:

procedureId - the procedure Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - procedureId is null

Compliance:

mandatory - This method must be implemented.

clearProcedureIdTerms

void clearProcedureIdTerms()

Clears the procedure Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsProcedureQuery

boolean supportsProcedureQuery()

Tests if a ProcedureQuery is available.

Returns:

true if a procedure query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProcedureQuery

ProcedureQuery getProcedureQuery()

Gets the query for a procedure. Multiple retrievals produce a nested OR term.

Returns:

the procedure query

Throws:

UnimplementedException - supportsProcedureQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProcedureQuery()} is {@code true} .

matchAnyProcedure

void matchAnyProcedure(boolean match)

Matches directions with any procedure.

Parameters:

match - true to match directions with any procedure, false to match directions with no procedures

Compliance:

mandatory - This method must be implemented.

clearProcedureTerms

void clearProcedureTerms()

Clears the procedure query terms.

Compliance:

mandatory - This method must be implemented.

matchIngredientId

void matchIngredientId(Id ingredientId,
 boolean match)

Sets the ingredient Id .

Parameters:

ingredientId - the ingredient Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - ingredientId is null

Compliance:

mandatory - This method must be implemented.

clearIngredientIdTerms

void clearIngredientIdTerms()

Clears the ingredient Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsIngredientQuery

boolean supportsIngredientQuery()

Tests if an IngredientkQuery is available.

Returns:

true if an ingredient query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getIngredientQuery

IngredientQuery getIngredientQuery()

Gets the query for an ingredient. Multiple retrievals produce a nested OR term.

Returns:

the ingredient query

Throws:

UnimplementedException - supportsIngredientItemQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsIngredientQuery()} is {@code true} .

matchAnyIngredient

void matchAnyIngredient(boolean match)

Matches directions with any ingredient.

Parameters:

match - true to match directions with any ingredient, false to match directions with no ingredients

Compliance:

mandatory - This method must be implemented.

clearIngredientTerms

void clearIngredientTerms()

Clears the ingredient query terms.

Compliance:

mandatory - This method must be implemented.

matchEstimatedDuration

void matchEstimatedDuration(Duration start,
 Duration end,
 boolean match)

Matches directions with an estimated duration between the given range inclusive.

Parameters:

start - starting duration

end - ending duration

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyEstimatedDuration

void matchAnyEstimatedDuration(boolean match)

Matches directions with any estimated duration.

Parameters:

match - true to match directions with any estimated duration, false to match directions with no estimated duration

Compliance:

mandatory - This method must be implemented.

clearEstimatedDurationTerms

void clearEstimatedDurationTerms()

Clears the duration query terms.

Compliance:

mandatory - This method must be implemented.

matchAssetId

void matchAssetId(Id assetId,
 boolean match)

Sets the asset Id for this query.

Parameters:

assetId - the asset Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - assetId is null

Compliance:

mandatory - This method must be implemented.

clearAssetIdTerms

void clearAssetIdTerms()

Clears the asset Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAssetQuery

boolean supportsAssetQuery()

Tests if an AssetQuery is available.

Returns:

true if an asset query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssetQuery

AssetQuery getAssetQuery()

Gets the query for an asset. Multiple retrievals produce a nested OR term.

Returns:

the asset query

Throws:

UnimplementedException - supportsAssetQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetQuery()} is {@code true} .

matchAnyAsset

void matchAnyAsset(boolean match)

Matches directions with any asset.

Parameters:

match - true to match directions with any asset, false to match directions with no assets

Compliance:

mandatory - This method must be implemented.

clearAssetTerms

void clearAssetTerms()

Clears the asset query terms.

Compliance:

mandatory - This method must be implemented.

matchCookbookId

void matchCookbookId(Id cookbookId,
 boolean match)

Sets the award Id for this query to match directions assigned to cookbooks.

Parameters:

cookbookId - a cookbook Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - cookbookId is null

Compliance:

mandatory - This method must be implemented.

clearCookbookIdTerms

void clearCookbookIdTerms()

Clears the cookbook Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCookbookQuery

boolean supportsCookbookQuery()

Tests if a CookbookQuery is available.

Returns:

true if a cookbook query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCookbookQuery

CookbookQuery getCookbookQuery()

Gets the query for a cookbook. Multiple retrievals produce a nested OR term.

Returns:

the cookbook query

Throws:

UnimplementedException - supportsCookbookQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCookbookQuery()} is {@code true} .

clearCookbookTerms

void clearCookbookTerms()

Clears the cookbook query terms.

Compliance:

mandatory - This method must be implemented.

getDirectionQueryRecord

DirectionQueryRecord getDirectionQueryRecord(Type directionRecordType)
                                      throws OperationFailedException,
PermissionDeniedException

Gets the direction query record corresponding to the given Direction record Type . Multiple record retrievals produce a nested OR term.

Parameters:

directionRecordType - a direction record type

Returns:

the direction query 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.