Interface RecipeProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
RecipeManager, RecipeProxyManager
public interface RecipeProfile extends OsidProfile

The recipe profile describes the interoperability among recipe services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any cookbook federation is exposed. Federation is exposed when a specific cookbook may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of cookbooks appears as a single cookbook.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRecipeLookup

      boolean supportsRecipeLookup()
      Tests if looking up recipes is supported.
      Returns:
      true if recipe lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRecipeQuery

      boolean supportsRecipeQuery()
      Tests if querying recipes is supported.
      Returns:
      true if recipe query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRecipeSearch

      boolean supportsRecipeSearch()
      Tests if searching recipes is supported.
      Returns:
      true if recipe search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRecipeAdmin

      boolean supportsRecipeAdmin()
      Tests if recipe administrative service is supported.
      Returns:
      true if recipe administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRecipeNotification

      boolean supportsRecipeNotification()
      Tests if a recipe notification service is supported.
      Returns:
      true if recipe notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRecipeCookbook

      boolean supportsRecipeCookbook()
      Tests if a recipe cookbook lookup service is supported.
      Returns:
      true if a recipe cookbook lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRecipeCookbookAssignment

      boolean supportsRecipeCookbookAssignment()
      Tests if a recipe cookbook service is supported.
      Returns:
      true if recipe to cookbook assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRecipeSmartCookbook

      boolean supportsRecipeSmartCookbook()
      Tests if a recipe smart cookbook lookup service is supported.
      Returns:
      true if a recipe smart cookbook service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectionLookup

      boolean supportsDirectionLookup()
      Tests if looking up directions is supported.
      Returns:
      true if direction lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectionQuery

      boolean supportsDirectionQuery()
      Tests if querying directions is supported.
      Returns:
      true if direction query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectionSearch

      boolean supportsDirectionSearch()
      Tests if searching directions is supported.
      Returns:
      true if direction search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectionAdmin

      boolean supportsDirectionAdmin()
      Tests if direction administrative service is supported.
      Returns:
      true if direction administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectionNotification

      boolean supportsDirectionNotification()
      Tests if a direction notification service is supported.
      Returns:
      true if direction notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectionCookbook

      boolean supportsDirectionCookbook()
      Tests if a direction cookbook lookup service is supported.
      Returns:
      true if a direction cookbook lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectionCookbookAssignment

      boolean supportsDirectionCookbookAssignment()
      Tests if a direction cookbook assignment service is supported.
      Returns:
      true if a direction to cookbook assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectionSmartCookbook

      boolean supportsDirectionSmartCookbook()
      Tests if a direction smart cookbook service is supported.
      Returns:
      true if a direction smart cookbook service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcedureLookup

      boolean supportsProcedureLookup()
      Tests for the availability of a procedure lookup service.
      Returns:
      true if procedure lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcedureQuery

      boolean supportsProcedureQuery()
      Tests if querying procedures is available.
      Returns:
      true if procedure query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcedureSearch

      boolean supportsProcedureSearch()
      Tests if searching for procedures is available.
      Returns:
      true if procedure search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcedureAdmin

      boolean supportsProcedureAdmin()
      Tests if searching for procedures is available.
      Returns:
      true if procedure search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcedureNotification

      boolean supportsProcedureNotification()
      Tests if procedure notification is available.
      Returns:
      true if procedure notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcedureCookbook

      boolean supportsProcedureCookbook()
      Tests if a procedure to cookbook lookup session is available.
      Returns:
      true if procedure cookbook lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcedureCookbookAssignment

      boolean supportsProcedureCookbookAssignment()
      Tests if a procedure to cookbook assignment session is available.
      Returns:
      true if procedure cookbook assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcedureSmartCookbook

      boolean supportsProcedureSmartCookbook()
      Tests if a procedure smart cookbook session is available.
      Returns:
      true if procedure smart cookbook is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCookbookLookup

      boolean supportsCookbookLookup()
      Tests for the availability of a cookbook lookup service.
      Returns:
      true if cookbook lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCookbookQuery

      boolean supportsCookbookQuery()
      Tests if querying cookbooks is available.
      Returns:
      true if cookbook query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCookbookSearch

      boolean supportsCookbookSearch()
      Tests if searching for cookbooks is available.
      Returns:
      true if cookbook search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCookbookAdmin

      boolean supportsCookbookAdmin()
      Tests for the availability of a cookbook administrative service for creating and deleting cookbooks.
      Returns:
      true if cookbook administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCookbookNotification

      boolean supportsCookbookNotification()
      Tests for the availability of a cookbook notification service.
      Returns:
      true if cookbook notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsCookbookHierarchy

      boolean supportsCookbookHierarchy()
      Tests for the availability of a cookbook hierarchy traversal service.
      Returns:
      true if cookbook hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCookbookHierarchyDesign

      boolean supportsCookbookHierarchyDesign()
      Tests for the availability of a cookbook hierarchy design service.
      Returns:
      true if cookbook hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsRecipeBatch

      boolean supportsRecipeBatch()
      Tests for the availability of a batch recipe service.
      Returns:
      true if a batch recipe service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • getRecipeRecordTypes

      TypeList getRecipeRecordTypes()
      Gets the supported Recipe record types.
      Returns:
      a list containing the supported Recipe record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRecipeRecordType

      boolean supportsRecipeRecordType(Type recipeRecordType)
      Tests if the given Recipe record type is supported.
      Parameters:
      recipeRecordType - a Type indicating an Recipe record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - recipeRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getRecipeSearchRecordTypes

      TypeList getRecipeSearchRecordTypes()
      Gets the supported Recipe search record types.
      Returns:
      a list containing the supported Recipe search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRecipeSearchRecordType

      boolean supportsRecipeSearchRecordType(Type recipeSearchRecordType)
      Tests if the given Recipe search record type is supported.
      Parameters:
      recipeSearchRecordType - a Type indicating an Recipe search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - recipeSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getDirectionRecordTypes

      TypeList getDirectionRecordTypes()
      Gets the supported Direction record types.
      Returns:
      a list containing the supported Direction record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectionRecordType

      boolean supportsDirectionRecordType(Type directionRecordType)
      Tests if the given Direction record type is supported.
      Parameters:
      directionRecordType - a Type indicating a Direction record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - directionRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getDirectionSearchRecordTypes

      TypeList getDirectionSearchRecordTypes()
      Gets the supported Direction search types.
      Returns:
      a list containing the supported Direction search types
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectionSearchRecordType

      boolean supportsDirectionSearchRecordType(Type directionSearchRecordType)
      Tests if the given Direction search type is supported.
      Parameters:
      directionSearchRecordType - a Type indicating a Direction search type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - directionSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getIngredientRecordTypes

      TypeList getIngredientRecordTypes()
      Gets the supported Ingredient record types.
      Returns:
      a list containing the supported Ingredient record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsIngredientRecordType

      boolean supportsIngredientRecordType(Type ingredientRecordType)
      Tests if the given Ingredient record type is supported.
      Parameters:
      ingredientRecordType - a Type indicating an Ingredient record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - ingredientRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getProcedureRecordTypes

      TypeList getProcedureRecordTypes()
      Gets the supported Procedure record types.
      Returns:
      a list containing the supported procedure record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcedureRecordType

      boolean supportsProcedureRecordType(Type procedureRecordType)
      Tests if the given Procedure record type is supported.
      Parameters:
      procedureRecordType - a Type indicating a Procedure record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - procedureRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getProcedureSearchRecordTypes

      TypeList getProcedureSearchRecordTypes()
      Gets the supported procedure search record types.
      Returns:
      a list containing the supported procedure search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcedureSearchRecordType

      boolean supportsProcedureSearchRecordType(Type procedureSearchRecordType)
      Tests if the given procedure search record type is supported.
      Parameters:
      procedureSearchRecordType - a Type indicating a procedure record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - procedureSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getCookbookRecordTypes

      TypeList getCookbookRecordTypes()
      Gets the supported cookbook record types.
      Returns:
      a list containing the supported cookbook record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCookbookRecordType

      boolean supportsCookbookRecordType(Type cookbookRecordType)
      Tests if the given cookbook record type is supported.
      Parameters:
      cookbookRecordType - a Type indicating a cookbook record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - cookbookRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getCookbookSearchRecordTypes

      TypeList getCookbookSearchRecordTypes()
      Gets the supported cookbook search record types.
      Returns:
      a list containing the supported cookbook search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCookbookSearchRecordType

      boolean supportsCookbookSearchRecordType(Type cookbookSearchRecordType)
      Tests if the given cookbook search record type is supported.
      Parameters:
      cookbookSearchRecordType - a Type indicating a cookbook record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - cookbookSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.