2009/05/20 - Apache Shale has been retired.

For more information, please explore the Attic.


1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to you under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.shale.dialog.basic.model;
19  
20  /***
21   * <p>An {@link ActionState} represents the execution of an action method
22   * (typically delegating behavior to appropriate business logic).  The
23   * actual method must be a public method that returns a String and takes
24   * no arguments, and is represented by a JavaServer Faces method binding
25   * expression.  Note that this method signature is identical to the definition
26   * of an "action" method as used in the JavaServer Faces
27   * <code>ActionSource</code> APIs.</p>
28   *
29   * @since 1.0.4
30   */
31  
32  public interface ActionState extends State {
33  
34  
35      // -------------------------------------------------------------- Properties
36  
37  
38      /***
39       * <p>Return the method binding expression specifying the method to be
40       * invoked when this {@link State} is entered.</p>
41       *
42       * @return The method binding expression to be invoked
43       */
44      public String getMethod();
45  
46  
47  }