View Javadoc

1   /*
2    *  Copyright 1999-2004 The Apache Software Foundation.
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *  http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  package org.apache.struts.flow.core;
17  
18  import org.mozilla.javascript.Scriptable;
19  import org.apache.struts.flow.core.javascript.fom.FOM_Flow;
20  
21  /***
22   *  Defines a variable registrar used to define either a static or 
23   *  call-specific variable in the global scope.  Static variables are defined
24   *  once per global scope, while call-specific variables can define instances
25   *  of themselves for every script call.
26   */
27  public interface FlowVariableFactory {
28  
29      /***
30       *  Gets an instance of the variable
31       *
32       * @param scope The scope the variable will be placed in
33       * @param ctx The commons chain context for the call, null if defining
34       *            a static variable
35       */
36      public Object getInstance(Scriptable scope, FOM_Flow flow);
37  
38  }
39