KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > portal > profile > ProfileLS


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.portal.profile;
17
18 import java.util.Map JavaDoc;
19
20 import org.apache.excalibur.source.SourceValidity;
21
22 /**
23  * This component is used for loading/saving of a profile.
24  *
25  * @author <a HREF="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
26  * @author <a HREF="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
27  * @author <a HREF="mailto:bluetkemeier@s-und-n.de">Bj&ouml;rn L&uuml;tkemeier</a>
28  *
29  * @version CVS $Id: ProfileLS.java 148910 2005-01-28 18:19:44Z cziegeler $
30  */

31 public interface ProfileLS {
32     
33     /** Component role */
34     String JavaDoc ROLE = ProfileLS.class.getName();
35
36     /** This parameter is used during loading to resolve references */
37     String JavaDoc PARAMETER_OBJECTMAP = "objectmap";
38     /** This parameter is used to define the profiletype */
39     String JavaDoc PARAMETER_PROFILETYPE = "profiletype";
40     
41     String JavaDoc PROFILETYPE_LAYOUT = "layout";
42     String JavaDoc PROFILETYPE_COPLETBASEDATA = "copletbasedata";
43     String JavaDoc PROFILETYPE_COPLETDATA = "copletdata";
44     String JavaDoc PROFILETYPE_COPLETINSTANCEDATA = "copletinstancedata";
45     
46     /**
47      * Load a profile
48      */

49     Object JavaDoc loadProfile(Object JavaDoc key, Map JavaDoc parameters) throws Exception JavaDoc;
50     
51     /**
52      * Save a profile
53      */

54     void saveProfile(Object JavaDoc key, Map JavaDoc parameters, Object JavaDoc profile) throws Exception JavaDoc;
55     
56     SourceValidity getValidity(Object JavaDoc key, Map JavaDoc parameters);
57 }
58
Popular Tags