KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > om > registry > CachedParameter


1 /*
2  * Copyright 2000-2001,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  
17 package org.apache.jetspeed.om.registry;
18
19 /**
20  * Interface describing a cached parameter for a registry entry.
21  *
22  * @author <a HREF="mailto:taylor@apache.org">David Sean Taylor</a>
23  * @version $Id: CachedParameter.java,v 1.2 2004/02/23 03:11:39 jford Exp $
24  */
25 public interface CachedParameter extends Parameter
26 {
27
28     /**
29      * Determines whether to use the parameter name as part of the unique id to the portlet cache.
30      * This can be used to control the lifetime of the portlet.
31      * The name is used in combination with the URL and parameter values for this portlet
32      * to uniquely identify to portlet.
33      * This value can be set in the portlet registry.
34      *
35      * @return cached set to true if want this portlet to be cached based on the parameter name
36      */
37     public boolean isCachedOnName();
38
39     /**
40      * Determines whether to use the parameter value as part of the unique id to the portlet cache.
41      * This can be used to control the lifetime of the portlet.
42      * The value is used in combination with the URL and parameter names for this portlet
43      * to uniquely identify to portlet.
44      * This value can be set in the portlet registry.
45      *
46      * @return cached set to true if want this portlet to be cached based on the parameter value
47      */
48     public boolean isCachedOnValue();
49
50     /**
51      * Determines whether to use the parameter name as part of the unique id to the portlet cache.
52      * This can be used to control the lifetime of the portlet.
53      * The name is used in combination with the URL and parameter values for this portlet
54      * to uniquely identify to portlet.
55      * This value can be set in the portlet registry.
56      *
57      * @return cached Set to true if want this portlet to be cached based on the parameter name
58      */
59     public void setCachedOnName(boolean cache);
60
61     /**
62      * Determines whether to use the parameter value as part of the unique id to the portlet cache.
63      * This can be used to control the lifetime of the portlet.
64      * The value is used in combination with the URL and parameter names for this portlet
65      * to uniquely identify to portlet.
66      * This value can be set in the portlet registry.
67      *
68      *
69      * @return cached Set to true if want this portlet to be cached based on the parameter value
70      */
71     public void setCachedOnValue(boolean cache);
72
73 }
Popular Tags