OSID Logo
OSID Specifications
workflow batch package
Version 3.1.0
Interfaceosid.workflow.batch.WorkflowBatchManager
Implementsosid.OsidManager
osid.workflow.batch.WorkflowBatchProfile
Used Byosid.workflow.WorkflowManager
Description

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
MethodgetProcessBatchAdminSession
Description

Gets the OsidSession associated with the bulk process administration service.

Returnosid.workflow.batch.ProcessBatchAdminSession a ProcessBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcessBatchAdmin() is false
Complianceoptional This 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.IdofficeId the Id of the Office
Returnosid.workflow.batch.ProcessBatchAdminSession a ProcessBatchAdminSession
ErrorsNOT_FOUND no Office found by the given Id
NULL_ARGUMENT officeId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcessBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProcessBatchAdmin() and supportsVisibleFederation() are true
MethodgetStepBatchAdminSession
Description

Gets the OsidSession associated with the bulk step administration service.

Returnosid.workflow.batch.StepBatchAdminSession a StepBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsStepBatchAdmin() is false
Complianceoptional This 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.IdofficeId the Id of the Office
Returnosid.workflow.batch.StepBatchAdminSession a StepBatchAdminSession
ErrorsNOT_FOUND no Office found by the given Id
NULL_ARGUMENT officeId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsStepBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsStepBatchAdmin() and supportsVisibleFederation() are true
MethodgetWorkBatchAdminSession
Description

Gets the OsidSession associated with the bulk work administration service.

Returnosid.workflow.batch.WorkBatchAdminSession a WorkBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsWorkBatchAdmin() is false
Complianceoptional This 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.IdofficeId the Id of the Office
Returnosid.workflow.batch.WorkBatchAdminSession a WorkBatchAdminSession
ErrorsNOT_FOUND no Office found by the given Id
NULL_ARGUMENT officeId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsWorkBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsWorkBatchAdmin() and supportsVisibleFederation() are true
MethodgetOfficeBatchAdminSession
Description

Gets the OsidSession associated with the bulk office administration service.

Returnosid.workflow.batch.OfficeBatchAdminSession a OfficeBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfficeBatchAdmin() is false
Complianceoptional This method must be implemented if supportsOfficeBatchAdmin() is true.