1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 package org.apache.pluto.om.entity;
21
22 import java.util.Locale;
23
24 import org.apache.pluto.om.common.Description;
25 import org.apache.pluto.om.common.ObjectID;
26 import org.apache.pluto.om.common.PreferenceSet;
27 import org.apache.pluto.om.portlet.PortletDefinition;
28 import org.apache.pluto.om.window.PortletWindowList;
29
30 /***
31 * <P>
32 * The <CODE>PortletEntity</CODE> interface represents a single portlet occurance,
33 * that can be shown on a single page or on multiple pages.
34 * </P>
35 * <P>
36 * This interface defines the model as known from the MVC pattern.
37 * Its purpose is to provide read access to the data stored in the model.
38 * </P>
39 */
40 public interface PortletEntity extends org.apache.pluto.om.Model
41 {
42
43
44 /***
45 * Returns the identifier of this portlet instance as object id.
46 * The return value cannot be NULL.
47 *
48 * @return the object identifier
49 */
50 public ObjectID getId();
51
52 /***
53 * Returns all preferences of this portlet
54 * The return value cannot be NULL.
55 *
56 * @return the preference set
57 */
58 public PreferenceSet getPreferenceSet();
59
60 /***
61 * Returns the portlet description
62 * The return value cannot be NULL.
63 *
64 * @return the portlet description
65 */
66 public PortletDefinition getPortletDefinition();
67
68 /***
69 * Returns the parent application instance of this portlet instance
70 * The return value cannot be NULL.
71 *
72 * @return the parent application instance
73 */
74 public PortletApplicationEntity getPortletApplicationEntity();
75
76 /***
77 * Get a list with all windows which belong to this portlet instance
78 * The return value cannot be NULL.
79 *
80 * @return <code>PortletWindowList<code> with all windows
81 **/
82 public PortletWindowList getPortletWindowList();
83
84 /***
85 * Returns the description of this portlet entity for the given locale.
86 * The return value may be NULL.
87 *
88 * @return the description for the given locale
89 */
90 public Description getDescription(Locale locale);
91
92 }