KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > components > flow > apples > AppleRequest


1 /*
2  * Copyright 1999-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 package org.apache.cocoon.components.flow.apples;
17
18 import java.util.Set JavaDoc;
19
20 import org.apache.cocoon.environment.Request;
21
22 /**
23  * AppleRequest defines the services an AppleController can collect
24  * from the current request.
25  */

26 public interface AppleRequest {
27
28     /**
29      * @return the wrapped cocoon environment Request
30      */

31     public Request getCocoonRequest();
32     
33     
34     /**
35      * @return Set of String's listing all available sitemap-parameters passed.
36      */

37     public Set JavaDoc getSitemapParameterNames();
38     
39     /**
40      * Finds a named parameter in the request.
41      * @param key of parameter to lookup
42      * @return the parameter-value
43      */

44     public String JavaDoc getSitemapParameter(String JavaDoc key);
45
46     /**
47      * Finds a named parameter in the request using the overloaded method
48      * {@link #getSitemapParameter(String)} but lets the returned value
49      * default to the second argument in case the delegation resulted into
50      * <code>null</code>
51      * @param key of parameter to lookup
52      * @param defaultValue return-value in case the lookup returned <code>null</code>
53      * @return the parameter-value or if that was null: the defaultValue passed.
54      */

55     public String JavaDoc getSitemapParameter(String JavaDoc key, String JavaDoc defaultValue);
56 }
57
Popular Tags