| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ViewState |
|
| 1.0;1 |
| 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>A {@link ViewState} encapsulates the rendering of a JavaServer Faces | |
| 22 | * <em>view</em>, identified by a specified view identifier. When the | |
| 23 | * view is rendered, standard {@link org.apache.shale.view.ViewController} | |
| 24 | * functionality will be supported if there is such a corresponding backing | |
| 25 | * bean. The logical outcome returned by a {@link ViewState} will be the | |
| 26 | * one returned by the JavaServer Faces action method that was invoked | |
| 27 | * (if any).</p> | |
| 28 | * | |
| 29 | * @since 1.0.4 | |
| 30 | */ | |
| 31 | ||
| 32 | public interface ViewState extends State { | |
| 33 | ||
| 34 | ||
| 35 | // -------------------------------------------------------------- Properties | |
| 36 | ||
| 37 | ||
| 38 | /** | |
| 39 | * <p>Return <code>true</code> if the transition to this view should | |
| 40 | * be done with a redirect, instead of the normal view creation process.</p> | |
| 41 | */ | |
| 42 | public boolean isRedirect(); | |
| 43 | ||
| 44 | ||
| 45 | /** | |
| 46 | * <p>Return the view identifier of the JavaServer Faces view to render | |
| 47 | * if this state is entered.</p> | |
| 48 | * | |
| 49 | * @return The view identifier of the JavaServer Faces view to render | |
| 50 | */ | |
| 51 | public String getViewId(); | |
| 52 | ||
| 53 | ||
| 54 | } |