KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > om > profile > Profile


1 /*
2  * Copyright 2000-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.profile;
18
19 import org.apache.jetspeed.portal.PortletSet;
20
21 /**
22 Represents a profile, the interface to a PSML resource.
23
24 @author <a HREF="mailto:david@bluesunrise.com">David Sean Taylor</a>
25 @version $Id: Profile.java,v 1.11 2004/02/23 03:05:01 jford Exp $
26 */
27
28 public interface Profile extends ProfileLocator
29 {
30     /**
31      * Gets the root set of portlets for this profile object.
32      *
33      * @deprecated Will be removed with refactoring of profiler service.
34      * @return The root portlet set for this profile.
35      */
36     public PortletSet getRootSet();
37
38     /**
39      * Gets the psml document attached to this profile
40      *
41      * @return The PSML document for this profile.
42      */
43     public PSMLDocument getDocument();
44
45     /**
46      * Sets the psml document attached to this profile
47      *
48      * @param The PSML document for this profile.
49      */
50     public void setDocument(PSMLDocument document);
51
52     /**
53      * stores the resource by merging and rewriting the psml file
54      *
55      * @throws ProfileException if an error occurs storing the profile
56      */
57     public void store() throws ProfileException;
58     
59     /**
60      * initialize a profile from a locator
61      *
62      * @param locator
63      */
64     public void init(ProfileLocator locator);
65 }
66
Popular Tags