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