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.portlet;
21
22 import java.util.Locale;
23
24 import org.apache.pluto.om.common.Description;
25 import org.apache.pluto.om.common.DisplayName;
26 import org.apache.pluto.om.common.LanguageSet;
27 import org.apache.pluto.om.common.ObjectID;
28 import org.apache.pluto.om.common.ParameterSet;
29 import org.apache.pluto.om.common.PreferenceSet;
30 import org.apache.pluto.om.common.SecurityRoleRefSet;
31 import org.apache.pluto.om.servlet.ServletDefinition;
32
33 /***
34 * <P>
35 * This interface provides access to a portlet and its attributes.
36 * A portlet is defined in the portlet.xml of a portlet application archive
37 * file.
38 * </P>
39 * <P>
40 * This interface defines the model as known from the MVC pattern.
41 * Its purpose is to provide read access to the data stored in the model.
42 * </P>
43 *
44 */
45 public interface PortletDefinition extends org.apache.pluto.om.Model
46 {
47
48
49 /***
50 * Returns the identifier of this portlet as object id.
51 * The return value cannot be NULL.
52 *
53 * @return the object identifier
54 */
55 public ObjectID getId();
56
57 /***
58 * Returns the class name
59 *
60 * @return the class name
61 */
62 public String getClassName();
63
64 /***
65 * Returns the administrative name
66 * The return value cannot be NULL.
67 *
68 * @return the administrative name
69 */
70 public String getName();
71
72 /***
73 * Returns the description for the given locale
74 * The return value may be NULL.
75 *
76 * @return the description
77 */
78 public Description getDescription(Locale locale);
79
80 /***
81 * Returns all resource information of this portlet
82 *
83 * @return the portlet resources
84 */
85 public LanguageSet getLanguageSet();
86
87 /***
88 * Returns all parameters of this portlet
89 * The return value cannot be NULL.
90 *
91 * @return the parameter set
92 */
93 public ParameterSet getInitParameterSet();
94
95 /***
96 * Returns all SecurityRoleRefs of this portlet
97 *
98 * @return the SecurityRoleRef set
99 */
100 public SecurityRoleRefSet getInitSecurityRoleRefSet();
101
102
103 /***
104 * Returns all preferences of this portlet
105 *
106 * @return the preference set
107 */
108 public PreferenceSet getPreferenceSet();
109
110 /***
111 * Returns all supported content types of this portlet
112 *
113 * @return the content type set
114 */
115 public ContentTypeSet getContentTypeSet();
116
117 /***
118 * Returns the PortletApplication object in which this portlet resides
119 * The return value cannot be NULL.
120 *
121 * @return the PortletApplication object of this portlet
122 */
123 public PortletApplicationDefinition getPortletApplicationDefinition();
124
125 /***
126 * Returns the corresponding servlet to this portlet
127 * The return value cannot be NULL.
128 *
129 * @return a servlet object
130 */
131 public ServletDefinition getServletDefinition();
132
133
134 /***
135 * Returns the display name of this portlet for the given locale.
136 * The return value may be NULL.
137 *
138 * @return display name for the given locale
139 */
140 public DisplayName getDisplayName(Locale locale);
141
142 /***
143 * Returns duration (in seconds) of expiration cache
144 *
145 * @return duration of expiration cache
146 */
147 public String getExpirationCache();
148
149 /***
150 * Returns the class loader of the portlet
151 * The return value may be NULL
152 * if the class loader is not yet available.
153 *
154 * @return java.util.ClassLoader
155 */
156 public ClassLoader getPortletClassLoader();
157
158 }