KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > pluto > portalImpl > services > pageregistry > PageRegistryService


1 /*
2  * Copyright 2003,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
18  */

19
20 package org.apache.pluto.portalImpl.services.pageregistry;
21
22 import org.apache.pluto.portalImpl.aggregation.Fragment;
23 import org.apache.pluto.portalImpl.aggregation.RootFragment;
24 import org.apache.pluto.portalImpl.services.Service;
25
26 /**
27  * <P>
28  * The <CODE>PageRegistryService</CODE> interface represents a complete site
29  * with all pages, windows and portlet entries on it. It is accessed
30  * by the datastore layer to get information about the site.
31  * </P>
32  * <P>
33  * The interfaces defined in this package represent an abstract object
34  * model (OM) that is applicable for different implementations.
35  * The abstract OM defines only how the data is stored and accessed
36  * in the memory. Each implementation can store the data in different ways.
37  * </P>
38  * <P>
39  * This abstraction layer helps to generalize the portlet container from
40  * special implementations like data storage and moreover it is not bound
41  * to a special Application Server.
42  * </P>
43  *
44
45  */

46 public abstract class PageRegistryService extends Service
47 {
48
49
50     /**
51      * Returns the description of the complete portal site.
52      *
53      * @return the object model description
54      */

55     public abstract RootFragment getRootFragment();
56
57     /**
58      * Returns the fragment with the given id.
59      *
60      * return the fragment object with this id
61      **/

62     public abstract Fragment getFragment(String JavaDoc id);
63     
64    /**
65     * Add a fragment to the page registry.
66     *
67     * @param fragment the fragment to add
68     **/

69     public abstract void addFragment(Fragment fragment) throws Exception JavaDoc;
70 }
71
Popular Tags