Interface CookbookQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface CookbookQueryInspector extends OsidCatalogQueryInspector

This is the query inspector for searching for cookbooks. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • getRecipeIdTerms

      IdTerm[] getRecipeIdTerms()
      Gets the recipe Id terms.
      Returns:
      the recipe Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getRecipeTerms

      RecipeQueryInspector[] getRecipeTerms()
      Gets the recipe terms.
      Returns:
      the recipe terms
      Compliance:
      mandatory - This method must be implemented.

    • getProcedureIdTerms

      IdTerm[] getProcedureIdTerms()
      Gets the procedure Id terms.
      Returns:
      the procedure Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getProcedureTerms

      ProcedureQueryInspector[] getProcedureTerms()
      Gets the procedure terms.
      Returns:
      the procedure terms
      Compliance:
      mandatory - This method must be implemented.

    • getDirectionIdTerms

      IdTerm[] getDirectionIdTerms()
      Gets the direction Id terms.
      Returns:
      the direction Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getDirectionTerms

      DirectionQueryInspector[] getDirectionTerms()
      Gets the direction terms.
      Returns:
      the direction terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorCookbookIdTerms

      IdTerm[] getAncestorCookbookIdTerms()
      Gets the ancestor cookbook Id terms.
      Returns:
      the ancestor cookbook Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorCookbookTerms

      CookbookQueryInspector[] getAncestorCookbookTerms()
      Gets the ancestor cookbook terms.
      Returns:
      the ancestor cookbook terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantCookbookIdTerms

      IdTerm[] getDescendantCookbookIdTerms()
      Gets the descendant cookbook Id terms.
      Returns:
      the descendant cookbook Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantCookbookTerms

      CookbookQueryInspector[] getDescendantCookbookTerms()
      Gets the descendant cookbook terms.
      Returns:
      the descendant cookbook terms
      Compliance:
      mandatory - This method must be implemented.

    • getCookbookQueryInspectorRecord

      CookbookQueryInspectorRecord getCookbookQueryInspectorRecord(Type cookbookRecordType) throws OperationFailedException
      Gets the query inspector record corresponding to the given Cookbook record Type .
      Parameters:
      cookbookRecordType - a cookbook record type
      Returns:
      the cookbook query inspector record
      Throws:
      NullArgumentException - cookbookRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(cookbookRecordType) is false
      Compliance:
      mandatory - This method must be implemented.