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 cookbooks. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • 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 {@code supportsRecipeQuery()} is {@code true} .

    • matchAnyRecipe

      void matchAnyRecipe(boolean match)
      Matches cookbooks with any recipe.
      Parameters:
      match - true to match cookbooks with any recipe, false to match cookbooks 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 cookbooks.
      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 a procedure.
      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 cookbooks with any procedure.
      Parameters:
      match - true to match cookbooks with any procedure, false to match cookbooks 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 {@code supportsDirectionQuery()} is {@code true} .

    • matchAnyDirection

      void matchAnyDirection(boolean match)
      Matches any direction.
      Parameters:
      match - true to match cookbooks with any direction, false to match cookbooks 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 cookbook Id for this query to match cookbooks that have the specified cookbook as an ancestor.
      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.

    • clearAncestorCookbookIdTerms

      void clearAncestorCookbookIdTerms()
      Clears the ancestor cookbook Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAncestorCookbookQuery

      boolean supportsAncestorCookbookQuery()
      Tests if an CookbookQuery is available.
      Returns:
      true if a cookbook 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 cookbook query
      Throws:
      UnimplementedException - supportsAncestorCookbookQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAncestorCookbookQuery()} is {@code true} .

    • matchAnyAncestorCookbook

      void matchAnyAncestorCookbook(boolean match)
      Matches cookbooks with any ancestor.
      Parameters:
      match - true to match cookbooks with any ancestor, false to match root cookbooks
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorCookbookTerms

      void clearAncestorCookbookTerms()
      Clears the ancestor cookbook terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDescendantCookbookId

      void matchDescendantCookbookId(Id cookbookId, boolean match)
      Sets the cookbook Id for this query to match cookbooks that have the specified cookbook as a descendant.
      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.

    • clearDescendantCookbookIdTerms

      void clearDescendantCookbookIdTerms()
      Clears the descendant coo book Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsDescendantCookbookQuery

      boolean supportsDescendantCookbookQuery()
      Tests if an CookbookQuery is available.
      Returns:
      true if a cookbook 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 cookbook query
      Throws:
      UnimplementedException - supportsDescendantCookbookQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDescendantCookbookQuery()} is {@code true} .

    • matchAnyDescendantCookbook

      void matchAnyDescendantCookbook(boolean match)
      Matches cookbooks with any descendant.
      Parameters:
      match - true to match cookbooks with any descendant, false to match leaf cookbooks
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantCookbookTerms

      void clearDescendantCookbookTerms()
      Clears the descendant cookbook 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 cookbook record type
      Returns:
      the cookbook query record
      Throws:
      NullArgumentException - cookbookRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(cookbookRecordType) is false
      Compliance:
      mandatory - This method must be implemented.