View Javadoc

1   package com.explosion.expfmodules.wizard;
2   
3   
4   /* =============================================================================
5    *       
6    *     Copyright 2004 Stephen Cowx
7    *
8    *     Licensed under the Apache License, Version 2.0 (the "License");
9    *     you may not use this file except in compliance with the License.
10   *     You may obtain a copy of the License at
11   *
12   *     http://www.apache.org/licenses/LICENSE-2.0
13   *
14   *     Unless required by applicable law or agreed to in writing, software
15   *     distributed under the License is distributed on an "AS IS" BASIS,
16   *     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17   *     See the License for the specific language governing permissions and
18   *     limitations under the License.
19   * 
20   * =============================================================================
21   */
22  
23  /***
24   * Created on 01-Dec-2004
25   * Classes which implement this interface are probably going to pretty complex.  The
26   * implementors of this class get called once at the end of every wizard.
27   * 
28   * Each wizard that does anything will have this action performed by an implementor of this class.
29   * 
30   * The wizard collects information during it's lifetime and then at the end, as soon as the finish() 
31   * method on the Wizard is called, the StepAction execute method is envoked.  
32   * 
33   * @author Stephen Cowx
34   */
35  public interface StepAction
36  {
37  
38  	/***
39  	 * Implementors of this method will use the information collected during the execution of the wizard
40  	 * to perform an action.  If actions wants the user to redo the existing step, they should return false
41  	 * @param wizard
42  	 */
43      public boolean execute(Wizard wizard);
44  
45  }