org.osid.recipe

Interface CookbookQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchRecipeId

void matchRecipeId(Id recipeId,
                 boolean match)

Sets the recipe Id for this query.

Parameters:

recipeId - a 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 terms.

Compliance:

mandatory - This method must be implemented.

supportsRecipeQuery

boolean supportsRecipeQuery()

Tests if a recipe query 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.

Returns:

the recipe query

Throws:

UnimplementedException - supportsRecipeQuery() is false

Compliance:

optional - This method must be implemented if supportsRecipeQuery() is true.

matchAnyRecipe

void matchAnyRecipe(boolean match)

Matches cook books with any recipe.

Parameters:

match - true to match cook books with any recipe, false to match cook books with no recipes

Compliance:

mandatory - This method must be implemented.

clearRecipeTerms

void clearRecipeTerms()

Clears the procedure terms.

Compliance:

mandatory - This method must be implemented.

matchProcedureId

void matchProcedureId(Id procedureId,
                    boolean match)

Sets the procedure Id for this query to match procedures assigned to cook books.

Parameters:

procedureId - a 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 terms.

Compliance:

mandatory - This method must be implemented.

supportsProcedureQuery

boolean supportsProcedureQuery()

Tests if a procedure query 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 an procedure.

Returns:

the procedure query

Throws:

UnimplementedException - supportsProcedureQuery() is false

Compliance:

optional - This method must be implemented if supportsProcedureQuery() is true.

matchAnyProcedure

void matchAnyProcedure(boolean match)

Matches cook books with any procedure.

Parameters:

match - true to match cook books with any procedure, false to match cook books with no procedures

Compliance:

mandatory - This method must be implemented.

clearProcedureTerms

void clearProcedureTerms()

Clears the procedure terms.

Compliance:

mandatory - This method must be implemented.

matchDirectionId

void matchDirectionId(Id directionId,
                    boolean match)

Sets a direction Id.

Parameters:

directionId - a direction Id

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

Throws:

NullArgumentException - directionId is null

Compliance:

mandatory - This method must be implemented.

clearDirectionIdTerms

void clearDirectionIdTerms()

Clears the direction Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDirectionQuery

boolean supportsDirectionQuery()

Tests if a DirectionQuery is available.

Returns:

true if a direction query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDirectionQuery

DirectionQuery getDirectionQuery()

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

Returns:

the direction query

Throws:

UnimplementedException - supportsDirectionQuery() is false

Compliance:

optional - This method must be implemented if supportsDirectionQuery() is true.

matchAnyDirection

void matchAnyDirection(boolean match)

Matches any direction.

Parameters:

match - true to match cook books with any direction, false to match cook books with no directions

Compliance:

mandatory - This method must be implemented.

clearDirectionTerms

void clearDirectionTerms()

Clears the direction terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorCookbookId

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.

Parameters:

cookbookId - a cook book Id

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

Throws:

NullArgumentException - cookbookId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorCookbookIdTerms

void clearAncestorCookbookIdTerms()

Clears the ancestor cook book Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorCookbookQuery

boolean supportsAncestorCookbookQuery()

Tests if an CookbookQuery is available.

Returns:

true if a cook book query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorCookbookQuery

CookbookQuery getAncestorCookbookQuery()

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

Returns:

the cook book query

Throws:

UnimplementedException - supportsAncestorCookbookQuery() is false

Compliance:

optional - This method must be implemented if supportsAncestorCookbookQuery() is true.

matchAnyAncestorCookbook

void matchAnyAncestorCookbook(boolean match)

Matches cook books with any ancestor.

Parameters:

match - true to match cook books with any ancestor, false to match root cook books

Compliance:

mandatory - This method must be implemented.

clearAncestorCookbookTerms

void clearAncestorCookbookTerms()

Clears the ancestor cook book terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantCookbookId

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.

Parameters:

cookbookId - a cook book Id

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

Throws:

NullArgumentException - cookbookId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantCookbookIdTerms

void clearDescendantCookbookIdTerms()

Clears the descendant cook book Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantCookbookQuery

boolean supportsDescendantCookbookQuery()

Tests if an CookbookQuery is available.

Returns:

true if a cook book query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantCookbookQuery

CookbookQuery getDescendantCookbookQuery()

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

Returns:

the cook book query

Throws:

UnimplementedException - supportsDescendantCookbookQuery() is false

Compliance:

optional - This method must be implemented if supportsDescendantCookbookQuery() is true.

matchAnyDescendantCookbook

void matchAnyDescendantCookbook(boolean match)

Matches cook books with any descendant.

Parameters:

match - true to match cook books with any descendant, false to match leaf cook books

Compliance:

mandatory - This method must be implemented.

clearDescendantCookbookTerms

void clearDescendantCookbookTerms()

Clears the descendant cook book terms.

Compliance:

mandatory - This method must be implemented.

getCookbookQueryRecord

CookbookQueryRecord getCookbookQueryRecord(Type cookbookRecordType)
                                           throws OperationFailedException

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

Parameters:

cookbookRecordType - a cook book record type

Returns:

the cook book query record

Throws:

NullArgumentException - cookbookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cookbookRecordType) is false

Compliance:

mandatory - This method must be implemented.