ValidatorRemote


1   /*
2    * Copyright (c) 2002-2003 by OpenSymphony
3    * All rights reserved.
4    */
5   package com.opensymphony.workflow;
6   
7   import com.opensymphony.module.propertyset.PropertySet;
8   
9   import java.rmi.Remote  ;
10  import java.rmi.RemoteException  ;
11  
12  import java.util.Map  ;
13  
14  
15  /**
16   * Remote interface that must be implemented to define a java-based validator in your workflow definition.
17   *
18   * @author <a HREF="mailto:plightbo@hotmail.com">Patrick Lightbody</a>
19   * @version $Revision: 1.4 $
20   */
21  public interface ValidatorRemote extends Remote   {
22      //~ Methods ////////////////////////////////////////////////////////////////
23  
24      /**
25       * Validates the user input.
26       *
27       * @param transientVars Variables that will not be persisted. These include inputs
28       * given in the {@link Workflow#initialize} and {@link Workflow#doAction} method calls.
29       * There are two special variable names: <b>entry</b> (object type:
30       * {@link com.opensymphony.workflow.spi.WorkflowEntry}) and <b>context</b>
31       * (object type: {@link com.opensymphony.workflow.WorkflowContext}).
32       * Also, any variable set as a {@link com.opensymphony.workflow.Register}), will also be
33       * available in the transient map, no matter what. These transient variables only last through
34       * the method call that they were invoked in, such as {@link Workflow#initialize}
35       * and {@link Workflow#doAction}.
36       * @param args The properties for this function invocation. Properties are created
37       * from arg nested elements within the xml, an arg element takes in a name attribute
38       * which is the properties key, and the CDATA text contents of the element map to
39       * the property value.
40       * @param ps The persistent variables that are associated with the current
41       * instance of the workflow. Any change made to the propertyset are persisted to
42       * the propertyset implementation's persistent store.
43       * @throws InvalidInputException if the input is deemed to be invalid
44       */
45      public void validate(Map   transientVars, Map   args, PropertySet ps) throws InvalidInputException, RemoteException  ;
46  }
47
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags