KickJava   Java API By Example, From Geeks To Geeks.

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


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 import javax.servlet.ServletContext JavaDoc;
21 import javax.servlet.http.HttpServletRequest JavaDoc;
22 import javax.servlet.http.HttpServletResponse JavaDoc;
23
24
25 /**
26  * Interface for controller classes that resolve actions to URIs.
27  */

28 public interface ActionResolver
29 {
30     /**
31      * Get the URI for addressing this object.
32      *
33      * @return a String that is the URI, relative to the webapp root, for addressing this object.
34      */

35     public String JavaDoc getURI();
36     
37     /**
38      * Get the Struts module path associated with this ActionResolver.
39      */

40     public String JavaDoc getModulePath();
41
42     /**
43      * Called on this object for non-lookup (refresh) requests.
44      */

45     public void refresh( HttpServletRequest JavaDoc request, HttpServletResponse JavaDoc response );
46     
47     /**
48      * Tell whether this ActionResolver is a {@link PageFlowController}.
49      *
50      * @return <code>true</code> if this is a {@link PageFlowController}.
51      */

52     public boolean isPageFlow();
53 }
54
Popular Tags