Interface RecipeBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, RecipeBatchProfile, Sourceable

public interface RecipeBatchProxyManager
extends OsidProxyManager, RecipeBatchProfile

The recipe batch proxy manager provides access to recipe batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• RecipeBatchAdminSession: a session to manage recipes in bulk
• DirectionBatchAdminSession: a session to manage directiond in bulk
• ProcedureBatchAdminSession: a session to manage procedures in bulk
• CookbookBatchAdminSession: a session to create, modify and delete Cookbook in bulk

RecipeBatchProxyManager may be accessed by multiple processing threads.

Method Summary

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

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

Methods inherited from interface OsidProxyManager

close

Methods inherited from interface OsidProxyManager

changeBranch, getProxy, getProxyCondition, initialize, rollbackService

Methods inherited from interface RecipeBatchProfile

supportsCookbookBatchAdmin, supportsDirectionBatchAdmin, supportsProcedureBatchAdmin, supportsRecipeBatchAdmin, supportsVisibleFederation

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details

getRecipeBatchAdminSession

RecipeBatchAdminSession getRecipeBatchAdminSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the bulk recipe administration service.

Parameters:

proxy - a proxy

Returns:

a RecipeBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk recipe administration service for the given cookbook.

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a RecipeBatchAdminSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId or proxy 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(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk direction administration service.

Parameters:

proxy - a proxy

Returns:

a DirectionBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk direction administration service for the given cookbook.

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a DirectionBatchAdminSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId or proxy 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(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk procedure administration service.

Parameters:

proxy - a proxy

Returns:

a ProcedureBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk procedure administration service for the given cookbook.

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a ProcedureBatchAdminSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId or proxy 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(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk cookbook administration service.

Parameters:

proxy - a proxy

Returns:

a CookbookBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCookbookBatchAdmin()} is {@code true}.