KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > beehive > netui > pageflow > IllegalPageInputException


1 /*
2  * Copyright 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  * $Header:$
17  */
18 package org.apache.beehive.netui.pageflow;
19
20
21 /**
22  * Exception that occurs when a action output has been added to a Forward that resolves to a
23  * {@link org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward} annotation marked with
24  * <code>{@link org.apache.beehive.netui.pageflow.annotations.Jpf.Forward#redirect redirect}=true</code>.
25  * Action outputs may not be used on redirect forwards.
26  *
27  * @deprecated Use {@link IllegalActionOutputException} instead.
28  */
29 public class IllegalPageInputException extends IllegalActionOutputException
30 {
31     /**
32      * Constructor.
33      *
34      * @param forwardName the name of the relevant {@link Forward}.
35      * @param actionName the name of the current action being run.
36      * @param flowController the current {@link FlowController} instance.
37      * @param actionOutputName the name of the relevant action output.
38      */
39     public IllegalPageInputException( String JavaDoc forwardName, String JavaDoc actionName, FlowController flowController,
40                                       String JavaDoc actionOutputName )
41     {
42         super( forwardName, actionName, flowController, actionOutputName );
43     }
44
45     /**
46      * Get the name of the relevant action output.
47      *
48      * @return a String that is the name of the relevant action output.
49      */
50     public String JavaDoc getPageInputName()
51     {
52         return getActionOutputName();
53     }
54
55     /**
56      * Set the name of the relevant action output.
57      *
58      * @param actionOutputName a String that is the name of the relevant action output.
59      */
60     public void setPageInputName( String JavaDoc actionOutputName )
61     {
62         setActionOutputName( actionOutputName );
63     }
64 }
65
Popular Tags