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