1   /**
2    * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.model;
24  
25  
26  /**
27   * <a href="Portlet.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface is a model that represents the <code>Portlet</code> table
36   * in the database.
37   * </p>
38   *
39   * <p>
40   * Customize <code>com.liferay.portal.service.model.impl.PortletImpl</code>
41   * and rerun the ServiceBuilder to generate the new methods.
42   * </p>
43   *
44   * @author Brian Wing Shun Chan
45   *
46   * @see com.liferay.portal.service.model.PortletModel
47   * @see com.liferay.portal.service.model.impl.PortletImpl
48   * @see com.liferay.portal.service.model.impl.PortletModelImpl
49   *
50   */
51  public interface Portlet extends PortletModel {
52      public java.lang.String getRootPortletId();
53  
54      public java.lang.String getInstanceId();
55  
56      public java.lang.String getPluginId();
57  
58      public java.lang.String getPluginType();
59  
60      public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage();
61  
62      public void setPluginPackage(
63          com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
64  
65      public com.liferay.portal.model.PluginSetting getDefaultPluginSetting();
66  
67      public void setDefaultPluginSetting(
68          com.liferay.portal.model.PluginSetting pluginSetting);
69  
70      public java.lang.String getIcon();
71  
72      public void setIcon(java.lang.String icon);
73  
74      public java.lang.String getVirtualPath();
75  
76      public void setVirtualPath(java.lang.String virtualPath);
77  
78      public java.lang.String getStrutsPath();
79  
80      public void setStrutsPath(java.lang.String strutsPath);
81  
82      public java.lang.String getDisplayName();
83  
84      public void setDisplayName(java.lang.String displayName);
85  
86      public java.lang.String getPortletClass();
87  
88      public void setPortletClass(java.lang.String portletClass);
89  
90      public java.lang.String getConfigurationActionClass();
91  
92      public void setConfigurationActionClass(
93          java.lang.String configurationActionClass);
94  
95      public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance();
96  
97      public java.lang.String getIndexerClass();
98  
99      public void setIndexerClass(java.lang.String indexerClass);
100 
101     public java.lang.String getOpenSearchClass();
102 
103     public void setOpenSearchClass(java.lang.String openSearchClass);
104 
105     public java.lang.String getSchedulerClass();
106 
107     public void setSchedulerClass(java.lang.String schedulerClass);
108 
109     public com.liferay.portal.kernel.job.Scheduler getSchedulerInstance();
110 
111     public java.lang.String getPortletURLClass();
112 
113     public void setPortletURLClass(java.lang.String portletURLClass);
114 
115     public java.lang.String getFriendlyURLMapperClass();
116 
117     public void setFriendlyURLMapperClass(
118         java.lang.String friendlyURLMapperClass);
119 
120     public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance();
121 
122     public java.lang.String getURLEncoderClass();
123 
124     public void setURLEncoderClass(java.lang.String urlEncoderClass);
125 
126     public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance();
127 
128     public java.lang.String getPortletDataHandlerClass();
129 
130     public void setPortletDataHandlerClass(
131         java.lang.String portletDataHandlerClass);
132 
133     public com.liferay.portal.kernel.lar.PortletDataHandler getPortletDataHandlerInstance();
134 
135     public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListener();
136 
137     public java.lang.String getPortletLayoutListenerClass();
138 
139     public void setPortletLayoutListenerClass(
140         java.lang.String portletLayoutListenerClass);
141 
142     public java.lang.String getPopMessageListenerClass();
143 
144     public void setPopMessageListenerClass(
145         java.lang.String popMessageListenerClass);
146 
147     public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance();
148 
149     public java.lang.String getSocialActivityInterpreterClass();
150 
151     public void setSocialActivityInterpreterClass(
152         java.lang.String socialActivityInterpreterClass);
153 
154     public com.liferay.portlet.social.model.SocialActivityInterpreter getSocialActivityInterpreterInstance();
155 
156     public java.lang.String getDefaultPreferences();
157 
158     public void setDefaultPreferences(java.lang.String defaultPreferences);
159 
160     public java.lang.String getPreferencesValidator();
161 
162     public void setPreferencesValidator(java.lang.String prefsValidator);
163 
164     public boolean getPreferencesCompanyWide();
165 
166     public boolean isPreferencesCompanyWide();
167 
168     public void setPreferencesCompanyWide(boolean prefsCompanyWide);
169 
170     public boolean getPreferencesUniquePerLayout();
171 
172     public boolean isPreferencesUniquePerLayout();
173 
174     public void setPreferencesUniquePerLayout(boolean prefsUniquePerLayout);
175 
176     public boolean getPreferencesOwnedByGroup();
177 
178     public boolean isPreferencesOwnedByGroup();
179 
180     public void setPreferencesOwnedByGroup(boolean prefsOwnedByGroup);
181 
182     public boolean getUseDefaultTemplate();
183 
184     public boolean isUseDefaultTemplate();
185 
186     public void setUseDefaultTemplate(boolean useDefaultTemplate);
187 
188     public boolean getShowPortletAccessDenied();
189 
190     public boolean isShowPortletAccessDenied();
191 
192     public void setShowPortletAccessDenied(boolean showPortletAccessDenied);
193 
194     public boolean getShowPortletInactive();
195 
196     public boolean isShowPortletInactive();
197 
198     public void setShowPortletInactive(boolean showPortletInactive);
199 
200     public boolean getActionURLRedirect();
201 
202     public boolean isActionURLRedirect();
203 
204     public void setActionURLRedirect(boolean actionURLRedirect);
205 
206     public boolean getRestoreCurrentView();
207 
208     public boolean isRestoreCurrentView();
209 
210     public void setRestoreCurrentView(boolean restoreCurrentView);
211 
212     public boolean getMaximizeEdit();
213 
214     public boolean isMaximizeEdit();
215 
216     public void setMaximizeEdit(boolean maximizeEdit);
217 
218     public boolean getMaximizeHelp();
219 
220     public boolean isMaximizeHelp();
221 
222     public void setMaximizeHelp(boolean maximizeHelp);
223 
224     public boolean getPopUpPrint();
225 
226     public boolean isPopUpPrint();
227 
228     public void setPopUpPrint(boolean popUpPrint);
229 
230     public boolean getLayoutCacheable();
231 
232     public boolean isLayoutCacheable();
233 
234     public void setLayoutCacheable(boolean layoutCacheable);
235 
236     public boolean getInstanceable();
237 
238     public boolean isInstanceable();
239 
240     public void setInstanceable(boolean instanceable);
241 
242     public java.lang.String getUserPrincipalStrategy();
243 
244     public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy);
245 
246     public boolean getPrivateRequestAttributes();
247 
248     public boolean isPrivateRequestAttributes();
249 
250     public void setPrivateRequestAttributes(boolean privateRequestAttributes);
251 
252     public boolean getPrivateSessionAttributes();
253 
254     public boolean isPrivateSessionAttributes();
255 
256     public void setPrivateSessionAttributes(boolean privateSessionAttributes);
257 
258     public int getRenderWeight();
259 
260     public void setRenderWeight(int renderWeight);
261 
262     public boolean getAjaxable();
263 
264     public boolean isAjaxable();
265 
266     public void setAjaxable(boolean ajaxable);
267 
268     public java.util.List<String> getHeaderPortalCss();
269 
270     public void setHeaderPortalCss(java.util.List<String> headerPortalCss);
271 
272     public java.util.List<String> getHeaderPortletCss();
273 
274     public void setHeaderPortletCss(java.util.List<String> headerPortletCss);
275 
276     public java.util.List<String> getHeaderPortalJavaScript();
277 
278     public void setHeaderPortalJavaScript(
279         java.util.List<String> headerPortalJavaScript);
280 
281     public java.util.List<String> getHeaderPortletJavaScript();
282 
283     public void setHeaderPortletJavaScript(
284         java.util.List<String> headerPortletJavaScript);
285 
286     public java.util.List<String> getFooterPortalCss();
287 
288     public void setFooterPortalCss(java.util.List<String> footerPortalCss);
289 
290     public java.util.List<String> getFooterPortletCss();
291 
292     public void setFooterPortletCss(java.util.List<String> footerPortletCss);
293 
294     public java.util.List<String> getFooterPortalJavaScript();
295 
296     public void setFooterPortalJavaScript(
297         java.util.List<String> footerPortalJavaScript);
298 
299     public java.util.List<String> getFooterPortletJavaScript();
300 
301     public void setFooterPortletJavaScript(
302         java.util.List<String> footerPortletJavaScript);
303 
304     public java.lang.String getCssClassWrapper();
305 
306     public void setCssClassWrapper(java.lang.String cssClassWrapper);
307 
308     public boolean getAddDefaultResource();
309 
310     public boolean isAddDefaultResource();
311 
312     public void setAddDefaultResource(boolean addDefaultResource);
313 
314     public void setRoles(java.lang.String roles);
315 
316     public java.lang.String[] getRolesArray();
317 
318     public void setRolesArray(java.lang.String[] rolesArray);
319 
320     public java.util.Set<String> getUnlinkedRoles();
321 
322     public void setUnlinkedRoles(java.util.Set<String> unlinkedRoles);
323 
324     public java.util.Map<String, String> getRoleMappers();
325 
326     public void setRoleMappers(java.util.Map<String, String> roleMappers);
327 
328     public void linkRoles();
329 
330     public boolean hasRoleWithName(java.lang.String roleName);
331 
332     public boolean hasAddPortletPermission(long userId);
333 
334     public boolean getSystem();
335 
336     public boolean isSystem();
337 
338     public void setSystem(boolean system);
339 
340     public boolean getInclude();
341 
342     public boolean isInclude();
343 
344     public void setInclude(boolean include);
345 
346     public java.util.Map<String, String> getInitParams();
347 
348     public void setInitParams(java.util.Map<String, String> initParams);
349 
350     public java.lang.Integer getExpCache();
351 
352     public void setExpCache(java.lang.Integer expCache);
353 
354     public java.util.Map<String, java.util.Set<String>> getPortletModes();
355 
356     public void setPortletModes(
357         java.util.Map<String, java.util.Set<String>> portletModes);
358 
359     public boolean hasPortletMode(java.lang.String mimeType,
360         javax.portlet.PortletMode portletMode);
361 
362     public java.util.Set<String> getAllPortletModes();
363 
364     public boolean hasMultipleMimeTypes();
365 
366     public java.util.Set<String> getSupportedLocales();
367 
368     public void setSupportedLocales(java.util.Set<String> supportedLocales);
369 
370     public java.lang.String getResourceBundle();
371 
372     public void setResourceBundle(java.lang.String resourceBundle);
373 
374     public com.liferay.portal.model.PortletInfo getPortletInfo();
375 
376     public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo);
377 
378     public java.util.Map<String, com.liferay.portal.model.PortletFilter> getPortletFilters();
379 
380     public void setPortletFilters(
381         java.util.Map<String, com.liferay.portal.model.PortletFilter> portletFilters);
382 
383     public void addProcessingEvent(javax.xml.namespace.QName processingEvent);
384 
385     public javax.xml.namespace.QName getProcessingEvent(java.lang.String uri,
386         java.lang.String localPart);
387 
388     public java.util.Set<javax.xml.namespace.QName> getProcessingEvents();
389 
390     public void setProcessingEvents(
391         java.util.Set<javax.xml.namespace.QName> processingEvents);
392 
393     public void addPublishingEvent(javax.xml.namespace.QName publishingEvent);
394 
395     public java.util.Set<javax.xml.namespace.QName> getPublishingEvents();
396 
397     public void setPublishingEvents(
398         java.util.Set<javax.xml.namespace.QName> publishingEvents);
399 
400     public void addPublicRenderParameter(
401         com.liferay.portal.model.PublicRenderParameter publicRenderParameter);
402 
403     public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
404         java.lang.String identifier);
405 
406     public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
407         java.lang.String uri, java.lang.String localPart);
408 
409     public java.util.Set<com.liferay.portal.model.PublicRenderParameter> getPublicRenderParameters();
410 
411     public void setPublicRenderParameters(
412         java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters);
413 
414     public java.lang.String getContextPath();
415 
416     public com.liferay.portal.model.PortletApp getPortletApp();
417 
418     public void setPortletApp(com.liferay.portal.model.PortletApp portletApp);
419 
420     public com.liferay.portal.model.Portlet getClonedInstance(
421         java.lang.String portletId);
422 
423     public boolean getStatic();
424 
425     public boolean isStatic();
426 
427     public void setStatic(boolean staticPortlet);
428 
429     public boolean getStaticStart();
430 
431     public boolean isStaticStart();
432 
433     public void setStaticStart(boolean staticPortletStart);
434 
435     public boolean getStaticEnd();
436 
437     public boolean isStaticEnd();
438 
439     public java.lang.Object clone();
440 
441     public int compareTo(java.lang.Object obj);
442 
443     public boolean equals(java.lang.Object obj);
444 }