01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.portal.profile;
18:
19: import java.util.Map;
20:
21: import org.apache.excalibur.source.SourceValidity;
22:
23: /**
24: * This component is used for loading/saving of a profile.
25: *
26: * @author <a href="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
27: * @author <a href="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
28: * @author <a href="mailto:bluetkemeier@s-und-n.de">Björn Lütkemeier</a>
29: *
30: * @version CVS $Id: ProfileLS.java 433543 2006-08-22 06:22:54Z crossley $
31: */
32: public interface ProfileLS {
33:
34: /** Component role */
35: String ROLE = ProfileLS.class.getName();
36:
37: /** This parameter is used during loading to resolve references */
38: String PARAMETER_OBJECTMAP = "objectmap";
39: /** This parameter is used to define the profiletype */
40: String PARAMETER_PROFILETYPE = "profiletype";
41:
42: String PROFILETYPE_LAYOUT = "layout";
43: String PROFILETYPE_COPLETBASEDATA = "copletbasedata";
44: String PROFILETYPE_COPLETDATA = "copletdata";
45: String PROFILETYPE_COPLETINSTANCEDATA = "copletinstancedata";
46:
47: /**
48: * Load a profile
49: */
50: Object loadProfile(Object key, Map parameters) throws Exception;
51:
52: /**
53: * Save a profile
54: */
55: void saveProfile(Object key, Map parameters, Object profile)
56: throws Exception;
57:
58: SourceValidity getValidity(Object key, Map parameters);
59: }
|