KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > pluto > portalImpl > services > portletentityregistry > PortletEntityRegistryService


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.portletentityregistry;
21
22 import org.apache.pluto.om.common.ObjectID;
23 import org.apache.pluto.om.entity.PortletApplicationEntityList;
24 import org.apache.pluto.om.entity.PortletEntity;
25 import org.apache.pluto.portalImpl.services.Service;
26
27 /**
28  * <P>
29  * The <CODE>PortletPoolService</CODE> interface represents all
30  * portlet and portlet application instances available in the portal, such as a
31  * Portlet and Application Pool. It is accessed by the datastore layer to get
32  * information about the portlets and portlet applications.
33  * </P>
34  * <P>
35  * The interfaces defined in this package represent an abstract object
36  * model (OM) that is applicable for different implementations.
37  * The abstract OM defines only how the data is stored and accessed
38  * in the memory. Each implementation can store the data in different ways.
39  * </P>
40  * <P>
41  * This abstraction layer helps to generalize the portlet container from
42  * special implementations like data storage and moreover it is not bound
43  * to a special Application Server.
44  * </P>
45  *
46
47  */
48 public abstract class PortletEntityRegistryService extends Service
49 {
50
51
52     /**
53      * Returns the portlet application instance with the given id.
54      *
55      * @return the portlet application instance
56      */
57     public abstract PortletApplicationEntityList getPortletApplicationEntityList();
58     
59     /**
60      * Returns the portlet Entity with the given id.
61      *
62      * @param id the identifier of the portlet Entity to be returned
63      * @return the portlet Entity
64      */
65     public abstract PortletEntity getPortletEntity(ObjectID id);
66
67     public abstract void store() throws java.io.IOException JavaDoc;
68     
69     public abstract void load() throws java.io.IOException JavaDoc;
70     
71     public abstract void refresh(PortletEntity portletEntity);
72 }
73
Popular Tags