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

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, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface RecipeBatchProfile

supportsCookbookBatchAdmin, supportsDirectionBatchAdmin, supportsProcedureBatchAdmin, supportsRecipeBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsCookbookBatchAdmin()	Tests if bulk administration of cookbook is available.
boolean	supportsDirectionBatchAdmin()	Tests if bulk administration of directions is available.
boolean	supportsProcedureBatchAdmin()	Tests if bulk administration of procedures is available.
boolean	supportsRecipeBatchAdmin()	Tests if bulk administration of recipes is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

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} .