com.opensymphony.workflow
Interface Validator

All Known Implementing Classes:
BeanShellValidator, BSFValidator, JNDIValidator, LocalEJBValidator, RemoteEJBValidator, WebWorkValidator

public interface Validator

Interface that must be implemented to define a java-based validator in your workflow definition.

Author:
Patrick Lightbody

Method Summary
 void validate(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
          Validates the user input.
 

Method Detail

validate

void validate(Map transientVars,
              Map args,
              com.opensymphony.module.propertyset.PropertySet ps)
              throws InvalidInputException,
                     WorkflowException
Validates the user input.

Parameters:
transientVars - Variables that will not be persisted. These include inputs given in the Workflow.initialize(java.lang.String, int, java.util.Map) and Workflow.doAction(long, int, java.util.Map) method calls. There are a number of special variable names:
  • entry: (object type: WorkflowEntry) The workflow instance
  • context: (object type: WorkflowContext). The workflow context.
  • actionId: The Integer ID of the current action that was take (if applicable).
  • currentSteps: A Collection of the current steps in the workflow instance.
  • store: The WorkflowStore.
  • descriptor: The WorkflowDescriptor.
Also, any variable set as a Register), will also be available in the transient map. These transient variables only last through the method call that they were invoked in, such as Workflow.initialize(java.lang.String, int, java.util.Map) and Workflow.doAction(long, int, java.util.Map).
args - The properties for this function invocation. Properties are created from arg nested elements within the xml, an arg element takes in a name attribute which is the properties key, and the CDATA text contents of the element map to the property value.
ps - The persistent variables that are associated with the current instance of the workflow. Any change made to the propertyset are persisted to the propertyset implementation's persistent store.
Throws:
InvalidInputException - if the input is deemed to be invalid
WorkflowException

OpenSymphony Workflow Project Page