001: /**
002: * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
003: *
004: * Permission is hereby granted, free of charge, to any person obtaining a copy
005: * of this software and associated documentation files (the "Software"), to deal
006: * in the Software without restriction, including without limitation the rights
007: * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
008: * copies of the Software, and to permit persons to whom the Software is
009: * furnished to do so, subject to the following conditions:
010: *
011: * The above copyright notice and this permission notice shall be included in
012: * all copies or substantial portions of the Software.
013: *
014: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
015: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
016: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
017: * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
018: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
019: * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
020: * SOFTWARE.
021: */package com.liferay.portal.model;
022:
023: /**
024: * <a href="Portlet.java.html"><b><i>View Source</i></b></a>
025: *
026: * <p>
027: * ServiceBuilder generated this class. Modifications in this class will be
028: * overwritten the next time is generated.
029: * </p>
030: *
031: * <p>
032: * This interface is a model that represents the <code>Portlet</code> table
033: * in the database.
034: * </p>
035: *
036: * <p>
037: * Customize <code>com.liferay.portal.service.model.impl.PortletImpl</code>
038: * and rerun the ServiceBuilder to generate the new methods.
039: * </p>
040: *
041: * @author Brian Wing Shun Chan
042: *
043: * @see com.liferay.portal.service.model.PortletModel
044: * @see com.liferay.portal.service.model.impl.PortletImpl
045: * @see com.liferay.portal.service.model.impl.PortletModelImpl
046: *
047: */
048: public interface Portlet extends PortletModel {
049: public java.lang.String getRootPortletId();
050:
051: public java.lang.String getInstanceId();
052:
053: public java.lang.String getPluginId();
054:
055: public java.lang.String getPluginType();
056:
057: public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage();
058:
059: public void setPluginPackage(
060: com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
061:
062: public com.liferay.portal.model.PluginSetting getDefaultPluginSetting();
063:
064: public void setDefaultPluginSetting(
065: com.liferay.portal.model.PluginSetting pluginSetting);
066:
067: public java.lang.String getIcon();
068:
069: public void setIcon(java.lang.String icon);
070:
071: public java.lang.String getVirtualPath();
072:
073: public void setVirtualPath(java.lang.String virtualPath);
074:
075: public java.lang.String getStrutsPath();
076:
077: public void setStrutsPath(java.lang.String strutsPath);
078:
079: public java.lang.String getDisplayName();
080:
081: public void setDisplayName(java.lang.String displayName);
082:
083: public java.lang.String getPortletClass();
084:
085: public void setPortletClass(java.lang.String portletClass);
086:
087: public java.lang.String getConfigurationActionClass();
088:
089: public void setConfigurationActionClass(
090: java.lang.String configurationActionClass);
091:
092: public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance();
093:
094: public java.lang.String getIndexerClass();
095:
096: public void setIndexerClass(java.lang.String indexerClass);
097:
098: public java.lang.String getOpenSearchClass();
099:
100: public void setOpenSearchClass(java.lang.String openSearchClass);
101:
102: public java.lang.String getSchedulerClass();
103:
104: public void setSchedulerClass(java.lang.String schedulerClass);
105:
106: public java.lang.String getPortletURLClass();
107:
108: public void setPortletURLClass(java.lang.String portletURLClass);
109:
110: public java.lang.String getFriendlyURLMapperClass();
111:
112: public void setFriendlyURLMapperClass(
113: java.lang.String friendlyURLMapperClass);
114:
115: public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance();
116:
117: public java.lang.String getURLEncoderClass();
118:
119: public void setURLEncoderClass(java.lang.String urlEncoderClass);
120:
121: public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance();
122:
123: public java.lang.String getPortletDataHandlerClass();
124:
125: public void setPortletDataHandlerClass(
126: java.lang.String portletDataHandlerClass);
127:
128: public com.liferay.portal.kernel.lar.PortletDataHandler getPortletDataHandlerInstance();
129:
130: public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListener();
131:
132: public java.lang.String getPortletLayoutListenerClass();
133:
134: public void setPortletLayoutListenerClass(
135: java.lang.String portletLayoutListenerClass);
136:
137: public java.lang.String getActivityTrackerInterpreterClass();
138:
139: public void setActivityTrackerInterpreterClass(
140: java.lang.String activityTrackerInterpreterClass);
141:
142: public com.liferay.portal.model.ActivityTrackerInterpreter getActivityTrackerInterpreterInstance();
143:
144: public java.lang.String getPopMessageListenerClass();
145:
146: public void setPopMessageListenerClass(
147: java.lang.String popMessageListenerClass);
148:
149: public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance();
150:
151: public java.lang.String getDefaultPreferences();
152:
153: public void setDefaultPreferences(
154: java.lang.String defaultPreferences);
155:
156: public java.lang.String getPreferencesValidator();
157:
158: public void setPreferencesValidator(java.lang.String prefsValidator);
159:
160: public boolean getPreferencesCompanyWide();
161:
162: public boolean isPreferencesCompanyWide();
163:
164: public void setPreferencesCompanyWide(boolean prefsCompanyWide);
165:
166: public boolean getPreferencesUniquePerLayout();
167:
168: public boolean isPreferencesUniquePerLayout();
169:
170: public void setPreferencesUniquePerLayout(
171: boolean prefsUniquePerLayout);
172:
173: public boolean getPreferencesOwnedByGroup();
174:
175: public boolean isPreferencesOwnedByGroup();
176:
177: public void setPreferencesOwnedByGroup(boolean prefsOwnedByGroup);
178:
179: public boolean getUseDefaultTemplate();
180:
181: public boolean isUseDefaultTemplate();
182:
183: public void setUseDefaultTemplate(boolean useDefaultTemplate);
184:
185: public boolean getShowPortletAccessDenied();
186:
187: public boolean isShowPortletAccessDenied();
188:
189: public void setShowPortletAccessDenied(
190: boolean showPortletAccessDenied);
191:
192: public boolean getShowPortletInactive();
193:
194: public boolean isShowPortletInactive();
195:
196: public void setShowPortletInactive(boolean showPortletInactive);
197:
198: public boolean getActionURLRedirect();
199:
200: public boolean isActionURLRedirect();
201:
202: public void setActionURLRedirect(boolean actionURLRedirect);
203:
204: public boolean getRestoreCurrentView();
205:
206: public boolean isRestoreCurrentView();
207:
208: public void setRestoreCurrentView(boolean restoreCurrentView);
209:
210: public boolean getMaximizeEdit();
211:
212: public boolean isMaximizeEdit();
213:
214: public void setMaximizeEdit(boolean maximizeEdit);
215:
216: public boolean getMaximizeHelp();
217:
218: public boolean isMaximizeHelp();
219:
220: public void setMaximizeHelp(boolean maximizeHelp);
221:
222: public boolean getPopUpPrint();
223:
224: public boolean isPopUpPrint();
225:
226: public void setPopUpPrint(boolean popUpPrint);
227:
228: public boolean getLayoutCacheable();
229:
230: public boolean isLayoutCacheable();
231:
232: public void setLayoutCacheable(boolean layoutCacheable);
233:
234: public boolean getInstanceable();
235:
236: public boolean isInstanceable();
237:
238: public void setInstanceable(boolean instanceable);
239:
240: public java.lang.String getUserPrincipalStrategy();
241:
242: public void setUserPrincipalStrategy(
243: java.lang.String userPrincipalStrategy);
244:
245: public boolean getPrivateRequestAttributes();
246:
247: public boolean isPrivateRequestAttributes();
248:
249: public void setPrivateRequestAttributes(
250: boolean privateRequestAttributes);
251:
252: public boolean getPrivateSessionAttributes();
253:
254: public boolean isPrivateSessionAttributes();
255:
256: public void setPrivateSessionAttributes(
257: boolean privateSessionAttributes);
258:
259: public int getRenderWeight();
260:
261: public void setRenderWeight(int renderWeight);
262:
263: public boolean getAjaxable();
264:
265: public boolean isAjaxable();
266:
267: public void setAjaxable(boolean ajaxable);
268:
269: public java.util.List getHeaderPortalCss();
270:
271: public void setHeaderPortalCss(java.util.List headerPortalCss);
272:
273: public java.util.List getHeaderPortletCss();
274:
275: public void setHeaderPortletCss(java.util.List headerPortletCss);
276:
277: public java.util.List getHeaderPortalJavaScript();
278:
279: public void setHeaderPortalJavaScript(
280: java.util.List headerPortalJavaScript);
281:
282: public java.util.List getHeaderPortletJavaScript();
283:
284: public void setHeaderPortletJavaScript(
285: java.util.List headerPortletJavaScript);
286:
287: public java.util.List getFooterPortalCss();
288:
289: public void setFooterPortalCss(java.util.List footerPortalCss);
290:
291: public java.util.List getFooterPortletCss();
292:
293: public void setFooterPortletCss(java.util.List footerPortletCss);
294:
295: public java.util.List getFooterPortalJavaScript();
296:
297: public void setFooterPortalJavaScript(
298: java.util.List footerPortalJavaScript);
299:
300: public java.util.List getFooterPortletJavaScript();
301:
302: public void setFooterPortletJavaScript(
303: java.util.List footerPortletJavaScript);
304:
305: public java.lang.String getCssClassWrapper();
306:
307: public void setCssClassWrapper(java.lang.String cssClassWrapper);
308:
309: public boolean getAddDefaultResource();
310:
311: public boolean isAddDefaultResource();
312:
313: public void setAddDefaultResource(boolean addDefaultResource);
314:
315: public void setRoles(java.lang.String roles);
316:
317: public java.lang.String[] getRolesArray();
318:
319: public void setRolesArray(java.lang.String[] rolesArray);
320:
321: public java.util.Set getUnlinkedRoles();
322:
323: public void setUnlinkedRoles(java.util.Set unlinkedRoles);
324:
325: public java.util.Map getRoleMappers();
326:
327: public void setRoleMappers(java.util.Map roleMappers);
328:
329: public void linkRoles();
330:
331: public boolean hasRoleWithName(java.lang.String roleName);
332:
333: public boolean hasAddPortletPermission(long userId);
334:
335: public boolean getSystem();
336:
337: public boolean isSystem();
338:
339: public void setSystem(boolean system);
340:
341: public boolean getInclude();
342:
343: public boolean isInclude();
344:
345: public void setInclude(boolean include);
346:
347: public java.util.Map getInitParams();
348:
349: public void setInitParams(java.util.Map initParams);
350:
351: public java.lang.Integer getExpCache();
352:
353: public void setExpCache(java.lang.Integer expCache);
354:
355: public java.util.Map getPortletModes();
356:
357: public void setPortletModes(java.util.Map portletModes);
358:
359: public boolean hasPortletMode(java.lang.String mimeType,
360: javax.portlet.PortletMode portletMode);
361:
362: public java.util.Set getAllPortletModes();
363:
364: public boolean hasMultipleMimeTypes();
365:
366: public java.util.Set getSupportedLocales();
367:
368: public void setSupportedLocales(java.util.Set 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(
377: com.liferay.portal.model.PortletInfo portletInfo);
378:
379: public java.util.Set getUserAttributes();
380:
381: public void setUserAttributes(java.util.Set userAttributes);
382:
383: public java.util.Map getCustomUserAttributes();
384:
385: public void setCustomUserAttributes(
386: java.util.Map customUserAttributes);
387:
388: public java.lang.String getServletContextName();
389:
390: public void setServletContextName(
391: java.lang.String servletContextName);
392:
393: public boolean getWARFile();
394:
395: public boolean isWARFile();
396:
397: public void setWARFile(boolean warFile);
398:
399: public java.lang.String getContextPath();
400:
401: public com.liferay.portal.model.Portlet getClonedInstance(
402: java.lang.String portletId);
403:
404: public boolean getStatic();
405:
406: public boolean isStatic();
407:
408: public void setStatic(boolean staticPortlet);
409:
410: public boolean getStaticStart();
411:
412: public boolean isStaticStart();
413:
414: public void setStaticStart(boolean staticPortletStart);
415:
416: public boolean getStaticEnd();
417:
418: public boolean isStaticEnd();
419:
420: public java.util.List getServletURLPatterns();
421:
422: public void setServletURLPatterns(java.util.List servletURLPatterns);
423:
424: public java.lang.Object clone();
425:
426: public int compareTo(java.lang.Object obj);
427:
428: public boolean equals(java.lang.Object obj);
429: }
|