org.osid.recipe.batch

Interface RecipeBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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 Summary

Methods

Modifier and Type	Method and Description
CookbookBatchAdminSession	getCookbookBatchAdminSession() Gets the OsidSession associated with the bulk cookbook administration service.
DirectionBatchAdminSession	getDirectionBatchAdminSession() Gets the OsidSession associated with the bulk direction administration service.
DirectionBatchAdminSession	getDirectionBatchAdminSessionForCookbook(Id cookbookId) Gets the OsidSession associated with the bulk direction administration service for the given cookbook.
ProcedureBatchAdminSession	getProcedureBatchAdminSession() Gets the OsidSession associated with the bulk procedure administration service.
ProcedureBatchAdminSession	getProcedureBatchAdminSessionForCookbook(Id cookbookId) Gets the OsidSession associated with the bulk procedure administration service for the given cookbook.
RecipeBatchAdminSession	getRecipeBatchAdminSession() Gets the OsidSession associated with the bulk recipe administration service.
RecipeBatchAdminSession	getRecipeBatchAdminSessionForCookbook(Id cookbookId) Gets the OsidSession associated with the bulk recipe administration service for the given cookbook.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.recipe.batch.RecipeBatchProfile

supportsCookbookBatchAdmin, supportsDirectionBatchAdmin, supportsProcedureBatchAdmin, supportsRecipeBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsRecipeBatchAdmin() is 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 supportsRecipeBatchAdmin() and supportsVisibleFederation() are 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 supportsDirectionBatchAdmin() is 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 supportsDirectionBatchAdmin() and supportsVisibleFederation() are 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 supportsProcedureBatchAdmin() is 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 supportsProcedureBatchAdmin() and supportsVisibleFederation() are 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 supportsCookbookBatchAdmin() is true.