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.
Modifier and Type | Method and Description |
---|---|
void |
clearAssetIdTerms()
Clears the asset
Id query terms. |
void |
clearAssetTerms()
Clears the asset query terms.
|
void |
clearCookbookIdTerms()
Clears the cook book
Id terms. |
void |
clearCookbookTerms()
Clears the cook book 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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchRecipeId(Id recipeId, boolean match)
Id
for this query.recipeId
- the recipe Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- recipeId
is
null
mandatory
- This method must be implemented. void clearRecipeIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRecipeQuery()
RecipeQuery
is available. true
if a recipe query is available,
false
otherwisemandatory
- This method must be implemented. RecipeQuery getRecipeQuery()
OR
term.UnimplementedException
- supportsRecipeQuery()
is false
optional
- This method must be implemented if
supportsRecipeQuery()
is true.
void clearRecipeTerms()
mandatory
- This method must be implemented. void matchProcedureId(Id procedureId, boolean match)
Id
for this query.procedureId
- the procedure Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- procedureId
is
null
mandatory
- This method must be implemented. void clearProcedureIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsProcedureQuery()
ProcedureQuery
is available. true
if a procedure query is available,
false
otherwisemandatory
- This method must be implemented. ProcedureQuery getProcedureQuery()
OR
term.UnimplementedException
-
supportsProcedureQuery()
is false
optional
- This method must be implemented if
supportsProcedureQuery()
is true.
void matchAnyProcedure(boolean match)
match
- true
to match directions with any
procedure, false
to match directions with no
proceduresmandatory
- This method must be implemented. void clearProcedureTerms()
mandatory
- This method must be implemented. void matchIngredientId(Id ingredientId, boolean match)
Id.
ingredientId
- the ingredient Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- ingredientId
is
null
mandatory
- This method must be implemented. void clearIngredientIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsIngredientQuery()
IngredientkQuery
is available. true
if an ingredient query is available,
false
otherwisemandatory
- This method must be implemented. IngredientQuery getIngredientQuery()
OR
term.UnimplementedException
-
supportsIngredientItemQuery()
is false
optional
- This method must be implemented if
supportsIngredientQuery()
is true.
void matchAnyIngredient(boolean match)
match
- true
to match directions with any
ingredient, false
to match directions with no
ingredientsmandatory
- This method must be implemented. void clearIngredientTerms()
mandatory
- This method must be implemented. void matchEstimatedDuration(Duration start, Duration end, boolean match)
start
- starting durationend
- ending durationmatch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- start
is
greater than end
NullArgumentException
- start
or
end
is null
mandatory
- This method must be implemented. void matchAnyEstimatedDuration(boolean match)
match
- true
to match directions with any
estimated duration, false
to match directions
with no estimated durationmandatory
- This method must be implemented. void clearEstimatedDurationTerms()
mandatory
- This method must be implemented. void matchAssetId(Id assetId, boolean match)
Id
for this query.assetId
- the asset Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- assetId
is
null
mandatory
- This method must be implemented. void clearAssetIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAssetQuery()
AssetQuery
is available. true
if an asset query is available,
false
otherwisemandatory
- This method must be implemented. AssetQuery getAssetQuery()
OR
term.UnimplementedException
- supportsAssetQuery()
is false
optional
- This method must be implemented if
supportsAssetQuery()
is true.
void matchAnyAsset(boolean match)
match
- true
to match directions with any asset,
false
to match directions with no assetsmandatory
- This method must be implemented. void clearAssetTerms()
mandatory
- This method must be implemented. void matchCookbookId(Id cookbookId, boolean match)
Id
for this query to match directions
assigned to cookbooks.cookbookId
- a cook book Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- cookbookId
is
null
mandatory
- This method must be implemented. void clearCookbookIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCookbookQuery()
CookbookQuery
is available. true
if a cook book query is available,
false
otherwisemandatory
- This method must be implemented. CookbookQuery getCookbookQuery()
OR
term.UnimplementedException
- supportsCookbookQuery()
is false
optional
- This method must be implemented if
supportsCookbookQuery()
is true.
void clearCookbookTerms()
mandatory
- This method must be implemented. DirectionQueryRecord getDirectionQueryRecord(Type directionRecordType) throws OperationFailedException, PermissionDeniedException
Direction
record Type.
Multiple record
retrievals produce a nested OR
term.directionRecordType
- a direction record typeNullArgumentException
- directionRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(directionRecordType)
is false
mandatory
- This method must be implemented.