1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portal.model;
21  
22  
23  /**
24   * <a href="Portlet.java.html"><b><i>View Source</i></b></a>
25   *
26   * <p>
27   * ServiceBuilder generated this class. Modifications in this class will be
28   * overwritten the next time is generated.
29   * </p>
30   *
31   * <p>
32   * This interface is a model that represents the <code>Portlet</code> table
33   * in the database.
34   * </p>
35   *
36   * <p>
37   * Customize <code>com.liferay.portal.model.impl.PortletImpl</code>
38   * and rerun the ServiceBuilder to generate the new methods.
39   * </p>
40   *
41   * @author Brian Wing Shun Chan
42   *
43   * @see com.liferay.portal.model.PortletModel
44   * @see com.liferay.portal.model.impl.PortletImpl
45   * @see com.liferay.portal.model.impl.PortletModelImpl
46   *
47   */
48  public interface Portlet extends PortletModel {
49      public java.lang.String getRootPortletId();
50  
51      public java.lang.String getInstanceId();
52  
53      public java.lang.String getPluginId();
54  
55      public java.lang.String getPluginType();
56  
57      public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage();
58  
59      public void setPluginPackage(
60          com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
61  
62      public com.liferay.portal.model.PluginSetting getDefaultPluginSetting();
63  
64      public void setDefaultPluginSetting(
65          com.liferay.portal.model.PluginSetting pluginSetting);
66  
67      public long getTimestamp();
68  
69      public void setTimestamp(long timestamp);
70  
71      public java.lang.String getIcon();
72  
73      public void setIcon(java.lang.String icon);
74  
75      public java.lang.String getVirtualPath();
76  
77      public void setVirtualPath(java.lang.String virtualPath);
78  
79      public java.lang.String getStrutsPath();
80  
81      public void setStrutsPath(java.lang.String strutsPath);
82  
83      public java.lang.String getPortletName();
84  
85      public void setPortletName(java.lang.String portletName);
86  
87      public java.lang.String getDisplayName();
88  
89      public void setDisplayName(java.lang.String displayName);
90  
91      public java.lang.String getPortletClass();
92  
93      public void setPortletClass(java.lang.String portletClass);
94  
95      public java.lang.String getConfigurationActionClass();
96  
97      public void setConfigurationActionClass(
98          java.lang.String configurationActionClass);
99  
100     public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance();
101 
102     public java.lang.String getIndexerClass();
103 
104     public void setIndexerClass(java.lang.String indexerClass);
105 
106     public com.liferay.portal.kernel.search.Indexer getIndexerInstance();
107 
108     public java.lang.String getOpenSearchClass();
109 
110     public void setOpenSearchClass(java.lang.String openSearchClass);
111 
112     public com.liferay.portal.kernel.search.OpenSearch getOpenSearchInstance();
113 
114     public java.lang.String getSchedulerClass();
115 
116     public void setSchedulerClass(java.lang.String schedulerClass);
117 
118     public com.liferay.portal.kernel.job.Scheduler getSchedulerInstance();
119 
120     public java.lang.String getPortletURLClass();
121 
122     public void setPortletURLClass(java.lang.String portletURLClass);
123 
124     public java.lang.String getFriendlyURLMapperClass();
125 
126     public void setFriendlyURLMapperClass(
127         java.lang.String friendlyURLMapperClass);
128 
129     public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance();
130 
131     public java.lang.String getURLEncoderClass();
132 
133     public void setURLEncoderClass(java.lang.String urlEncoderClass);
134 
135     public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance();
136 
137     public java.lang.String getPortletDataHandlerClass();
138 
139     public void setPortletDataHandlerClass(
140         java.lang.String portletDataHandlerClass);
141 
142     public com.liferay.portal.lar.PortletDataHandler getPortletDataHandlerInstance();
143 
144     public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListener();
145 
146     public java.lang.String getPortletLayoutListenerClass();
147 
148     public void setPortletLayoutListenerClass(
149         java.lang.String portletLayoutListenerClass);
150 
151     public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance();
152 
153     public java.lang.String getPollerProcessorClass();
154 
155     public void setPollerProcessorClass(java.lang.String pollerProcessorClass);
156 
157     public com.liferay.portal.kernel.poller.PollerProcessor getPollerProcessorInstance();
158 
159     public java.lang.String getPopMessageListenerClass();
160 
161     public void setPopMessageListenerClass(
162         java.lang.String popMessageListenerClass);
163 
164     public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance();
165 
166     public java.lang.String getSocialActivityInterpreterClass();
167 
168     public void setSocialActivityInterpreterClass(
169         java.lang.String socialActivityInterpreterClass);
170 
171     public com.liferay.portlet.social.model.SocialActivityInterpreter getSocialActivityInterpreterInstance();
172 
173     public java.lang.String getSocialRequestInterpreterClass();
174 
175     public void setSocialRequestInterpreterClass(
176         java.lang.String socialRequestInterpreterClass);
177 
178     public com.liferay.portlet.social.model.SocialRequestInterpreter getSocialRequestInterpreterInstance();
179 
180     public java.lang.String getWebDAVStorageToken();
181 
182     public void setWebDAVStorageToken(java.lang.String webDAVStorageToken);
183 
184     public java.lang.String getWebDAVStorageClass();
185 
186     public void setWebDAVStorageClass(java.lang.String webDAVStorageClass);
187 
188     public com.liferay.portal.webdav.WebDAVStorage getWebDAVStorageInstance();
189 
190     public java.lang.String getControlPanelEntryCategory();
191 
192     public void setControlPanelEntryCategory(
193         java.lang.String controlPanelEntryCategory);
194 
195     public double getControlPanelEntryWeight();
196 
197     public void setControlPanelEntryWeight(double controlPanelEntryWeight);
198 
199     public java.lang.String getControlPanelEntryClass();
200 
201     public void setControlPanelEntryClass(
202         java.lang.String controlPanelEntryClass);
203 
204     public com.liferay.portlet.ControlPanelEntry getControlPanelEntryInstance();
205 
206     public java.lang.String getDefaultPreferences();
207 
208     public void setDefaultPreferences(java.lang.String defaultPreferences);
209 
210     public java.lang.String getPreferencesValidator();
211 
212     public void setPreferencesValidator(java.lang.String preferencesValidator);
213 
214     public boolean getPreferencesCompanyWide();
215 
216     public boolean isPreferencesCompanyWide();
217 
218     public void setPreferencesCompanyWide(boolean preferencesCompanyWide);
219 
220     public boolean getPreferencesUniquePerLayout();
221 
222     public boolean isPreferencesUniquePerLayout();
223 
224     public void setPreferencesUniquePerLayout(
225         boolean preferencesUniquePerLayout);
226 
227     public boolean getPreferencesOwnedByGroup();
228 
229     public boolean isPreferencesOwnedByGroup();
230 
231     public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup);
232 
233     public boolean getUseDefaultTemplate();
234 
235     public boolean isUseDefaultTemplate();
236 
237     public void setUseDefaultTemplate(boolean useDefaultTemplate);
238 
239     public boolean getShowPortletAccessDenied();
240 
241     public boolean isShowPortletAccessDenied();
242 
243     public void setShowPortletAccessDenied(boolean showPortletAccessDenied);
244 
245     public boolean getShowPortletInactive();
246 
247     public boolean isShowPortletInactive();
248 
249     public void setShowPortletInactive(boolean showPortletInactive);
250 
251     public boolean getActionURLRedirect();
252 
253     public boolean isActionURLRedirect();
254 
255     public void setActionURLRedirect(boolean actionURLRedirect);
256 
257     public boolean getRestoreCurrentView();
258 
259     public boolean isRestoreCurrentView();
260 
261     public void setRestoreCurrentView(boolean restoreCurrentView);
262 
263     public boolean getMaximizeEdit();
264 
265     public boolean isMaximizeEdit();
266 
267     public void setMaximizeEdit(boolean maximizeEdit);
268 
269     public boolean getMaximizeHelp();
270 
271     public boolean isMaximizeHelp();
272 
273     public void setMaximizeHelp(boolean maximizeHelp);
274 
275     public boolean getPopUpPrint();
276 
277     public boolean isPopUpPrint();
278 
279     public void setPopUpPrint(boolean popUpPrint);
280 
281     public boolean getLayoutCacheable();
282 
283     public boolean isLayoutCacheable();
284 
285     public void setLayoutCacheable(boolean layoutCacheable);
286 
287     public boolean getInstanceable();
288 
289     public boolean isInstanceable();
290 
291     public void setInstanceable(boolean instanceable);
292 
293     public boolean getScopeable();
294 
295     public boolean isScopeable();
296 
297     public void setScopeable(boolean scopeable);
298 
299     public java.lang.String getUserPrincipalStrategy();
300 
301     public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy);
302 
303     public boolean getPrivateRequestAttributes();
304 
305     public boolean isPrivateRequestAttributes();
306 
307     public void setPrivateRequestAttributes(boolean privateRequestAttributes);
308 
309     public boolean getPrivateSessionAttributes();
310 
311     public boolean isPrivateSessionAttributes();
312 
313     public void setPrivateSessionAttributes(boolean privateSessionAttributes);
314 
315     public int getRenderWeight();
316 
317     public void setRenderWeight(int renderWeight);
318 
319     public boolean getAjaxable();
320 
321     public boolean isAjaxable();
322 
323     public void setAjaxable(boolean ajaxable);
324 
325     public java.util.List<String> getHeaderPortalCss();
326 
327     public void setHeaderPortalCss(java.util.List<String> headerPortalCss);
328 
329     public java.util.List<String> getHeaderPortletCss();
330 
331     public void setHeaderPortletCss(java.util.List<String> headerPortletCss);
332 
333     public java.util.List<String> getHeaderPortalJavaScript();
334 
335     public void setHeaderPortalJavaScript(
336         java.util.List<String> headerPortalJavaScript);
337 
338     public java.util.List<String> getHeaderPortletJavaScript();
339 
340     public void setHeaderPortletJavaScript(
341         java.util.List<String> headerPortletJavaScript);
342 
343     public java.util.List<String> getFooterPortalCss();
344 
345     public void setFooterPortalCss(java.util.List<String> footerPortalCss);
346 
347     public java.util.List<String> getFooterPortletCss();
348 
349     public void setFooterPortletCss(java.util.List<String> footerPortletCss);
350 
351     public java.util.List<String> getFooterPortalJavaScript();
352 
353     public void setFooterPortalJavaScript(
354         java.util.List<String> footerPortalJavaScript);
355 
356     public java.util.List<String> getFooterPortletJavaScript();
357 
358     public void setFooterPortletJavaScript(
359         java.util.List<String> footerPortletJavaScript);
360 
361     public java.lang.String getCssClassWrapper();
362 
363     public void setCssClassWrapper(java.lang.String cssClassWrapper);
364 
365     public java.lang.String getFacebookIntegration();
366 
367     public void setFacebookIntegration(java.lang.String facebookIntegration);
368 
369     public boolean getAddDefaultResource();
370 
371     public boolean isAddDefaultResource();
372 
373     public void setAddDefaultResource(boolean addDefaultResource);
374 
375     public void setRoles(java.lang.String roles);
376 
377     public java.lang.String[] getRolesArray();
378 
379     public void setRolesArray(java.lang.String[] rolesArray);
380 
381     public java.util.Set<String> getUnlinkedRoles();
382 
383     public void setUnlinkedRoles(java.util.Set<String> unlinkedRoles);
384 
385     public java.util.Map<String, String> getRoleMappers();
386 
387     public void setRoleMappers(java.util.Map<String, String> roleMappers);
388 
389     public void linkRoles();
390 
391     public boolean hasRoleWithName(java.lang.String roleName);
392 
393     public boolean hasAddPortletPermission(long userId);
394 
395     public boolean getSystem();
396 
397     public boolean isSystem();
398 
399     public void setSystem(boolean system);
400 
401     public boolean getInclude();
402 
403     public boolean isInclude();
404 
405     public void setInclude(boolean include);
406 
407     public java.util.Map<String, String> getInitParams();
408 
409     public void setInitParams(java.util.Map<String, String> initParams);
410 
411     public java.lang.Integer getExpCache();
412 
413     public void setExpCache(java.lang.Integer expCache);
414 
415     public java.util.Map<String, java.util.Set<String>> getPortletModes();
416 
417     public void setPortletModes(
418         java.util.Map<String, java.util.Set<String>> portletModes);
419 
420     public boolean hasPortletMode(java.lang.String mimeType,
421         javax.portlet.PortletMode portletMode);
422 
423     public java.util.Set<String> getAllPortletModes();
424 
425     public boolean hasMultipleMimeTypes();
426 
427     public java.util.Set<String> getSupportedLocales();
428 
429     public void setSupportedLocales(java.util.Set<String> supportedLocales);
430 
431     public java.lang.String getResourceBundle();
432 
433     public void setResourceBundle(java.lang.String resourceBundle);
434 
435     public com.liferay.portal.model.PortletInfo getPortletInfo();
436 
437     public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo);
438 
439     public java.util.Map<String, com.liferay.portal.model.PortletFilter> getPortletFilters();
440 
441     public void setPortletFilters(
442         java.util.Map<String, com.liferay.portal.model.PortletFilter> portletFilters);
443 
444     public void addProcessingEvent(
445         com.liferay.portal.kernel.xml.QName processingEvent);
446 
447     public com.liferay.portal.kernel.xml.QName getProcessingEvent(
448         java.lang.String uri, java.lang.String localPart);
449 
450     public java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents();
451 
452     public void setProcessingEvents(
453         java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents);
454 
455     public void addPublishingEvent(
456         com.liferay.portal.kernel.xml.QName publishingEvent);
457 
458     public java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents();
459 
460     public void setPublishingEvents(
461         java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents);
462 
463     public void addPublicRenderParameter(
464         com.liferay.portal.model.PublicRenderParameter publicRenderParameter);
465 
466     public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
467         java.lang.String identifier);
468 
469     public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
470         java.lang.String uri, java.lang.String localPart);
471 
472     public java.util.Set<com.liferay.portal.model.PublicRenderParameter> getPublicRenderParameters();
473 
474     public void setPublicRenderParameters(
475         java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters);
476 
477     public boolean isRemote();
478 
479     public void setRemote(boolean remote);
480 
481     public java.lang.String getRemoteConsumerId();
482 
483     public void setRemoteConsumerId(java.lang.String remoteConsumerId);
484 
485     public java.lang.String getRemoteProducerEntityId();
486 
487     public void setRemoteProducerEntityId(
488         java.lang.String remoteProducerEntityId);
489 
490     public java.lang.String getRemotePortletHandle();
491 
492     public void setRemotePortletHandle(java.lang.String remotePortletHandle);
493 
494     public java.lang.String getRemotePortletId();
495 
496     public void setRemotePortletId(java.lang.String remotePortletId);
497 
498     public java.lang.String getContextPath();
499 
500     public com.liferay.portal.model.PortletApp getPortletApp();
501 
502     public void setPortletApp(com.liferay.portal.model.PortletApp portletApp);
503 
504     public com.liferay.portal.model.Portlet getClonedInstance(
505         java.lang.String portletId);
506 
507     public boolean getStatic();
508 
509     public boolean isStatic();
510 
511     public void setStatic(boolean staticPortlet);
512 
513     public boolean getStaticStart();
514 
515     public boolean isStaticStart();
516 
517     public void setStaticStart(boolean staticPortletStart);
518 
519     public boolean getStaticEnd();
520 
521     public boolean isStaticEnd();
522 
523     public boolean getUndeployedPortlet();
524 
525     public boolean isUndeployedPortlet();
526 
527     public void setUndeployedPortlet(boolean undeployedPortlet);
528 
529     public java.lang.Object clone();
530 
531     public int compareTo(com.liferay.portal.model.Portlet portlet);
532 
533     public boolean equals(java.lang.Object obj);
534 }