Interface WorkflowBatchManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, WorkflowBatchProfile

public interface WorkflowBatchManager
extends OsidManager, WorkflowBatchProfile

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

• ProcessBatchAdminSession : a session to create, modify and delete Processes in bulk
• StepBatchAdminSession : a session to create, modify and delete Steps in bulk
• WorkBatchAdminSession : a session to create, modify and delete Works in bulk
• OfficeBatchAdminSession : a session to create, modify and delete Offices in bulk

Method Summary

Modifier and Type	Method	Description
OfficeBatchAdminSession	getOfficeBatchAdminSession()	Gets the OsidSession associated with the bulk office administration service.
ProcessBatchAdminSession	getProcessBatchAdminSession()	Gets the OsidSession associated with the bulk process administration service.
ProcessBatchAdminSession	getProcessBatchAdminSessionForOffice(Id officeId)	Gets the OsidSession associated with the bulk process administration service for the given office.
StepBatchAdminSession	getStepBatchAdminSession()	Gets the OsidSession associated with the bulk step administration service.
StepBatchAdminSession	getStepBatchAdminSessionForOffice(Id officeId)	Gets the OsidSession associated with the bulk step administration service for the given office.
WorkBatchAdminSession	getWorkBatchAdminSession()	Gets the OsidSession associated with the bulk work administration service.
WorkBatchAdminSession	getWorkBatchAdminSessionForOffice(Id officeId)	Gets the OsidSession associated with the bulk work administration service for the given office.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

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

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

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

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

Methods inherited from interface WorkflowBatchProfile

supportsOfficeBatchAdmin, supportsProcessBatchAdmin, supportsStepBatchAdmin, supportsVisibleFederation, supportsWorkBatchAdmin

Modifier and Type	Method	Description
boolean	supportsOfficeBatchAdmin()	Tests if bulk administration of offices is available.
boolean	supportsProcessBatchAdmin()	Tests if bulk administration of processes is available.
boolean	supportsStepBatchAdmin()	Tests if bulk administration of steps is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.
boolean	supportsWorkBatchAdmin()	Tests if bulk administration of works is available.

Method Details

getProcessBatchAdminSession

ProcessBatchAdminSession getProcessBatchAdminSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the bulk process administration service.

Returns:

a ProcessBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessBatchAdmin() is false

Compliance:

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

getProcessBatchAdminSessionForOffice

ProcessBatchAdminSession getProcessBatchAdminSessionForOffice(Id officeId)
                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk process administration service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a ProcessBatchAdminSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getStepBatchAdminSession

StepBatchAdminSession getStepBatchAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the bulk step administration service.

Returns:

a StepBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStepBatchAdmin() is false

Compliance:

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

getStepBatchAdminSessionForOffice

StepBatchAdminSession getStepBatchAdminSessionForOffice(Id officeId)
                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk step administration service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a StepBatchAdminSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getWorkBatchAdminSession

WorkBatchAdminSession getWorkBatchAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the bulk work administration service.

Returns:

a WorkBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkBatchAdmin() is false

Compliance:

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

getWorkBatchAdminSessionForOffice

WorkBatchAdminSession getWorkBatchAdminSessionForOffice(Id officeId)
                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk work administration service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a WorkBatchAdminSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getOfficeBatchAdminSession

OfficeBatchAdminSession getOfficeBatchAdminSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the bulk office administration service.

Returns:

a OfficeBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeBatchAdmin() is false

Compliance:

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