org.osid.workflow.batch

Interface ProcessBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, ProcessAdminSession

public interface ProcessBatchAdminSession
extends ProcessAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasProcesses(AliasRequestList aliasRequests) Adds an Id to a Process for the purpose of creating compatibility.
CreateResponseList	createProcesses(ProcessBatchFormList processForms) Creates a new set of Processes.
DeleteResponseList	deleteAllProcesses() Deletes all Processes in this Office .
DeleteResponseList	deleteProcesses(IdList processIds) Deletes processes for the given Ids.
ProcessBatchFormList	getProcessFormsForCreate(long number, Type[] processRecordTypes) Gets the process forms for creating a bunch of new processes.
ProcessBatchFormList	getProcessFormsForUpdate(IdList processIds) Gets the process forms for updating an existing set of processes.
UpdateResponseList	updateProcesses(ProcessBatchFormList processForms) Updates existing processes.

Methods inherited from interface org.osid.workflow.ProcessAdminSession

addCompetency, aliasProcess, canAssignCompetencies, canCreateProcesses, canCreateProcessWithRecordTypes, canDeleteProcesses, canManageProcessAliases, canUpdateProcesses, createProcess, deleteProcess, getOffice, getOfficeId, getProcessFormForCreate, getProcessFormForUpdate, removeCompetencies, removeCompetency, updateProcess

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

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

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getProcessFormsForCreate

ProcessBatchFormList getProcessFormsForCreate(long number,
                                            Type[] processRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

processRecordTypes - array of process record types to be included in each create operation or an empty list if none

Returns:

the process forms

Throws:

NullArgumentException - processRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createProcesses

CreateResponseList createProcesses(ProcessBatchFormList processForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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 .

Parameters:

processForms - the process forms

Returns:

the create responses

Throws:

NullArgumentException - processForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProcessFormsForUpdate

ProcessBatchFormList getProcessFormsForUpdate(IdList processIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

processIds - the Ids of the Process

Returns:

the process form

Throws:

NotFoundException - a processId is not found

NullArgumentException - processIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateProcesses

UpdateResponseList updateProcesses(ProcessBatchFormList processForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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 .

Parameters:

processForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - processForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllProcesses

DeleteResponseList deleteAllProcesses()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes all Processes in this Office .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProcesses

DeleteResponseList deleteProcesses(IdList processIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes processes for the given Ids.

Parameters:

processIds - the Ids of the processes to delete

Returns:

the delete responses

Throws:

NullArgumentException - processIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasProcesses

AliasResponseList aliasProcesses(AliasRequestList aliasRequests)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.