org.osid.workflow.batch

Interface WorkflowBatchManager

All Superinterfaces:

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

Methods

Modifier and Type	Method and 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 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.workflow.batch.WorkflowBatchProfile

supportsOfficeBatchAdmin, supportsProcessBatchAdmin, supportsStepBatchAdmin, supportsVisibleFederation, supportsWorkBatchAdmin

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

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 supportsProcessBatchAdmin() is 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 supportsProcessBatchAdmin() and supportsVisibleFederation() are 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 supportsStepBatchAdmin() is 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 supportsStepBatchAdmin() and supportsVisibleFederation() are 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 supportsWorkBatchAdmin() is 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 supportsWorkBatchAdmin() and supportsVisibleFederation() are 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 supportsOfficeBatchAdmin() is true.