Package oracle.bpel.services.workflow.task

Interface ITaskValidationCallback

public interface ITaskValidationCallback

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ITaskValidationCallback.TaskAction	Enumeration of the possible actions that can be validated.

Method Summary

Modifier and Type	Method	Description
void	validateTaskOperation(ITaskValidationCallback.TaskAction action, IWorkflowContext ctx, Task task, Map<String,Object> parameters, Locale locale, List<String> errors)	This method prior to performing an operation on a Task.

Method Details

validateTaskOperation

void validateTaskOperation(ITaskValidationCallback.TaskAction action,
 IWorkflowContext ctx,
 Task task,
 Map<String,Object> parameters,
 Locale locale,
 List<String> errors)

This method prior to performing an operation on a Task. The type of operation that is to be performed is indicated by the action parameter.

The current state of the task is passed to the task, together with a Map of the parameters passed to the TaskService operation being validated

.

If the method determines that the action cannot be performed, the reason(s) for failing validation should be added to the errors List parameter. The values added to this list should be concise descriptions of the reason for validation failure, and should be appropriate for the Locale specified in the locale parameter.

Note that it is possible to configure multiple validation classes for a given Task, so the errors parameter may not be empty when this method is invoked.

If after invoking validation callbacks, the TaskService finds the errors List is not empty, it will throw abort the operation by throwing a WorkflowException. The exception's error message will include all entries in the errors List.

Parameters:

action - the type of operation being performed.

ctx - context information about the user performing the operation. Note that this parameter will be null in the case of INITIATE and REINITIATE actions.

task - the Task being operated on.

parameters - a Map of additional parameters supplied for the operation, keyed by parameter name.

locale - the Locale to use when supplying validation error messages.

errors - a List of validation error messages. If another callback implementation has found validation errors this list will already be populated. Any validation errors found by this callback implementation should be added to the list.