KickJava   Java API By Example, From Geeks To Geeks.

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


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  * Base type for errors related to output forms on Forwards.
23  *
24  * @see Forward#addOutputForm
25  */
26 public abstract class IllegalOutputFormException extends PageFlowException
27 {
28     private String JavaDoc _forwardName;
29     private String JavaDoc _outputFormType;
30
31     
32     /**
33      * @param forwardName the name of the relevant {@link Forward}.
34      * @param actionName the name of the current action being run.
35      * @param flowController the current {@link FlowController} instance.
36      * @param outputFormType the type name of the relevant output form.
37      */
38     public IllegalOutputFormException( String JavaDoc forwardName, String JavaDoc actionName, FlowController flowController,
39                                        String JavaDoc outputFormType )
40     {
41         super( actionName, flowController );
42         _forwardName = forwardName;
43         _outputFormType = outputFormType;
44     }
45
46     /**
47      * Get the name of the relevant {@link Forward}.
48      *
49      * @return a String that is the name of the relevant {@link Forward}.
50      */
51     public String JavaDoc getForwardName()
52     {
53         return _forwardName;
54     }
55
56     /**
57      * Set the name of the relevant {@link Forward}.
58      *
59      * @param forwardName a String that is the name of the relevant {@link Forward}.
60      */
61     public void setForwardName( String JavaDoc forwardName )
62     {
63         _forwardName = forwardName;
64     }
65
66     /**
67      * Get the type name of the relevant output form.
68      *
69      * @return a String that is the type name of the relevant output form.
70      */
71     public String JavaDoc getOutputFormType()
72     {
73         return _outputFormType;
74     }
75
76     /**
77      * Set the type name of the relevant output form.
78      *
79      * @param outputFormType a String that is the type name of the relevant output form.
80      */
81     public void setOutputFormType( String JavaDoc outputFormType )
82     {
83         _outputFormType = outputFormType;
84     }
85
86     /**
87      * Tell whether the root cause may be session expiration in cases where the requested session ID is different than
88      * the actual session ID. In this case, the answer is <code>false</code>.
89      */
90     public boolean causeMayBeSessionExpiration()
91     {
92         return false;
93     }
94 }
95
Popular Tags