org.osid.workflow.batch

Interface StepBatchAdminSession

All Superinterfaces:

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

public interface StepBatchAdminSession
extends StepAdminSession

This session creates, updates, and deletes Steps 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 Step, a StepForm is requested using getStepFormsForCreate() specifying the process and desired record Types or none if no record Types are needed. Each of the returned StepForms 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 StepForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each StepForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Steps in bulk. To unmap a Step from the current Office, the StepOfficeAssignmentSession should be used. These delete operations attempt to remove the Step 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	aliasSteps(AliasRequestList aliasRequests) Adds an Id to a Step for the purpose of creating compatibility.
CreateResponseList	createSteps(StepBatchFormList stepForms) Creates a new set of Steps.
DeleteResponseList	deleteAllSteps() Deletes all Steps in this Office .
DeleteResponseList	deleteSteps(IdList stepIds) Deletes steps for the given Ids.
DeleteResponseList	deleteStepsForProcess(Id processId) Deletes all steps for the given process.
StepBatchFormList	getStepFormsForCreate(IdList processIds, Type[] stepRecordTypes) Gets the step forms for creating a bunch of new steps.
StepBatchFormList	getStepFormsForUpdate(IdList stepIds) Gets the step forms for updating an existing set of steps.
UpdateResponseList	updateSteps(StepBatchFormList stepForms) Updates existing steps.

Methods inherited from interface org.osid.workflow.StepAdminSession

aliasStep, canCreateSteps, canCreateStepWithRecordTypes, canDeleteSteps, canManageStepAliases, canUpdateSteps, createStep, deleteStep, getOffice, getOfficeId, getStepFormForCreate, getStepFormForUpdate, updateStep

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

getStepFormsForCreate

StepBatchFormList getStepFormsForCreate(IdList processIds,
                                      Type[] stepRecordTypes)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the step forms for creating a bunch of new steps. A StepForm is returned for each supplied process Id.

Parameters:

processIds - an Id of a process

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

Returns:

the step forms

Throws:

NotFoundException - a processId is not found

NullArgumentException - processId or stepRecordTypes 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.

createSteps

CreateResponseList createSteps(StepBatchFormList stepForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Parameters:

stepForms - the step forms

Returns:

the create responses

Throws:

NullArgumentException - stepForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepFormsForUpdate

StepBatchFormList getStepFormsForUpdate(IdList stepIds)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

stepIds - the Ids of the Step

Returns:

the step form

Throws:

NotFoundException - a stepId is not found

NullArgumentException - stepIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateSteps

UpdateResponseList updateSteps(StepBatchFormList stepForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Parameters:

stepForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - stepForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllSteps

DeleteResponseList deleteAllSteps()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes all Steps in this Office .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSteps

DeleteResponseList deleteSteps(IdList stepIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Deletes steps for the given Ids.

Parameters:

stepIds - the Ids of the steps to delete

Returns:

the delete responses

Throws:

NullArgumentException - stepIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteStepsForProcess

DeleteResponseList deleteStepsForProcess(Id processId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes all steps for the given process.

Parameters:

processId - an Id of a process

Returns:

the delete responses

Throws:

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasSteps

AliasResponseList aliasSteps(AliasRequestList aliasRequests)
                             throws OperationFailedException,
                                    PermissionDeniedException

Adds an Id to a Step for the purpose of creating compatibility. The primary Id of the Step is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another step, it is reassigned to the given step 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.