org.osid.workflow.batch

Interface WorkflowBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable, WorkflowBatchProfile

public interface WorkflowBatchProxyManager
extends OsidProxyManager, WorkflowBatchProfile

The workflow batch proxy manager provides access to workflow 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:

• ProcessBatchAdminSession: a session to manage processes in bulk
• StepBatchAdminSession: a session to manage steps in bulk
• WorkBatchAdminSession: a session to manage workd in bulk
• OfficeBatchAdminSession: a session to create, modify and delete Offices in bulk

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

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

Gets the OsidSession associated with the bulk process administration service.

Parameters:

proxy - a proxy

Returns:

a ProcessBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a ProcessBatchAdminSession

Throws:

NotFoundException - no Office found by the given Id

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

Gets the OsidSession associated with the bulk step administration service.

Parameters:

proxy - a proxy

Returns:

a StepBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a StepBatchAdminSession

Throws:

NotFoundException - no Office found by the given Id

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

Gets the OsidSession associated with the bulk work administration service.

Parameters:

proxy - a proxy

Returns:

a WorkBatchAdminSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

officeId - the Id of the Office

proxy - a proxy

Returns:

a WorkBatchAdminSession

Throws:

NotFoundException - no Office found by the given Id

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

Gets the OsidSession associated with the bulk office administration service.

Parameters:

proxy - a proxy

Returns:

a OfficeBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsOfficeBatchAdmin() is true.