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 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. |
changeBranch, initialize, rollbackService
close
supportsCookbookBatchAdmin, supportsDirectionBatchAdmin, supportsProcedureBatchAdmin, supportsRecipeBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
RecipeBatchAdminSession getRecipeBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk recipe
administration service. RecipeBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRecipeBatchAdmin()
is false
optional
- This method must be implemented if
supportsRecipeBatchAdmin()
is true.
RecipeBatchAdminSession getRecipeBatchAdminSessionForCookbook(Id cookbookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk recipe
administration service for the given cookbook.cookbookId
- the Id
of the Cookbook
RecipeBatchAdminSession
NotFoundException
- no Cookbook
found by
the given Id
NullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRecipeBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRecipeBatchAdmin()
and
supportsVisibleFederation()
are true
DirectionBatchAdminSession getDirectionBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk direction
administration service. DirectionBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionBatchAdmin()
is false
optional
- This method must be implemented if
supportsDirectionBatchAdmin()
is true.
DirectionBatchAdminSession getDirectionBatchAdminSessionForCookbook(Id cookbookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk direction
administration service for the given cookbook.cookbookId
- the Id
of the Cookbook
DirectionBatchAdminSession
NotFoundException
- no Cookbook
found by
the given Id
NullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDirectionBatchAdmin()
and
supportsVisibleFederation()
are true
ProcedureBatchAdminSession getProcedureBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk procedure
administration service. ProcedureBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureBatchAdmin()
is false
optional
- This method must be implemented if
supportsProcedureBatchAdmin()
is true.
ProcedureBatchAdminSession getProcedureBatchAdminSessionForCookbook(Id cookbookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk procedure
administration service for the given cookbook.cookbookId
- the Id
of the Cookbook
ProcedureBatchAdminSession
NotFoundException
- no Cookbook
found by
the given Id
NullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcedureBatchAdmin()
and
supportsVisibleFederation()
are true
CookbookBatchAdminSession getCookbookBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk cookbook
administration service. CookbookBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCookbookBatchAdmin()
is false
optional
- This method must be implemented if
supportsCookbookBatchAdmin()
is true.