OSID Logo
OSID Specifications
workflow batch package
Version 3.1.0
Interfaceosid.workflow.batch.ProcessBatchAdminSession
Implementsosid.workflow.ProcessAdminSession
Used Byosid.workflow.batch.WorkflowBatchManager
osid.workflow.batch.WorkflowBatchProxyManager
Description

This session creates, updates, and deletes Processes in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Process, a ProcessForm is requested using getProcessFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned ProcessForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a ProcessForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ProcessForm corresponds to an attempted transaction.

The ProcessForms returned from getProcessFormsForCreate() may be linked to the originating request through the peer Ids of the ProcessForm. In the case where there may be duplicates, any ProcessForm of the same peer Ids may be used for a create operation.

Once a batch of ProcessForms are submitted for create, a CreateResponse is returned for each ProcessForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createProcesses(), errors specific to an individual ProcessForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating ProcessForm through the ProcessForm Id.

For updates, ProcessForms are requested to the Process Id that is to be updated using getProcessFormsForUpdate() where the reference Id in the ProcessForm may be used to link the request. Similarly, the ProcessForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ProcessForm can only be used once for a successful update and cannot be reused.

Once a batch of ProcessForms are submitted for update, an UpdateResponse is returned for each ProcessForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateProcesses(), errors specific to an individual ProcessForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating ProcessForm through the ProcessForm Id.

The delete operations delete Processes in bulk. To unmap a Process from the current Office, the ProcessOfficeAssignmentSession should be used. These delete operations attempt to remove the Process itself thus removing it from all known Office catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetProcessFormsForCreate
Description

Gets the process forms for creating a bunch of new processes.

Parameterscardinalnumber the number of forms to retrieve
osid.type.Type[]processRecordTypes array of process record types to be included in each create operation or an empty list if none
Returnosid.workflow.batch.ProcessBatchFormList the process forms
ErrorsNULL_ARGUMENT processRecordTypes is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED unable to request forms with given record types
Compliancemandatory This method must be implemented.
MethodcreateProcesses
Description

Creates a new set of Processes. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse.

Parametersosid.workflow.batch.ProcessBatchFormListprocessForms the process forms
Returnosid.transaction.batch.CreateResponseList the create responses
ErrorsNULL_ARGUMENT processForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetProcessFormsForUpdate
Description

Gets the process forms for updating an existing set of processes. A new process form should be requested for each update transaction.

Parametersosid.id.IdListprocessIds the Ids of the Process
Returnosid.workflow.batch.ProcessBatchFormList the process form
ErrorsNOT_FOUND a processId is not found
NULL_ARGUMENT processIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodupdateProcesses
Description

Updates existing processes. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse.

Parametersosid.workflow.batch.ProcessBatchFormListprocessForms the form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseList the update responses
ErrorsNULL_ARGUMENT processForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteAllProcesses
Description

Deletes all Processes in this Office.

Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteProcesses
Description

Deletes processes for the given Ids.

Parametersosid.id.IdListprocessIds the Ids of the processes to delete
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT processIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodaliasProcesses
Description

Adds an Id to a Process for the purpose of creating compatibility. The primary Id of the Process is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another process, it is reassigned to the given process Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequests the alias requests
Returnosid.transaction.batch.AliasResponseList the alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.