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 java.lang.String getPopMessageListenerClass();
152 
153     public void setPopMessageListenerClass(
154         java.lang.String popMessageListenerClass);
155 
156     public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance();
157 
158     public java.lang.String getSocialActivityInterpreterClass();
159 
160     public void setSocialActivityInterpreterClass(
161         java.lang.String socialActivityInterpreterClass);
162 
163     public com.liferay.portlet.social.model.SocialActivityInterpreter getSocialActivityInterpreterInstance();
164 
165     public java.lang.String getSocialRequestInterpreterClass();
166 
167     public void setSocialRequestInterpreterClass(
168         java.lang.String socialRequestInterpreterClass);
169 
170     public com.liferay.portlet.social.model.SocialRequestInterpreter getSocialRequestInterpreterInstance();
171 
172     public java.lang.String getDefaultPreferences();
173 
174     public void setDefaultPreferences(java.lang.String defaultPreferences);
175 
176     public java.lang.String getPreferencesValidator();
177 
178     public void setPreferencesValidator(java.lang.String prefsValidator);
179 
180     public boolean getPreferencesCompanyWide();
181 
182     public boolean isPreferencesCompanyWide();
183 
184     public void setPreferencesCompanyWide(boolean prefsCompanyWide);
185 
186     public boolean getPreferencesUniquePerLayout();
187 
188     public boolean isPreferencesUniquePerLayout();
189 
190     public void setPreferencesUniquePerLayout(boolean prefsUniquePerLayout);
191 
192     public boolean getPreferencesOwnedByGroup();
193 
194     public boolean isPreferencesOwnedByGroup();
195 
196     public void setPreferencesOwnedByGroup(boolean prefsOwnedByGroup);
197 
198     public boolean getUseDefaultTemplate();
199 
200     public boolean isUseDefaultTemplate();
201 
202     public void setUseDefaultTemplate(boolean useDefaultTemplate);
203 
204     public boolean getShowPortletAccessDenied();
205 
206     public boolean isShowPortletAccessDenied();
207 
208     public void setShowPortletAccessDenied(boolean showPortletAccessDenied);
209 
210     public boolean getShowPortletInactive();
211 
212     public boolean isShowPortletInactive();
213 
214     public void setShowPortletInactive(boolean showPortletInactive);
215 
216     public boolean getActionURLRedirect();
217 
218     public boolean isActionURLRedirect();
219 
220     public void setActionURLRedirect(boolean actionURLRedirect);
221 
222     public boolean getRestoreCurrentView();
223 
224     public boolean isRestoreCurrentView();
225 
226     public void setRestoreCurrentView(boolean restoreCurrentView);
227 
228     public boolean getMaximizeEdit();
229 
230     public boolean isMaximizeEdit();
231 
232     public void setMaximizeEdit(boolean maximizeEdit);
233 
234     public boolean getMaximizeHelp();
235 
236     public boolean isMaximizeHelp();
237 
238     public void setMaximizeHelp(boolean maximizeHelp);
239 
240     public boolean getPopUpPrint();
241 
242     public boolean isPopUpPrint();
243 
244     public void setPopUpPrint(boolean popUpPrint);
245 
246     public boolean getLayoutCacheable();
247 
248     public boolean isLayoutCacheable();
249 
250     public void setLayoutCacheable(boolean layoutCacheable);
251 
252     public boolean getInstanceable();
253 
254     public boolean isInstanceable();
255 
256     public void setInstanceable(boolean instanceable);
257 
258     public java.lang.String getUserPrincipalStrategy();
259 
260     public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy);
261 
262     public boolean getPrivateRequestAttributes();
263 
264     public boolean isPrivateRequestAttributes();
265 
266     public void setPrivateRequestAttributes(boolean privateRequestAttributes);
267 
268     public boolean getPrivateSessionAttributes();
269 
270     public boolean isPrivateSessionAttributes();
271 
272     public void setPrivateSessionAttributes(boolean privateSessionAttributes);
273 
274     public int getRenderWeight();
275 
276     public void setRenderWeight(int renderWeight);
277 
278     public boolean getAjaxable();
279 
280     public boolean isAjaxable();
281 
282     public void setAjaxable(boolean ajaxable);
283 
284     public java.util.List<String> getHeaderPortalCss();
285 
286     public void setHeaderPortalCss(java.util.List<String> headerPortalCss);
287 
288     public java.util.List<String> getHeaderPortletCss();
289 
290     public void setHeaderPortletCss(java.util.List<String> headerPortletCss);
291 
292     public java.util.List<String> getHeaderPortalJavaScript();
293 
294     public void setHeaderPortalJavaScript(
295         java.util.List<String> headerPortalJavaScript);
296 
297     public java.util.List<String> getHeaderPortletJavaScript();
298 
299     public void setHeaderPortletJavaScript(
300         java.util.List<String> headerPortletJavaScript);
301 
302     public java.util.List<String> getFooterPortalCss();
303 
304     public void setFooterPortalCss(java.util.List<String> footerPortalCss);
305 
306     public java.util.List<String> getFooterPortletCss();
307 
308     public void setFooterPortletCss(java.util.List<String> footerPortletCss);
309 
310     public java.util.List<String> getFooterPortalJavaScript();
311 
312     public void setFooterPortalJavaScript(
313         java.util.List<String> footerPortalJavaScript);
314 
315     public java.util.List<String> getFooterPortletJavaScript();
316 
317     public void setFooterPortletJavaScript(
318         java.util.List<String> footerPortletJavaScript);
319 
320     public java.lang.String getCssClassWrapper();
321 
322     public void setCssClassWrapper(java.lang.String cssClassWrapper);
323 
324     public java.lang.String getFacebookIntegration();
325 
326     public void setFacebookIntegration(java.lang.String facebookIntegration);
327 
328     public boolean getAddDefaultResource();
329 
330     public boolean isAddDefaultResource();
331 
332     public void setAddDefaultResource(boolean addDefaultResource);
333 
334     public void setRoles(java.lang.String roles);
335 
336     public java.lang.String[] getRolesArray();
337 
338     public void setRolesArray(java.lang.String[] rolesArray);
339 
340     public java.util.Set<String> getUnlinkedRoles();
341 
342     public void setUnlinkedRoles(java.util.Set<String> unlinkedRoles);
343 
344     public java.util.Map<String, String> getRoleMappers();
345 
346     public void setRoleMappers(java.util.Map<String, String> roleMappers);
347 
348     public void linkRoles();
349 
350     public boolean hasRoleWithName(java.lang.String roleName);
351 
352     public boolean hasAddPortletPermission(long userId);
353 
354     public boolean getSystem();
355 
356     public boolean isSystem();
357 
358     public void setSystem(boolean system);
359 
360     public boolean getInclude();
361 
362     public boolean isInclude();
363 
364     public void setInclude(boolean include);
365 
366     public java.util.Map<String, String> getInitParams();
367 
368     public void setInitParams(java.util.Map<String, String> initParams);
369 
370     public java.lang.Integer getExpCache();
371 
372     public void setExpCache(java.lang.Integer expCache);
373 
374     public java.util.Map<String, java.util.Set<String>> getPortletModes();
375 
376     public void setPortletModes(
377         java.util.Map<String, java.util.Set<String>> portletModes);
378 
379     public boolean hasPortletMode(java.lang.String mimeType,
380         javax.portlet.PortletMode portletMode);
381 
382     public java.util.Set<String> getAllPortletModes();
383 
384     public boolean hasMultipleMimeTypes();
385 
386     public java.util.Set<String> getSupportedLocales();
387 
388     public void setSupportedLocales(java.util.Set<String> supportedLocales);
389 
390     public java.lang.String getResourceBundle();
391 
392     public void setResourceBundle(java.lang.String resourceBundle);
393 
394     public com.liferay.portal.model.PortletInfo getPortletInfo();
395 
396     public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo);
397 
398     public java.util.Map<String, com.liferay.portal.model.PortletFilter> getPortletFilters();
399 
400     public void setPortletFilters(
401         java.util.Map<String, com.liferay.portal.model.PortletFilter> portletFilters);
402 
403     public void addProcessingEvent(javax.xml.namespace.QName processingEvent);
404 
405     public javax.xml.namespace.QName getProcessingEvent(java.lang.String uri,
406         java.lang.String localPart);
407 
408     public java.util.Set<javax.xml.namespace.QName> getProcessingEvents();
409 
410     public void setProcessingEvents(
411         java.util.Set<javax.xml.namespace.QName> processingEvents);
412 
413     public void addPublishingEvent(javax.xml.namespace.QName publishingEvent);
414 
415     public java.util.Set<javax.xml.namespace.QName> getPublishingEvents();
416 
417     public void setPublishingEvents(
418         java.util.Set<javax.xml.namespace.QName> publishingEvents);
419 
420     public void addPublicRenderParameter(
421         com.liferay.portal.model.PublicRenderParameter publicRenderParameter);
422 
423     public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
424         java.lang.String identifier);
425 
426     public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
427         java.lang.String uri, java.lang.String localPart);
428 
429     public java.util.Set<com.liferay.portal.model.PublicRenderParameter> getPublicRenderParameters();
430 
431     public void setPublicRenderParameters(
432         java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters);
433 
434     public java.lang.String getContextPath();
435 
436     public com.liferay.portal.model.PortletApp getPortletApp();
437 
438     public void setPortletApp(com.liferay.portal.model.PortletApp portletApp);
439 
440     public com.liferay.portal.model.Portlet getClonedInstance(
441         java.lang.String portletId);
442 
443     public boolean getStatic();
444 
445     public boolean isStatic();
446 
447     public void setStatic(boolean staticPortlet);
448 
449     public boolean getStaticStart();
450 
451     public boolean isStaticStart();
452 
453     public void setStaticStart(boolean staticPortletStart);
454 
455     public boolean getStaticEnd();
456 
457     public boolean isStaticEnd();
458 
459     public java.lang.Object clone();
460 
461     public int compareTo(java.lang.Object obj);
462 
463     public boolean equals(java.lang.Object obj);
464 }