OSID Logo
OSID Specifications
workflow batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.batch.WorkflowBatchProxyManager
Implementsosid.OsidProxyManager
osid.workflow.batch.WorkflowBatchProfile
Description

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

MethodgetProcessBatchAdminSession
Description

Gets the OsidSession associated with the bulk process administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.batch.ProcessBatchAdminSessiona ProcessBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProcessBatchAdmin() is true.
MethodgetProcessBatchAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.batch.ProcessBatchAdminSessiona ProcessBatchAdminSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessBatchAdmin() and supportsVisibleFederation() are true
MethodgetStepBatchAdminSession
Description

Gets the OsidSession associated with the bulk step administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.batch.StepBatchAdminSessiona StepBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsStepBatchAdmin() is true.
MethodgetStepBatchAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.batch.StepBatchAdminSessiona StepBatchAdminSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStepBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStepBatchAdmin() and supportsVisibleFederation() are true
MethodgetWorkBatchAdminSession
Description

Gets the OsidSession associated with the bulk work administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.batch.WorkBatchAdminSessiona WorkBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsWorkBatchAdmin() is true.
MethodgetWorkBatchAdminSessionForOffice
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.proxy.Proxyproxya proxy
Returnosid.workflow.batch.WorkBatchAdminSessiona WorkBatchAdminSession
ErrorsNOT_FOUNDno Office found by the given Id
NULL_ARGUMENT officeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkBatchAdmin() and supportsVisibleFederation() are true
MethodgetOfficeBatchAdminSession
Description

Gets the OsidSession associated with the bulk office administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.workflow.batch.OfficeBatchAdminSessiona OfficeBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOfficeBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsOfficeBatchAdmin() is true.