Interface RecipeBatchManager

All Superinterfaces:
AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, RecipeBatchProfile, Sourceable
public interface RecipeBatchManager extends OsidManager, RecipeBatchProfile

The recipe batch manager provides access to recipe batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • RecipeBatchAdminSession : a session to create, modify and delete Recipes in bulk
  • DirectionBatchAdminSession : a session to create, modify and delete Directions in bulk
  • ProcedureBatchAdminSession : a session to create, modify and delete Procedures in bulk
  • CookbookBatchAdminSession : a session to create, modify and delete Cookbook in bulk

  • Method Details

    • getRecipeBatchAdminSession

      RecipeBatchAdminSession getRecipeBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk recipe administration service.
      Returns:
      a RecipeBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRecipeBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRecipeBatchAdmin()} is {@code true} .

    • getRecipeBatchAdminSessionForCookbook

      RecipeBatchAdminSession getRecipeBatchAdminSessionForCookbook(Id cookbookId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk recipe administration service for the given cookbook.
      Parameters:
      cookbookId - the Id of the Cookbook
      Returns:
      a RecipeBatchAdminSession
      Throws:
      NotFoundException - no Cookbook found by the given Id
      NullArgumentException - cookbookId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRecipeBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRecipeBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getDirectionBatchAdminSession

      DirectionBatchAdminSession getDirectionBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk direction administration service.
      Returns:
      a DirectionBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDirectionBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDirectionBatchAdmin()} is {@code true} .

    • getDirectionBatchAdminSessionForCookbook

      DirectionBatchAdminSession getDirectionBatchAdminSessionForCookbook(Id cookbookId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk direction administration service for the given cookbook.
      Parameters:
      cookbookId - the Id of the Cookbook
      Returns:
      a DirectionBatchAdminSession
      Throws:
      NotFoundException - no Cookbook found by the given Id
      NullArgumentException - cookbookId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsDirectionBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDirectionBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getProcedureBatchAdminSession

      ProcedureBatchAdminSession getProcedureBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk procedure administration service.
      Returns:
      a ProcedureBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcedureBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcedureBatchAdmin()} is {@code true} .

    • getProcedureBatchAdminSessionForCookbook

      ProcedureBatchAdminSession getProcedureBatchAdminSessionForCookbook(Id cookbookId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk procedure administration service for the given cookbook.
      Parameters:
      cookbookId - the Id of the Cookbook
      Returns:
      a ProcedureBatchAdminSession
      Throws:
      NotFoundException - no Cookbook found by the given Id
      NullArgumentException - cookbookId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcedureBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcedureBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getCookbookBatchAdminSession

      CookbookBatchAdminSession getCookbookBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk cookbook administration service.
      Returns:
      a CookbookBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCookbookBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCookbookBatchAdmin()} is {@code true} .