View Javadoc

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>{@link EndState} is a spacialized {@link ViewState} that also marks
22   * this as the final {@link State} to be executed in the owning {@link Dialog}.
23   * When this {@link State} is entered, context information for the owning
24   * {@link Dialog} is removed.  Then, if a view identifier is specified,
25   * the corresponding JavaServer Faces <code>view</code> will be rendered,
26   * and the logical outcome returned by the subsequently invoked action method
27   * will be returned to the parent {@link Dialog} (if any) as the logical
28   * outcome of this dialog's execution.  If no view identifier is specified,
29   * it is assumed that some other mechanism will be used to return output to
30   * the client.</p>
31   *
32   * @since 1.0.4
33   */
34  
35  public interface EndState extends ViewState {
36  
37  }