KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > pluto > om > window > PortletWindow


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.om.window;
21
22 import org.apache.pluto.om.Model;
23 import org.apache.pluto.om.common.ObjectID;
24 import org.apache.pluto.om.entity.PortletEntity;
25
26 /**
27  * <P>
28  * The <CODE>PortletWindow</CODE> interface represents a single window
29  * of a portlet instance as it can be shown only once on a single page.
30  * There is a one-to-one relation between portlet windows and portlet entities.
31  * Adding the same portlet e.g. twice on a page results in two different windows.
32  * </P>
33  * <P>
34  * This interface defines the model as known from the MVC pattern.
35  * Its purpose is to provide read access to the data stored in the model.
36  * </P>
37  *
38  **/
39 public interface PortletWindow extends Model {
40
41
42     /**
43      * Returns the identifier of this portlet instance window as object id.
44      * The return value cannot be NULL.
45      *
46      * @return the object identifier
47      **/
48     public ObjectID getId();
49
50     /**
51      * Returns the portlet entity.
52      * The return value cannot be NULL.
53      *
54      * @return the portlet entity
55      **/
56     public PortletEntity getPortletEntity();
57
58 }
59
Popular Tags