public interface CookbookQuery extends OsidCatalogQuery
This is the query for searching for cook books. Each method specifies
an AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorCookbookIdTerms()
Clears the ancestor cook book
Id terms. |
void |
clearAncestorCookbookTerms()
Clears the ancestor cook book terms.
|
void |
clearDescendantCookbookIdTerms()
Clears the descendant cook book
Id terms. |
void |
clearDescendantCookbookTerms()
Clears the descendant cook book terms.
|
void |
clearDirectionIdTerms()
Clears the direction
Id terms. |
void |
clearDirectionTerms()
Clears the direction terms.
|
void |
clearProcedureIdTerms()
Clears the procedure
Id terms. |
void |
clearProcedureTerms()
Clears the procedure terms.
|
void |
clearRecipeIdTerms()
Clears the recipe
Id terms. |
void |
clearRecipeTerms()
Clears the procedure terms.
|
CookbookQuery |
getAncestorCookbookQuery()
Gets the query for a cookbook.
|
CookbookQueryRecord |
getCookbookQueryRecord(Type cookbookRecordType)
Gets the query record corresponding to the given
Cookbook
record Type. |
CookbookQuery |
getDescendantCookbookQuery()
Gets the query for a cookbook.
|
DirectionQuery |
getDirectionQuery()
Gets the query for a direction query.
|
ProcedureQuery |
getProcedureQuery()
Gets the query for an procedure.
|
RecipeQuery |
getRecipeQuery()
Gets the query for a recipe.
|
void |
matchAncestorCookbookId(Id cookbookId,
boolean match)
Sets the cook book
Id for this query to match cook
books that have the specified cook book as an ancestor. |
void |
matchAnyAncestorCookbook(boolean match)
Matches cook books with any ancestor.
|
void |
matchAnyDescendantCookbook(boolean match)
Matches cook books with any descendant.
|
void |
matchAnyDirection(boolean match)
Matches any direction.
|
void |
matchAnyProcedure(boolean match)
Matches cook books with any procedure.
|
void |
matchAnyRecipe(boolean match)
Matches cook books with any recipe.
|
void |
matchDescendantCookbookId(Id cookbookId,
boolean match)
Sets the cook book
Id for this query to match cook
books that have the specified cook book as a descendant. |
void |
matchDirectionId(Id directionId,
boolean match)
Sets a direction
Id. |
void |
matchProcedureId(Id procedureId,
boolean match)
Sets the procedure
Id for this query to match
procedures assigned to cook books. |
void |
matchRecipeId(Id recipeId,
boolean match)
Sets the recipe
Id for this query. |
boolean |
supportsAncestorCookbookQuery()
Tests if an
CookbookQuery is available. |
boolean |
supportsDescendantCookbookQuery()
Tests if an
CookbookQuery is available. |
boolean |
supportsDirectionQuery()
Tests if a
DirectionQuery is available. |
boolean |
supportsProcedureQuery()
Tests if a procedure query is available.
|
boolean |
supportsRecipeQuery()
Tests if a recipe query 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 matchRecipeId(Id recipeId, boolean match)
Id
for this query.recipeId
- a 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
terms.mandatory
- This method must be implemented. boolean supportsRecipeQuery()
true
if a recipe query is available,
false
otherwisemandatory
- This method must be implemented. RecipeQuery getRecipeQuery()
UnimplementedException
- supportsRecipeQuery()
is false
optional
- This method must be implemented if
supportsRecipeQuery()
is true.
void matchAnyRecipe(boolean match)
match
- true
to match cook books with any recipe,
false
to match cook books with no recipesmandatory
- This method must be implemented. void clearRecipeTerms()
mandatory
- This method must be implemented. void matchProcedureId(Id procedureId, boolean match)
Id
for this query to match
procedures assigned to cook books.procedureId
- a 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
terms.mandatory
- This method must be implemented. boolean supportsProcedureQuery()
true
if a procedure query is available,
false
otherwisemandatory
- This method must be implemented. ProcedureQuery getProcedureQuery()
UnimplementedException
-
supportsProcedureQuery()
is false
optional
- This method must be implemented if
supportsProcedureQuery()
is true.
void matchAnyProcedure(boolean match)
match
- true
to match cook books with any
procedure, false
to match cook books with no
proceduresmandatory
- This method must be implemented. void clearProcedureTerms()
mandatory
- This method must be implemented. void matchDirectionId(Id directionId, boolean match)
Id.
directionId
- a 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
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 cook books with any
direction, false
to match cook books with no
directionsmandatory
- This method must be implemented. void clearDirectionTerms()
mandatory
- This method must be implemented. void matchAncestorCookbookId(Id cookbookId, boolean match)
Id
for this query to match cook
books that have the specified cook book as an ancestor.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 clearAncestorCookbookIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorCookbookQuery()
CookbookQuery
is available. true
if a cook book query is available,
false
otherwisemandatory
- This method must be implemented. CookbookQuery getAncestorCookbookQuery()
OR
term.UnimplementedException
-
supportsAncestorCookbookQuery()
is false
optional
- This method must be implemented if
supportsAncestorCookbookQuery()
is true.
void matchAnyAncestorCookbook(boolean match)
match
- true
to match cook books with any
ancestor, false
to match root cook booksmandatory
- This method must be implemented. void clearAncestorCookbookTerms()
mandatory
- This method must be implemented. void matchDescendantCookbookId(Id cookbookId, boolean match)
Id
for this query to match cook
books that have the specified cook book as a descendant.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 clearDescendantCookbookIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantCookbookQuery()
CookbookQuery
is available. true
if a cook book query is available,
false
otherwisemandatory
- This method must be implemented. CookbookQuery getDescendantCookbookQuery()
OR
term.UnimplementedException
-
supportsDescendantCookbookQuery()
is false
optional
- This method must be implemented if
supportsDescendantCookbookQuery()
is true.
void matchAnyDescendantCookbook(boolean match)
match
- true
to match cook books with any
descendant, false
to match leaf cook booksmandatory
- This method must be implemented. void clearDescendantCookbookTerms()
mandatory
- This method must be implemented. CookbookQueryRecord getCookbookQueryRecord(Type cookbookRecordType) throws OperationFailedException
Cookbook
record Type.
Multiple record retrievals produce
a nested boolean OR
term.cookbookRecordType
- a cook book record typeNullArgumentException
- cookbookRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(cookbookRecordType)
is false
mandatory
- This method must be implemented.