public interface RecipeQuery extends OsidObjectQuery, OsidSourceableQuery
This is the query for searching recipes. 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 |
clearDirectionIdTerms()
Clears the direction
Id query terms. |
void |
clearDirectionTerms()
Clears the direction query terms.
|
void |
clearTotalDurationTerms()
Clears the duration query terms.
|
void |
clearTotalEstimatedDurationTerms()
Clears the duration query terms.
|
AssetQuery |
getAssetQuery()
Gets the query for an asset.
|
CookbookQuery |
getCookbookQuery()
Gets the query for a cookbook.
|
DirectionQuery |
getDirectionQuery()
Gets the query for a direction.
|
RecipeQueryRecord |
getRecipeQueryRecord(Type recipeRecordType)
Gets the recipe query record corresponding to the given
Recipe
record Type. |
void |
matchAnyAsset(boolean match)
Matches directions with any asset.
|
void |
matchAnyDirection(boolean match)
Matches recipes that have any direction.
|
void |
matchAnyTotalEstimatedDuration(boolean match)
Matches recipes with any estimated duration.
|
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 recipes
assigned to cookbooks. |
void |
matchDirectionId(Id qualifierId,
boolean match)
Sets the direction
Id for this query. |
void |
matchTotalDuration(Duration start,
Duration end,
boolean match)
Matches recipies with an estimated duration between the given range
inclusive.
|
void |
matchTotalEstimatedDuration(Duration start,
Duration end,
boolean match)
Matches recipies with an estimated duration between the given range
inclusive.
|
boolean |
supportsAssetQuery()
Tests if an
AssetQuery is available. |
boolean |
supportsCookbookQuery()
Tests if a
CookbookQuery is available. |
boolean |
supportsDirectionQuery()
Tests if a
DirectionQuery 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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchTotalEstimatedDuration(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 matchAnyTotalEstimatedDuration(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 clearTotalEstimatedDurationTerms()
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 matchDirectionId(Id qualifierId, boolean match)
Id
for this query.qualifierId
- the direction Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- directionId
is
null
mandatory
- This method must be implemented. void clearDirectionIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDirectionQuery()
DirectionQuery
is available. true
if a direction query is available,
false
otherwisemandatory
- This method must be implemented. DirectionQuery getDirectionQuery()
OR
term.UnimplementedException
-
supportsDirectionQuery()
is false
optional
- This method must be implemented if
supportsDirectionQuery()
is true.
void matchAnyDirection(boolean match)
match
- true
to match recipes with any direction,
false
to match recipes with no directionmandatory
- This method must be implemented. void clearDirectionTerms()
mandatory
- This method must be implemented. void matchTotalDuration(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 clearTotalDurationTerms()
mandatory
- This method must be implemented. void matchCookbookId(Id cookbookId, boolean match)
Id
for this query to match recipes
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. RecipeQueryRecord getRecipeQueryRecord(Type recipeRecordType) throws OperationFailedException, PermissionDeniedException
Recipe
record Type.
Multiple record retrievals produce
a nested OR
term.recipeRecordType
- a recipe record typeNullArgumentException
- recipeRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(recipeRecordType)
is false
mandatory
- This method must be implemented.