com.liferay.portal.model
Interface Portlet

All Superinterfaces:
BaseModel<Portlet>, java.lang.Cloneable, java.lang.Comparable<Portlet>, PortletModel, java.io.Serializable
All Known Implementing Classes:
PortletWrapper

public interface Portlet
extends PortletModel

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This interface is a model that represents the Portlet table in the database.

Customize PortletImpl and rerun the ServiceBuilder to generate the new methods.

Author:
Brian Wing Shun Chan
See Also:
PortletModel, PortletImpl, PortletModelImpl
Generated:

Method Summary
 void addProcessingEvent(com.liferay.portal.kernel.xml.QName processingEvent)
          Adds a supported processing event.
 void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
          Adds a supported public render parameter.
 void addPublishingEvent(com.liferay.portal.kernel.xml.QName publishingEvent)
          Adds a supported publishing event.
 java.lang.Object clone()
          Creates and returns a copy of this object.
 int compareTo(Portlet portlet)
          Compares this portlet to the specified object.
 boolean equals(java.lang.Object obj)
          Checks whether this portlet is equal to the specified object.
 boolean getActionURLRedirect()
          Returns true if an action URL for this portlet should cause an auto redirect.
 boolean getAddDefaultResource()
          Returns true if default resources for the portlet are added to a page.
 boolean getAjaxable()
          Returns true if the portlet can be displayed via Ajax.
 java.util.Set<java.lang.String> getAllPortletModes()
          Gets a list of all portlet modes supported by the portlet.
 java.util.Set<java.lang.String> getAllWindowStates()
          Gets a list of all window states supported by the portlet.
 Portlet getClonedInstance(java.lang.String portletId)
          Returns true if the portlet is found in a WAR file.
 java.lang.String getConfigurationActionClass()
          Gets the configuration action class of the portlet.
 com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance()
          Gets the configuration action instance of the portlet.
 java.lang.String getContextPath()
          Gets the servlet context path of the portlet.
 java.lang.String getControlPanelEntryCategory()
          Gets the name of the category of the Control Panel where the portlet will be shown.
 java.lang.String getControlPanelEntryClass()
          Gets the name of the class that will control when the portlet will be shown in the Control Panel.
 ControlPanelEntry getControlPanelEntryInstance()
          Gets an instance of the class that will control when the portlet will be shown in the Control Panel.
 double getControlPanelEntryWeight()
          Gets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.
 java.lang.String getCssClassWrapper()
          Gets the name of the CSS class that will be injected in the DIV that wraps this portlet.
 PluginSetting getDefaultPluginSetting()
          Get the default plugin settings of the portlet.
 java.lang.String getDefaultPreferences()
          Gets the default preferences of the portlet.
 java.lang.String getDisplayName()
          Gets the display name of the portlet.
 java.lang.Integer getExpCache()
          Gets expiration cache of the portlet.
 java.lang.String getFacebookIntegration()
          Gets the Facebook integration method of the portlet.
 java.util.List<java.lang.String> getFooterPortalCss()
          Gets a list of CSS files that will be referenced from the page's footer relative to the portal's context path.
 java.util.List<java.lang.String> getFooterPortalJavaScript()
          Gets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.
 java.util.List<java.lang.String> getFooterPortletCss()
          Gets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.
 java.util.List<java.lang.String> getFooterPortletJavaScript()
          Gets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.
 java.lang.String getFriendlyURLMapperClass()
          Gets the name of the friendly URL mapper class of the portlet.
 com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance()
          Gets the friendly URL mapper instance of the portlet.
 java.util.List<java.lang.String> getHeaderPortalCss()
          Gets a list of CSS files that will be referenced from the page's header relative to the portal's context path.
 java.util.List<java.lang.String> getHeaderPortalJavaScript()
          Gets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.
 java.util.List<java.lang.String> getHeaderPortletCss()
          Gets a list of CSS files that will be referenced from the page's header relative to the portlet's context path.
 java.util.List<java.lang.String> getHeaderPortletJavaScript()
          Gets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.
 java.lang.String getIcon()
          Gets the icon of the portlet.
 boolean getInclude()
          Returns true to include the portlet and make it available to be made active.
 java.lang.String getIndexerClass()
          Gets the name of the indexer class of the portlet.
 com.liferay.portal.kernel.search.Indexer getIndexerInstance()
          Gets the indexer instance of the portlet.
 java.util.Map<java.lang.String,java.lang.String> getInitParams()
          Gets the init parameters of the portlet.
 boolean getInstanceable()
          Returns true if the portlet can be added multiple times to a layout.
 java.lang.String getInstanceId()
          Gets the instance id of the portlet.
 boolean getLayoutCacheable()
          Returns true to allow the portlet to be cached within the layout.
 boolean getMaximizeEdit()
          Returns true if the portlet goes into the maximized state when the user goes into the edit mode.
 boolean getMaximizeHelp()
          Returns true if the portlet goes into the maximized state when the user goes into the help mode.
 java.lang.String getOpenSearchClass()
          Gets the name of the open search class of the portlet.
 com.liferay.portal.kernel.search.OpenSearch getOpenSearchInstance()
          Gets the indexer instance of the portlet.
 java.lang.String getPluginId()
          Gets the plugin id of the portlet.
 com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage()
          Get the package to which the portlet belongs to.
 java.lang.String getPluginType()
          Gets the plugin type of the portlet.
 java.lang.String getPollerProcessorClass()
          Gets the name of the poller processor class of the portlet.
 com.liferay.portal.kernel.poller.PollerProcessor getPollerProcessorInstance()
          Gets the poller processor instance of the portlet.
 java.lang.String getPopMessageListenerClass()
          Gets the name of the POP message listener class of the portlet.
 com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance()
          Gets the POP message listener instance of the portlet.
 boolean getPopUpPrint()
          Returns true if the portlet goes into the pop up state when the user goes into the print mode.
 PortletApp getPortletApp()
          Get the application this portlet belongs to.
 java.lang.String getPortletClass()
          Gets the name of the portlet class of the portlet.
 java.lang.String getPortletDataHandlerClass()
          Gets the name of the portlet data handler class of the portlet.
 PortletDataHandler getPortletDataHandlerInstance()
          Gets the portlet data handler instance of the portlet.
 java.util.Map<java.lang.String,PortletFilter> getPortletFilters()
          Gets the filters of the portlet.
 PortletInfo getPortletInfo()
          Gets the portlet info of the portlet.
 java.lang.String getPortletLayoutListenerClass()
          Gets the name of the portlet layout listener class of the portlet.
 com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance()
          Gets the portlet layout listener instance of the portlet.
 java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getPortletModes()
          Gets the portlet modes of the portlet.
 java.lang.String getPortletName()
          Gets the name of the portlet.
 java.lang.String getPortletURLClass()
          Gets the name of the portlet URL class of the portlet.
 boolean getPreferencesCompanyWide()
          Returns true if preferences are shared across the entire company.
 boolean getPreferencesOwnedByGroup()
          Returns true if preferences are owned by the group when the portlet is shown in a group layout.
 boolean getPreferencesUniquePerLayout()
          Returns true if preferences are unique per layout.
 java.lang.String getPreferencesValidator()
          Gets the name of the preferences validator class of the portlet.
 boolean getPrivateRequestAttributes()
          Returns true if the portlet does not share request attributes with the portal or portlets from another WAR.
 boolean getPrivateSessionAttributes()
          Returns true if the portlet does not share session attributes with the portal.
 com.liferay.portal.kernel.xml.QName getProcessingEvent(java.lang.String uri, java.lang.String localPart)
          Gets the supported processing event from a namespace URI and a local part.
 java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents()
          Gets the supported processing events of the portlet.
 PublicRenderParameter getPublicRenderParameter(java.lang.String identifier)
          Gets the supported public render parameter from an identifier.
 PublicRenderParameter getPublicRenderParameter(java.lang.String uri, java.lang.String localPart)
          Gets the supported public render parameter from a namespace URI and a local part.
 java.util.Set<PublicRenderParameter> getPublicRenderParameters()
          Gets the supported public render parameters of the portlet.
 java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents()
          Gets the supported publishing events of the portlet.
 boolean getReady()
          Returns true if the portlet is ready to be used.
 int getRenderWeight()
          Returns the render weight of the portlet.
 java.lang.String getResourceBundle()
          Gets the resource bundle of the portlet.
 boolean getRestoreCurrentView()
          Returns true if the portlet restores to the current view from the maximized state.
 java.util.Map<java.lang.String,java.lang.String> getRoleMappers()
          Gets the role mappers of the portlet.
 java.lang.String[] getRolesArray()
          Gets an array of required roles of the portlet.
 java.lang.String getRootPortletId()
          Gets the root portlet id of the portlet.
 java.lang.String getSchedulerClass()
          Gets the name of the scheduler class of the portlet.
 com.liferay.portal.kernel.job.Scheduler getSchedulerInstance()
          Gets the scheduler instance of the portlet.
 boolean getScopeable()
          Returns true if the portlet supports scoping of data.
 boolean getShowPortletAccessDenied()
          Returns true if users are shown that they do not have access to the portlet.
 boolean getShowPortletInactive()
          Returns true if users are shown that the portlet is inactive.
 java.lang.String getSocialActivityInterpreterClass()
          Gets the name of the social activity interpreter class of the portlet.
 SocialActivityInterpreter getSocialActivityInterpreterInstance()
          Gets the name of the social activity interpreter instance of the portlet.
 java.lang.String getSocialRequestInterpreterClass()
          Gets the name of the social request interpreter class of the portlet.
 SocialRequestInterpreter getSocialRequestInterpreterInstance()
          Gets the name of the social request interpreter instance of the portlet.
 boolean getStatic()
          Returns true if the portlet is a static portlet that is cannot be moved.
 boolean getStaticEnd()
          Returns true if the portlet is a static portlet at the end of a list of portlets.
 boolean getStaticStart()
          Returns true if the portlet is a static portlet at the start of a list of portlets.
 java.lang.String getStrutsPath()
          Gets the struts path of the portlet.
 java.util.Set<java.lang.String> getSupportedLocales()
          Gets the supported locales of the portlet.
 boolean getSystem()
          Returns true if the portlet is a system portlet that a user cannot manually add to their page.
 long getTimestamp()
          Gets the timestamp of the portlet.
 boolean getUndeployedPortlet()
          Returns true if the portlet is an undeployed portlet.
 java.util.Set<java.lang.String> getUnlinkedRoles()
          Gets the unlinked roles of the portlet.
 java.lang.String getURLEncoderClass()
          Gets the name of the URL encoder class of the portlet.
 com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance()
          Gets the URL encoder instance of the portlet.
 boolean getUseDefaultTemplate()
          Returns true if the portlet uses the default template.
 java.lang.String getUserPrincipalStrategy()
          Gets the user principal strategy of the portlet.
 java.lang.String getVirtualPath()
          Gets the virtual path of the portlet.
 java.lang.String getWebDAVStorageClass()
          Gets the name of the WebDAV storage class of the portlet.
 WebDAVStorage getWebDAVStorageInstance()
          Gets the name of the WebDAV storage instance of the portlet.
 java.lang.String getWebDAVStorageToken()
          Gets the name of the WebDAV storage token of the portlet.
 java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getWindowStates()
          Gets the window states of the portlet.
 boolean hasAddPortletPermission(long userId)
          Returns true if the user has the permission to add the portlet to a layout.
 boolean hasMultipleMimeTypes()
          Returns true if the portlet supports more than one mime type.
 boolean hasPortletMode(java.lang.String mimeType, javax.portlet.PortletMode portletMode)
          Returns true if the portlet supports the specified mime type and portlet mode.
 boolean hasRoleWithName(java.lang.String roleName)
          Returns true if the portlet has a role with the specified name.
 boolean hasWindowState(java.lang.String mimeType, javax.portlet.WindowState windowState)
          Returns true if the portlet supports the specified mime type and window state.
 boolean isActionURLRedirect()
          Returns true if an action URL for this portlet should cause an auto redirect.
 boolean isAddDefaultResource()
          Returns true if default resources for the portlet are added to a page.
 boolean isAjaxable()
          Returns true if the portlet can be displayed via Ajax.
 boolean isInclude()
          Returns true to include the portlet and make it available to be made active.
 boolean isInstanceable()
          Returns true if the portlet can be added multiple times to a layout.
 boolean isLayoutCacheable()
          Returns true to allow the portlet to be cached within the layout.
 boolean isMaximizeEdit()
          Returns true if the portlet goes into the maximized state when the user goes into the edit mode.
 boolean isMaximizeHelp()
          Returns true if the portlet goes into the maximized state when the user goes into the help mode.
 boolean isPopUpPrint()
          Returns true if the portlet goes into the pop up state when the user goes into the print mode.
 boolean isPreferencesCompanyWide()
          Returns true if preferences are shared across the entire company.
 boolean isPreferencesOwnedByGroup()
          Returns true if preferences are owned by the group when the portlet is shown in a group layout.
 boolean isPreferencesUniquePerLayout()
          Returns true if preferences are unique per layout.
 boolean isPrivateRequestAttributes()
          Returns true if the portlet does not share request attributes with the portal or portlets from another WAR.
 boolean isPrivateSessionAttributes()
          Returns true if the portlet does not share session attributes with the portal.
 boolean isReady()
          Returns true if the portlet is ready to be used.
 boolean isRestoreCurrentView()
          Returns true if the portlet restores to the current view from the maximized state.
 boolean isScopeable()
          Returns true if the portlet supports scoping of data.
 boolean isShowPortletAccessDenied()
          Returns true if users are shown that they do not have access to the portlet.
 boolean isShowPortletInactive()
          Returns true if users are shown that the portlet is inactive.
 boolean isStatic()
          Returns true if the portlet is a static portlet that is cannot be moved.
 boolean isStaticEnd()
          Returns true if the portlet is a static portlet at the end of a list of portlets.
 boolean isStaticStart()
          Returns true if the portlet is a static portlet at the start of a list of portlets.
 boolean isSystem()
          Returns true if the portlet is a system portlet that a user cannot manually add to their page.
 boolean isUndeployedPortlet()
          Returns true if the portlet is an undeployed portlet.
 boolean isUseDefaultTemplate()
          Returns true if the portlet uses the default template.
 void linkRoles()
          Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml.
 void setActionURLRedirect(boolean actionURLRedirect)
          Set to true if an action URL for this portlet should cause an auto redirect.
 void setAddDefaultResource(boolean addDefaultResource)
          Set to true if default resources for the portlet are added to a page.
 void setAjaxable(boolean ajaxable)
          Set to true if the portlet can be displayed via Ajax.
 void setConfigurationActionClass(java.lang.String configurationActionClass)
          Sets the configuration action class of the portlet.
 void setControlPanelEntryCategory(java.lang.String controlPanelEntryCategory)
          Set the name of the category of the Control Panel where the portlet will be shown.
 void setControlPanelEntryClass(java.lang.String controlPanelEntryClass)
          Sets the name of the class that will control when the portlet will be shown in the Control Panel.
 void setControlPanelEntryWeight(double controlPanelEntryWeight)
          Sets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.
 void setCssClassWrapper(java.lang.String cssClassWrapper)
          Sets the name of the CSS class that will be injected in the DIV that wraps this portlet.
 void setDefaultPluginSetting(PluginSetting pluginSetting)
          Sets the default plugin settings of the portlet.
 void setDefaultPreferences(java.lang.String defaultPreferences)
          Sets the default preferences of the portlet.
 void setDisplayName(java.lang.String displayName)
          Sets the display name of the portlet.
 void setExpCache(java.lang.Integer expCache)
          Sets expiration cache of the portlet.
 void setFacebookIntegration(java.lang.String facebookIntegration)
          Sets the Facebook integration method of the portlet.
 void setFooterPortalCss(java.util.List<java.lang.String> footerPortalCss)
          Sets a list of CSS files that will be referenced from the page's footer relative to the portal's context path.
 void setFooterPortalJavaScript(java.util.List<java.lang.String> footerPortalJavaScript)
          Sets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.
 void setFooterPortletCss(java.util.List<java.lang.String> footerPortletCss)
          Sets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.
 void setFooterPortletJavaScript(java.util.List<java.lang.String> footerPortletJavaScript)
          Sets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.
 void setFriendlyURLMapperClass(java.lang.String friendlyURLMapperClass)
          Sets the name of the friendly URL mapper class of the portlet.
 void setHeaderPortalCss(java.util.List<java.lang.String> headerPortalCss)
          Sets a list of CSS files that will be referenced from the page's header relative to the portal's context path.
 void setHeaderPortalJavaScript(java.util.List<java.lang.String> headerPortalJavaScript)
          Sets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.
 void setHeaderPortletCss(java.util.List<java.lang.String> headerPortletCss)
          Sets a list of CSS files that will be referenced from the page's header relative to the portlet's context path.
 void setHeaderPortletJavaScript(java.util.List<java.lang.String> headerPortletJavaScript)
          Sets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.
 void setIcon(java.lang.String icon)
          Sets the icon of the portlet.
 void setInclude(boolean include)
          Set to true to include the portlet and make it available to be made active.
 void setIndexerClass(java.lang.String indexerClass)
          Sets the name of the indexer class of the portlet.
 void setInitParams(java.util.Map<java.lang.String,java.lang.String> initParams)
          Sets the init parameters of the portlet.
 void setInstanceable(boolean instanceable)
          Set to true if the portlet can be added multiple times to a layout.
 void setLayoutCacheable(boolean layoutCacheable)
          Set to true to allow the portlet to be cached within the layout.
 void setMaximizeEdit(boolean maximizeEdit)
          Set to true if the portlet goes into the maximized state when the user goes into the edit mode.
 void setMaximizeHelp(boolean maximizeHelp)
          Set to true if the portlet goes into the maximized state when the user goes into the help mode.
 void setOpenSearchClass(java.lang.String openSearchClass)
          Sets the name of the open search class of the portlet.
 void setPluginPackage(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
          Sets the plugin package this portlet belongs to.
 void setPollerProcessorClass(java.lang.String pollerProcessorClass)
          Sets the name of the poller processor class of the portlet.
 void setPopMessageListenerClass(java.lang.String popMessageListenerClass)
          Sets the name of the POP message listener class of the portlet.
 void setPopUpPrint(boolean popUpPrint)
          Set to true if the portlet goes into the pop up state when the user goes into the print mode.
 void setPortletApp(PortletApp portletApp)
          Sets the application this portlet belongs to.
 void setPortletClass(java.lang.String portletClass)
          Sets the name of the portlet class of the portlet.
 void setPortletDataHandlerClass(java.lang.String portletDataHandlerClass)
          Sets the name of the portlet data handler class of the portlet.
 void setPortletFilters(java.util.Map<java.lang.String,PortletFilter> portletFilters)
          Sets the filters of the portlet.
 void setPortletInfo(PortletInfo portletInfo)
          Sets the portlet info of the portlet.
 void setPortletLayoutListenerClass(java.lang.String portletLayoutListenerClass)
          Sets the name of the portlet layout listener class of the portlet.
 void setPortletModes(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> portletModes)
          Sets the portlet modes of the portlet.
 void setPortletName(java.lang.String portletName)
          Sets the name of the portlet.
 void setPortletURLClass(java.lang.String portletURLClass)
          Sets the name of the portlet URL class of the portlet.
 void setPreferencesCompanyWide(boolean preferencesCompanyWide)
          Set to true if preferences are shared across the entire company.
 void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
          Set to true if preferences are owned by the group when the portlet is shown in a group layout.
 void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
          Set to true if preferences are unique per layout.
 void setPreferencesValidator(java.lang.String preferencesValidator)
          Sets the name of the preferences validator class of the portlet.
 void setPrivateRequestAttributes(boolean privateRequestAttributes)
          Set to true if the portlet does not share request attributes with the portal or portlets from another WAR.
 void setPrivateSessionAttributes(boolean privateSessionAttributes)
          Set to true if the portlet does not share session attributes with the portal.
 void setProcessingEvents(java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents)
          Sets the supported processing events of the portlet.
 void setPublicRenderParameters(java.util.Set<PublicRenderParameter> publicRenderParameters)
          Sets the supported public render parameters of the portlet.
 void setPublishingEvents(java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents)
          Sets the supported publishing events of the portlet.
 void setReady(boolean ready)
          Set to true if the portlet is ready to be used.
 void setRenderWeight(int renderWeight)
          Sets the render weight of the portlet.
 void setResourceBundle(java.lang.String resourceBundle)
          Sets the resource bundle of the portlet.
 void setRestoreCurrentView(boolean restoreCurrentView)
          Set to true if the portlet restores to the current view from the maximized state.
 void setRoleMappers(java.util.Map<java.lang.String,java.lang.String> roleMappers)
          Sets the role mappers of the portlet.
 void setRoles(java.lang.String roles)
          Sets a string of ordered comma delimited portlet ids.
 void setRolesArray(java.lang.String[] rolesArray)
          Sets an array of required roles of the portlet.
 void setSchedulerClass(java.lang.String schedulerClass)
          Sets the name of the scheduler class of the portlet.
 void setScopeable(boolean scopeable)
          Set to true if the portlet supports scoping of data.
 void setShowPortletAccessDenied(boolean showPortletAccessDenied)
          Set to true if users are shown that they do not have access to the portlet.
 void setShowPortletInactive(boolean showPortletInactive)
          Set to true if users are shown that the portlet is inactive.
 void setSocialActivityInterpreterClass(java.lang.String socialActivityInterpreterClass)
          Sets the name of the social activity interpreter class of the portlet.
 void setSocialRequestInterpreterClass(java.lang.String socialRequestInterpreterClass)
          Sets the name of the social request interpreter class of the portlet.
 void setStatic(boolean staticPortlet)
          Set to true if the portlet is a static portlet that is cannot be moved.
 void setStaticStart(boolean staticPortletStart)
          Set to true if the portlet is a static portlet at the start of a list of portlets.
 void setStrutsPath(java.lang.String strutsPath)
          Sets the struts path of the portlet.
 void setSupportedLocales(java.util.Set<java.lang.String> supportedLocales)
          Sets the supported locales of the portlet.
 void setSystem(boolean system)
          Set to true if the portlet is a system portlet that a user cannot manually add to their page.
 void setTimestamp(long timestamp)
          Sets the timestamp of the portlet.
 void setUndeployedPortlet(boolean undeployedPortlet)
          Set to true if the portlet is an undeployed portlet.
 void setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles)
          Sets the unlinked roles of the portlet.
 void setURLEncoderClass(java.lang.String urlEncoderClass)
          Sets the name of the URL encoder class of the portlet.
 void setUseDefaultTemplate(boolean useDefaultTemplate)
          Set to true if the portlet uses the default template.
 void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy)
          Sets the user principal strategy of the portlet.
 void setVirtualPath(java.lang.String virtualPath)
          Sets the virtual path of the portlet.
 void setWebDAVStorageClass(java.lang.String webDAVStorageClass)
          Sets the name of the WebDAV storage class of the portlet.
 void setWebDAVStorageToken(java.lang.String webDAVStorageToken)
          Sets the name of the WebDAV storage token of the portlet.
 void setWindowStates(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> windowStates)
          Sets the window states of the portlet.
 
Methods inherited from interface com.liferay.portal.model.PortletModel
getActive, getCompanyId, getExpandoBridge, getId, getPortletId, getPrimaryKey, getPrimaryKeyObj, getRoles, hashCode, isActive, isCachedModel, isEscapedModel, isNew, setActive, setCachedModel, setCompanyId, setEscapedModel, setExpandoBridgeAttributes, setId, setNew, setPortletId, setPrimaryKey, toEscapedModel, toString, toXmlString
 

Method Detail

getRootPortletId

java.lang.String getRootPortletId()
Gets the root portlet id of the portlet.

Returns:
the root portlet id of the portlet

getInstanceId

java.lang.String getInstanceId()
Gets the instance id of the portlet.

Returns:
the instance id of the portlet

getPluginId

java.lang.String getPluginId()
Gets the plugin id of the portlet.

Returns:
the plugin id of the portlet

getPluginType

java.lang.String getPluginType()
Gets the plugin type of the portlet.

Returns:
the plugin type of the portlet

getPluginPackage

com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage()
Get the package to which the portlet belongs to.

Returns:
the plugin package of the portlet

setPluginPackage

void setPluginPackage(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
Sets the plugin package this portlet belongs to.

Parameters:
pluginPackage - the plugin package

getDefaultPluginSetting

PluginSetting getDefaultPluginSetting()
Get the default plugin settings of the portlet.

Returns:
the plugin settings

setDefaultPluginSetting

void setDefaultPluginSetting(PluginSetting pluginSetting)
Sets the default plugin settings of the portlet.

Parameters:
pluginSetting - the plugin setting

getTimestamp

long getTimestamp()
Gets the timestamp of the portlet.

Returns:
the timestamp of the portlet

setTimestamp

void setTimestamp(long timestamp)
Sets the timestamp of the portlet.

Parameters:
timestamp - the timestamp of the portlet

getIcon

java.lang.String getIcon()
Gets the icon of the portlet.

Returns:
the icon of the portlet

setIcon

void setIcon(java.lang.String icon)
Sets the icon of the portlet.

Parameters:
icon - the icon of the portlet

getVirtualPath

java.lang.String getVirtualPath()
Gets the virtual path of the portlet.

Returns:
the virtual path of the portlet

setVirtualPath

void setVirtualPath(java.lang.String virtualPath)
Sets the virtual path of the portlet.

Parameters:
virtualPath - the virtual path of the portlet

getStrutsPath

java.lang.String getStrutsPath()
Gets the struts path of the portlet.

Returns:
the struts path of the portlet

setStrutsPath

void setStrutsPath(java.lang.String strutsPath)
Sets the struts path of the portlet.

Parameters:
strutsPath - the struts path of the portlet

getPortletName

java.lang.String getPortletName()
Gets the name of the portlet.

Returns:
the display name of the portlet

setPortletName

void setPortletName(java.lang.String portletName)
Sets the name of the portlet.

Parameters:
portletName - the name of the portlet

getDisplayName

java.lang.String getDisplayName()
Gets the display name of the portlet.

Returns:
the display name of the portlet

setDisplayName

void setDisplayName(java.lang.String displayName)
Sets the display name of the portlet.

Parameters:
displayName - the display name of the portlet

getPortletClass

java.lang.String getPortletClass()
Gets the name of the portlet class of the portlet.

Returns:
the name of the portlet class of the portlet

setPortletClass

void setPortletClass(java.lang.String portletClass)
Sets the name of the portlet class of the portlet.

Parameters:
portletClass - the name of the portlet class of the portlet

getConfigurationActionClass

java.lang.String getConfigurationActionClass()
Gets the configuration action class of the portlet.

Returns:
the configuration action class of the portlet

setConfigurationActionClass

void setConfigurationActionClass(java.lang.String configurationActionClass)
Sets the configuration action class of the portlet.

Parameters:
configurationActionClass - the configuration action class of the portlet

getConfigurationActionInstance

com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance()
Gets the configuration action instance of the portlet.

Returns:
the configuration action instance of the portlet

getIndexerClass

java.lang.String getIndexerClass()
Gets the name of the indexer class of the portlet.

Returns:
the name of the indexer class of the portlet

setIndexerClass

void setIndexerClass(java.lang.String indexerClass)
Sets the name of the indexer class of the portlet.

Parameters:
indexerClass - the name of the indexer class of the portlet

getIndexerInstance

com.liferay.portal.kernel.search.Indexer getIndexerInstance()
Gets the indexer instance of the portlet.

Returns:
the indexer instance of the portlet

getOpenSearchClass

java.lang.String getOpenSearchClass()
Gets the name of the open search class of the portlet.

Returns:
the name of the open search class of the portlet

setOpenSearchClass

void setOpenSearchClass(java.lang.String openSearchClass)
Sets the name of the open search class of the portlet.

Parameters:
openSearchClass - the name of the open search class of the portlet

getOpenSearchInstance

com.liferay.portal.kernel.search.OpenSearch getOpenSearchInstance()
Gets the indexer instance of the portlet.

Returns:
the indexer instance of the portlet

getSchedulerClass

java.lang.String getSchedulerClass()
Gets the name of the scheduler class of the portlet.

Returns:
the name of the scheduler class of the portlet

setSchedulerClass

void setSchedulerClass(java.lang.String schedulerClass)
Sets the name of the scheduler class of the portlet.

Parameters:
schedulerClass - the name of the scheduler class of the portlet

getSchedulerInstance

com.liferay.portal.kernel.job.Scheduler getSchedulerInstance()
Gets the scheduler instance of the portlet.

Returns:
the scheduler instance of the portlet

getPortletURLClass

java.lang.String getPortletURLClass()
Gets the name of the portlet URL class of the portlet.

Returns:
the name of the portlet URL class of the portlet

setPortletURLClass

void setPortletURLClass(java.lang.String portletURLClass)
Sets the name of the portlet URL class of the portlet.

Parameters:
portletURLClass - the name of the portlet URL class of the portlet

getFriendlyURLMapperClass

java.lang.String getFriendlyURLMapperClass()
Gets the name of the friendly URL mapper class of the portlet.

Returns:
the name of the friendly URL mapper class of the portlet

setFriendlyURLMapperClass

void setFriendlyURLMapperClass(java.lang.String friendlyURLMapperClass)
Sets the name of the friendly URL mapper class of the portlet.

Parameters:
friendlyURLMapperClass - the name of the friendly URL mapper class of the portlet

getFriendlyURLMapperInstance

com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance()
Gets the friendly URL mapper instance of the portlet.

Returns:
the friendly URL mapper instance of the portlet

getURLEncoderClass

java.lang.String getURLEncoderClass()
Gets the name of the URL encoder class of the portlet.

Returns:
the name of the URL encoder class of the portlet

setURLEncoderClass

void setURLEncoderClass(java.lang.String urlEncoderClass)
Sets the name of the URL encoder class of the portlet.

Parameters:
urlEncoderClass - the name of the URL encoder class of the portlet

getURLEncoderInstance

com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance()
Gets the URL encoder instance of the portlet.

Returns:
the URL encoder instance of the portlet

getPortletDataHandlerClass

java.lang.String getPortletDataHandlerClass()
Gets the name of the portlet data handler class of the portlet.

Returns:
the name of the portlet data handler class of the portlet

setPortletDataHandlerClass

void setPortletDataHandlerClass(java.lang.String portletDataHandlerClass)
Sets the name of the portlet data handler class of the portlet.

Parameters:
portletDataHandlerClass - the name of portlet data handler class of the portlet

getPortletDataHandlerInstance

PortletDataHandler getPortletDataHandlerInstance()
Gets the portlet data handler instance of the portlet.

Returns:
the portlet data handler instance of the portlet

getPortletLayoutListenerClass

java.lang.String getPortletLayoutListenerClass()
Gets the name of the portlet layout listener class of the portlet.

Returns:
the name of the portlet layout listener class of the portlet

setPortletLayoutListenerClass

void setPortletLayoutListenerClass(java.lang.String portletLayoutListenerClass)
Sets the name of the portlet layout listener class of the portlet.

Parameters:
portletLayoutListenerClass - the name of the portlet layout listener class of the portlet

getPortletLayoutListenerInstance

com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance()
Gets the portlet layout listener instance of the portlet.

Returns:
the portlet layout listener instance of the portlet

getPollerProcessorClass

java.lang.String getPollerProcessorClass()
Gets the name of the poller processor class of the portlet.

Returns:
the name of the poller processor class of the portlet

setPollerProcessorClass

void setPollerProcessorClass(java.lang.String pollerProcessorClass)
Sets the name of the poller processor class of the portlet.

Parameters:
pollerProcessorClass - the name of the poller processor class of the portlet

getPollerProcessorInstance

com.liferay.portal.kernel.poller.PollerProcessor getPollerProcessorInstance()
Gets the poller processor instance of the portlet.

Returns:
the poller processor instance of the portlet

getPopMessageListenerClass

java.lang.String getPopMessageListenerClass()
Gets the name of the POP message listener class of the portlet.

Returns:
the name of the POP message listener class of the portlet

setPopMessageListenerClass

void setPopMessageListenerClass(java.lang.String popMessageListenerClass)
Sets the name of the POP message listener class of the portlet.

Parameters:
popMessageListenerClass - the name of the POP message listener class of the portlet

getPopMessageListenerInstance

com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance()
Gets the POP message listener instance of the portlet.

Returns:
the POP message listener instance of the portlet

getSocialActivityInterpreterClass

java.lang.String getSocialActivityInterpreterClass()
Gets the name of the social activity interpreter class of the portlet.

Returns:
the name of the social activity interpreter class of the portlet

setSocialActivityInterpreterClass

void setSocialActivityInterpreterClass(java.lang.String socialActivityInterpreterClass)
Sets the name of the social activity interpreter class of the portlet.

Parameters:
socialActivityInterpreterClass - the name of the activity interpreter class of the portlet

getSocialActivityInterpreterInstance

SocialActivityInterpreter getSocialActivityInterpreterInstance()
Gets the name of the social activity interpreter instance of the portlet.

Returns:
the name of the social activity interpreter instance of the portlet

getSocialRequestInterpreterClass

java.lang.String getSocialRequestInterpreterClass()
Gets the name of the social request interpreter class of the portlet.

Returns:
the name of the social request interpreter class of the portlet

setSocialRequestInterpreterClass

void setSocialRequestInterpreterClass(java.lang.String socialRequestInterpreterClass)
Sets the name of the social request interpreter class of the portlet.

Parameters:
socialRequestInterpreterClass - the name of the request interpreter class of the portlet

getSocialRequestInterpreterInstance

SocialRequestInterpreter getSocialRequestInterpreterInstance()
Gets the name of the social request interpreter instance of the portlet.

Returns:
the name of the social request interpreter instance of the portlet

getWebDAVStorageToken

java.lang.String getWebDAVStorageToken()
Gets the name of the WebDAV storage token of the portlet.

Returns:
the name of the WebDAV storage token of the portlet

setWebDAVStorageToken

void setWebDAVStorageToken(java.lang.String webDAVStorageToken)
Sets the name of the WebDAV storage token of the portlet.

Parameters:
webDAVStorageToken - the name of the WebDAV storage token of the portlet

getWebDAVStorageClass

java.lang.String getWebDAVStorageClass()
Gets the name of the WebDAV storage class of the portlet.

Returns:
the name of the WebDAV storage class of the portlet

setWebDAVStorageClass

void setWebDAVStorageClass(java.lang.String webDAVStorageClass)
Sets the name of the WebDAV storage class of the portlet.

Parameters:
webDAVStorageClass - the name of the WebDAV storage class of the portlet

getWebDAVStorageInstance

WebDAVStorage getWebDAVStorageInstance()
Gets the name of the WebDAV storage instance of the portlet.

Returns:
the name of the WebDAV storage instance of the portlet

getControlPanelEntryCategory

java.lang.String getControlPanelEntryCategory()
Gets the name of the category of the Control Panel where the portlet will be shown.

Returns:
the name of of the category of the Control Panel where the portlet will be shown

setControlPanelEntryCategory

void setControlPanelEntryCategory(java.lang.String controlPanelEntryCategory)
Set the name of the category of the Control Panel where the portlet will be shown.

Parameters:
controlPanelEntryCategory - the name of the category of the Control Panel where the portlet will be shown

getControlPanelEntryWeight

double getControlPanelEntryWeight()
Gets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.

Returns:
the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel

setControlPanelEntryWeight

void setControlPanelEntryWeight(double controlPanelEntryWeight)
Sets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.

Parameters:
controlPanelEntryWeight - the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel

getControlPanelEntryClass

java.lang.String getControlPanelEntryClass()
Gets the name of the class that will control when the portlet will be shown in the Control Panel.

Returns:
the name of the class that will control when the portlet will be shown in the Control Panel

setControlPanelEntryClass

void setControlPanelEntryClass(java.lang.String controlPanelEntryClass)
Sets the name of the class that will control when the portlet will be shown in the Control Panel.

Parameters:
controlPanelEntryClass - the name of the class that will control when the portlet will be shown in the Control Panel

getControlPanelEntryInstance

ControlPanelEntry getControlPanelEntryInstance()
Gets an instance of the class that will control when the portlet will be shown in the Control Panel.

Returns:
the instance of the class that will control when the portlet will be shown in the Control Panel

getDefaultPreferences

java.lang.String getDefaultPreferences()
Gets the default preferences of the portlet.

Returns:
the default preferences of the portlet

setDefaultPreferences

void setDefaultPreferences(java.lang.String defaultPreferences)
Sets the default preferences of the portlet.

Parameters:
defaultPreferences - the default preferences of the portlet

getPreferencesValidator

java.lang.String getPreferencesValidator()
Gets the name of the preferences validator class of the portlet.

Returns:
the name of the preferences validator class of the portlet

setPreferencesValidator

void setPreferencesValidator(java.lang.String preferencesValidator)
Sets the name of the preferences validator class of the portlet.

Parameters:
preferencesValidator - the name of the preferences validator class of the portlet

getPreferencesCompanyWide

boolean getPreferencesCompanyWide()
Returns true if preferences are shared across the entire company.

Returns:
true if preferences are shared across the entire company

isPreferencesCompanyWide

boolean isPreferencesCompanyWide()
Returns true if preferences are shared across the entire company.

Returns:
true if preferences are shared across the entire company

setPreferencesCompanyWide

void setPreferencesCompanyWide(boolean preferencesCompanyWide)
Set to true if preferences are shared across the entire company.

Parameters:
preferencesCompanyWide - boolean value for whether preferences are shared across the entire company

getPreferencesUniquePerLayout

boolean getPreferencesUniquePerLayout()
Returns true if preferences are unique per layout.

Returns:
true if preferences are unique per layout

isPreferencesUniquePerLayout

boolean isPreferencesUniquePerLayout()
Returns true if preferences are unique per layout.

Returns:
true if preferences are unique per layout

setPreferencesUniquePerLayout

void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
Set to true if preferences are unique per layout.

Parameters:
preferencesUniquePerLayout - boolean value for whether preferences are unique per layout

getPreferencesOwnedByGroup

boolean getPreferencesOwnedByGroup()
Returns true if preferences are owned by the group when the portlet is shown in a group layout. Returns false if preferences are owned by the user at all times.

Returns:
true if preferences are owned by the group when the portlet is shown in a group layout; false if preferences are owned by the user at all times.

isPreferencesOwnedByGroup

boolean isPreferencesOwnedByGroup()
Returns true if preferences are owned by the group when the portlet is shown in a group layout. Returns false if preferences are owned by the user at all times.

Returns:
true if preferences are owned by the group when the portlet is shown in a group layout; false if preferences are owned by the user at all times.

setPreferencesOwnedByGroup

void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
Set to true if preferences are owned by the group when the portlet is shown in a group layout. Set to false if preferences are owned by the user at all times.

Parameters:
preferencesOwnedByGroup - boolean value for whether preferences are owned by the group when the portlet is shown in a group layout or preferences are owned by the user at all times

getUseDefaultTemplate

boolean getUseDefaultTemplate()
Returns true if the portlet uses the default template.

Returns:
true if the portlet uses the default template

isUseDefaultTemplate

boolean isUseDefaultTemplate()
Returns true if the portlet uses the default template.

Returns:
true if the portlet uses the default template

setUseDefaultTemplate

void setUseDefaultTemplate(boolean useDefaultTemplate)
Set to true if the portlet uses the default template.

Parameters:
useDefaultTemplate - boolean value for whether the portlet uses the default template

getShowPortletAccessDenied

boolean getShowPortletAccessDenied()
Returns true if users are shown that they do not have access to the portlet.

Returns:
true if users are shown that they do not have access to the portlet

isShowPortletAccessDenied

boolean isShowPortletAccessDenied()
Returns true if users are shown that they do not have access to the portlet.

Returns:
true if users are shown that they do not have access to the portlet

setShowPortletAccessDenied

void setShowPortletAccessDenied(boolean showPortletAccessDenied)
Set to true if users are shown that they do not have access to the portlet.

Parameters:
showPortletAccessDenied - boolean value for whether users are shown that they do not have access to the portlet

getShowPortletInactive

boolean getShowPortletInactive()
Returns true if users are shown that the portlet is inactive.

Returns:
true if users are shown that the portlet is inactive

isShowPortletInactive

boolean isShowPortletInactive()
Returns true if users are shown that the portlet is inactive.

Returns:
true if users are shown that the portlet is inactive

setShowPortletInactive

void setShowPortletInactive(boolean showPortletInactive)
Set to true if users are shown that the portlet is inactive.

Parameters:
showPortletInactive - boolean value for whether users are shown that the portlet is inactive

getActionURLRedirect

boolean getActionURLRedirect()
Returns true if an action URL for this portlet should cause an auto redirect.

Returns:
true if an action URL for this portlet should cause an auto redirect

isActionURLRedirect

boolean isActionURLRedirect()
Returns true if an action URL for this portlet should cause an auto redirect.

Returns:
true if an action URL for this portlet should cause an auto redirect

setActionURLRedirect

void setActionURLRedirect(boolean actionURLRedirect)
Set to true if an action URL for this portlet should cause an auto redirect.

Parameters:
actionURLRedirect - boolean value for whether an action URL for this portlet should cause an auto redirect

getRestoreCurrentView

boolean getRestoreCurrentView()
Returns true if the portlet restores to the current view from the maximized state.

Returns:
true if the portlet restores to the current view from the maximized state

isRestoreCurrentView

boolean isRestoreCurrentView()
Returns true if the portlet restores to the current view from the maximized state.

Returns:
true if the portlet restores to the current view from the maximized state

setRestoreCurrentView

void setRestoreCurrentView(boolean restoreCurrentView)
Set to true if the portlet restores to the current view from the maximized state.

Parameters:
restoreCurrentView - boolean value for whether the portlet restores to the current view from the maximized state

getMaximizeEdit

boolean getMaximizeEdit()
Returns true if the portlet goes into the maximized state when the user goes into the edit mode.

Returns:
true if the portlet goes into the maximized state when the user goes into the edit mode

isMaximizeEdit

boolean isMaximizeEdit()
Returns true if the portlet goes into the maximized state when the user goes into the edit mode.

Returns:
true if the portlet goes into the maximized state when the user goes into the edit mode

setMaximizeEdit

void setMaximizeEdit(boolean maximizeEdit)
Set to true if the portlet goes into the maximized state when the user goes into the edit mode.

Parameters:
maximizeEdit - boolean value for whether the portlet goes into the maximized state when the user goes into the edit mode

getMaximizeHelp

boolean getMaximizeHelp()
Returns true if the portlet goes into the maximized state when the user goes into the help mode.

Returns:
true if the portlet goes into the maximized state when the user goes into the help mode

isMaximizeHelp

boolean isMaximizeHelp()
Returns true if the portlet goes into the maximized state when the user goes into the help mode.

Returns:
true if the portlet goes into the maximized state when the user goes into the help mode

setMaximizeHelp

void setMaximizeHelp(boolean maximizeHelp)
Set to true if the portlet goes into the maximized state when the user goes into the help mode.

Parameters:
maximizeHelp - boolean value for whether the portlet goes into the maximized state when the user goes into the help mode

getPopUpPrint

boolean getPopUpPrint()
Returns true if the portlet goes into the pop up state when the user goes into the print mode.

Returns:
true if the portlet goes into the pop up state when the user goes into the print mode

isPopUpPrint

boolean isPopUpPrint()
Returns true if the portlet goes into the pop up state when the user goes into the print mode.

Returns:
true if the portlet goes into the pop up state when the user goes into the print mode

setPopUpPrint

void setPopUpPrint(boolean popUpPrint)
Set to true if the portlet goes into the pop up state when the user goes into the print mode.

Parameters:
popUpPrint - boolean value for whether the portlet goes into the pop up state when the user goes into the print mode

getLayoutCacheable

boolean getLayoutCacheable()
Returns true to allow the portlet to be cached within the layout.

Returns:
true if the portlet can be cached within the layout

isLayoutCacheable

boolean isLayoutCacheable()
Returns true to allow the portlet to be cached within the layout.

Returns:
true if the portlet can be cached within the layout

setLayoutCacheable

void setLayoutCacheable(boolean layoutCacheable)
Set to true to allow the portlet to be cached within the layout.

Parameters:
layoutCacheable - boolean value for whether the portlet can be cached within the layout

getInstanceable

boolean getInstanceable()
Returns true if the portlet can be added multiple times to a layout.

Returns:
true if the portlet can be added multiple times to a layout

isInstanceable

boolean isInstanceable()
Returns true if the portlet can be added multiple times to a layout.

Returns:
true if the portlet can be added multiple times to a layout

setInstanceable

void setInstanceable(boolean instanceable)
Set to true if the portlet can be added multiple times to a layout.

Parameters:
instanceable - boolean value for whether the portlet can be added multiple times to a layout

getScopeable

boolean getScopeable()
Returns true if the portlet supports scoping of data.

Returns:
true if the portlet supports scoping of data

isScopeable

boolean isScopeable()
Returns true if the portlet supports scoping of data.

Returns:
true if the portlet supports scoping of data

setScopeable

void setScopeable(boolean scopeable)
Set to true if the portlet supports scoping of data.

Parameters:
scopeable - boolean value for whether or not the the portlet supports scoping of data

getUserPrincipalStrategy

java.lang.String getUserPrincipalStrategy()
Gets the user principal strategy of the portlet.

Returns:
the user principal strategy of the portlet

setUserPrincipalStrategy

void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy)
Sets the user principal strategy of the portlet.

Parameters:
userPrincipalStrategy - the user principal strategy of the portlet

getPrivateRequestAttributes

boolean getPrivateRequestAttributes()
Returns true if the portlet does not share request attributes with the portal or portlets from another WAR.

Returns:
true if the portlet does not share request attributes with the portal or portlets from another WAR

isPrivateRequestAttributes

boolean isPrivateRequestAttributes()
Returns true if the portlet does not share request attributes with the portal or portlets from another WAR.

Returns:
true if the portlet does not share request attributes with the portal or portlets from another WAR

setPrivateRequestAttributes

void setPrivateRequestAttributes(boolean privateRequestAttributes)
Set to true if the portlet does not share request attributes with the portal or portlets from another WAR.

Parameters:
privateRequestAttributes - boolean value for whether the portlet shares request attributes with the portal or portlets from another WAR

getPrivateSessionAttributes

boolean getPrivateSessionAttributes()
Returns true if the portlet does not share session attributes with the portal.

Returns:
true if the portlet does not share session attributes with the portal

isPrivateSessionAttributes

boolean isPrivateSessionAttributes()
Returns true if the portlet does not share session attributes with the portal.

Returns:
true if the portlet does not share session attributes with the portal

setPrivateSessionAttributes

void setPrivateSessionAttributes(boolean privateSessionAttributes)
Set to true if the portlet does not share session attributes with the portal.

Parameters:
privateSessionAttributes - boolean value for whether the portlet shares session attributes with the portal

getRenderWeight

int getRenderWeight()
Returns the render weight of the portlet.

Returns:
the render weight of the portlet

setRenderWeight

void setRenderWeight(int renderWeight)
Sets the render weight of the portlet.

Parameters:
renderWeight - int value for the render weight of the portlet

getAjaxable

boolean getAjaxable()
Returns true if the portlet can be displayed via Ajax.

Returns:
true if the portlet can be displayed via Ajax

isAjaxable

boolean isAjaxable()
Returns true if the portlet can be displayed via Ajax.

Returns:
true if the portlet can be displayed via Ajax

setAjaxable

void setAjaxable(boolean ajaxable)
Set to true if the portlet can be displayed via Ajax.

Parameters:
ajaxable - boolean value for whether the portlet can be displayed via Ajax

getHeaderPortalCss

java.util.List<java.lang.String> getHeaderPortalCss()
Gets a list of CSS files that will be referenced from the page's header relative to the portal's context path.

Returns:
a list of CSS files that will be referenced from the page's header relative to the portal's context path

setHeaderPortalCss

void setHeaderPortalCss(java.util.List<java.lang.String> headerPortalCss)
Sets a list of CSS files that will be referenced from the page's header relative to the portal's context path.

Parameters:
headerPortalCss - a list of CSS files that will be referenced from the page's header relative to the portal's context path

getHeaderPortletCss

java.util.List<java.lang.String> getHeaderPortletCss()
Gets a list of CSS files that will be referenced from the page's header relative to the portlet's context path.

Returns:
a list of CSS files that will be referenced from the page's header relative to the portlet's context path

setHeaderPortletCss

void setHeaderPortletCss(java.util.List<java.lang.String> headerPortletCss)
Sets a list of CSS files that will be referenced from the page's header relative to the portlet's context path.

Parameters:
headerPortletCss - a list of CSS files that will be referenced from the page's header relative to the portlet's context path

getHeaderPortalJavaScript

java.util.List<java.lang.String> getHeaderPortalJavaScript()
Gets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.

Returns:
a list of JavaScript files that will be referenced from the page's header relative to the portal's context path

setHeaderPortalJavaScript

void setHeaderPortalJavaScript(java.util.List<java.lang.String> headerPortalJavaScript)
Sets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.

Parameters:
headerPortalJavaScript - a list of JavaScript files that will be referenced from the page's header relative to the portal's context path

getHeaderPortletJavaScript

java.util.List<java.lang.String> getHeaderPortletJavaScript()
Gets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.

Returns:
a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path

setHeaderPortletJavaScript

void setHeaderPortletJavaScript(java.util.List<java.lang.String> headerPortletJavaScript)
Sets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.

Parameters:
headerPortletJavaScript - a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path

getFooterPortalCss

java.util.List<java.lang.String> getFooterPortalCss()
Gets a list of CSS files that will be referenced from the page's footer relative to the portal's context path.

Returns:
a list of CSS files that will be referenced from the page's footer relative to the portal's context path

setFooterPortalCss

void setFooterPortalCss(java.util.List<java.lang.String> footerPortalCss)
Sets a list of CSS files that will be referenced from the page's footer relative to the portal's context path.

Parameters:
footerPortalCss - a list of CSS files that will be referenced from the page's footer relative to the portal's context path

getFooterPortletCss

java.util.List<java.lang.String> getFooterPortletCss()
Gets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.

Returns:
a list of CSS files that will be referenced from the page's footer relative to the portlet's context path

setFooterPortletCss

void setFooterPortletCss(java.util.List<java.lang.String> footerPortletCss)
Sets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.

Parameters:
footerPortletCss - a list of CSS files that will be referenced from the page's footer relative to the portlet's context path

getFooterPortalJavaScript

java.util.List<java.lang.String> getFooterPortalJavaScript()
Gets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.

Returns:
a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path

setFooterPortalJavaScript

void setFooterPortalJavaScript(java.util.List<java.lang.String> footerPortalJavaScript)
Sets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.

Parameters:
footerPortalJavaScript - a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path

getFooterPortletJavaScript

java.util.List<java.lang.String> getFooterPortletJavaScript()
Gets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.

Returns:
a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path

setFooterPortletJavaScript

void setFooterPortletJavaScript(java.util.List<java.lang.String> footerPortletJavaScript)
Sets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.

Parameters:
footerPortletJavaScript - a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path

getCssClassWrapper

java.lang.String getCssClassWrapper()
Gets the name of the CSS class that will be injected in the DIV that wraps this portlet.

Returns:
the name of the CSS class that will be injected in the DIV that wraps this portlet

setCssClassWrapper

void setCssClassWrapper(java.lang.String cssClassWrapper)
Sets the name of the CSS class that will be injected in the DIV that wraps this portlet.

Parameters:
cssClassWrapper - the name of the CSS class that will be injected in the DIV that wraps this portlet

getFacebookIntegration

java.lang.String getFacebookIntegration()
Gets the Facebook integration method of the portlet.

Returns:
the Facebook integration method of the portlet

setFacebookIntegration

void setFacebookIntegration(java.lang.String facebookIntegration)
Sets the Facebook integration method of the portlet.

Parameters:
facebookIntegration - the Facebook integration method of the portlet

getAddDefaultResource

boolean getAddDefaultResource()
Returns true if default resources for the portlet are added to a page.

Returns:
true if default resources for the portlet are added to a page

isAddDefaultResource

boolean isAddDefaultResource()
Returns true if default resources for the portlet are added to a page.

Returns:
true if default resources for the portlet are added to a page

setAddDefaultResource

void setAddDefaultResource(boolean addDefaultResource)
Set to true if default resources for the portlet are added to a page.

Parameters:
addDefaultResource - boolean value for whether or not default resources for the portlet are added to a page

setRoles

void setRoles(java.lang.String roles)
Sets a string of ordered comma delimited portlet ids.

Specified by:
setRoles in interface PortletModel
Parameters:
roles - a string of ordered comma delimited portlet ids

getRolesArray

java.lang.String[] getRolesArray()
Gets an array of required roles of the portlet.

Returns:
an array of required roles of the portlet

setRolesArray

void setRolesArray(java.lang.String[] rolesArray)
Sets an array of required roles of the portlet.

Parameters:
rolesArray - an array of required roles of the portlet

getUnlinkedRoles

java.util.Set<java.lang.String> getUnlinkedRoles()
Gets the unlinked roles of the portlet.

Returns:
unlinked roles of the portlet

setUnlinkedRoles

void setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles)
Sets the unlinked roles of the portlet.

Parameters:
unlinkedRoles - the unlinked roles of the portlet

getRoleMappers

java.util.Map<java.lang.String,java.lang.String> getRoleMappers()
Gets the role mappers of the portlet.

Returns:
role mappers of the portlet

setRoleMappers

void setRoleMappers(java.util.Map<java.lang.String,java.lang.String> roleMappers)
Sets the role mappers of the portlet.

Parameters:
roleMappers - the role mappers of the portlet

linkRoles

void linkRoles()
Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml.


hasRoleWithName

boolean hasRoleWithName(java.lang.String roleName)
Returns true if the portlet has a role with the specified name.

Returns:
true if the portlet has a role with the specified name

hasAddPortletPermission

boolean hasAddPortletPermission(long userId)
Returns true if the user has the permission to add the portlet to a layout.

Returns:
true if the user has the permission to add the portlet to a layout

getSystem

boolean getSystem()
Returns true if the portlet is a system portlet that a user cannot manually add to their page.

Returns:
true if the portlet is a system portlet that a user cannot manually add to their page

isSystem

boolean isSystem()
Returns true if the portlet is a system portlet that a user cannot manually add to their page.

Returns:
true if the portlet is a system portlet that a user cannot manually add to their page

setSystem

void setSystem(boolean system)
Set to true if the portlet is a system portlet that a user cannot manually add to their page.

Parameters:
system - boolean value for whether the portlet is a system portlet that a user cannot manually add to their page

getInclude

boolean getInclude()
Returns true to include the portlet and make it available to be made active.

Returns:
true to include the portlet and make it available to be made active

isInclude

boolean isInclude()
Returns true to include the portlet and make it available to be made active.

Returns:
true to include the portlet and make it available to be made active

setInclude

void setInclude(boolean include)
Set to true to include the portlet and make it available to be made active.

Parameters:
include - boolean value for whether to include the portlet and make it available to be made active

getReady

boolean getReady()
Returns true if the portlet is ready to be used.

Returns:
true if the portlet is ready to be used

isReady

boolean isReady()
Returns true if the portlet is ready to be used.

Returns:
true if the portlet is ready to be used

setReady

void setReady(boolean ready)
Set to true if the portlet is ready to be used.

Parameters:
system - boolean value for whether the portlet is ready to be used

getInitParams

java.util.Map<java.lang.String,java.lang.String> getInitParams()
Gets the init parameters of the portlet.

Returns:
init parameters of the portlet

setInitParams

void setInitParams(java.util.Map<java.lang.String,java.lang.String> initParams)
Sets the init parameters of the portlet.

Parameters:
initParams - the init parameters of the portlet

getExpCache

java.lang.Integer getExpCache()
Gets expiration cache of the portlet.

Returns:
expiration cache of the portlet

setExpCache

void setExpCache(java.lang.Integer expCache)
Sets expiration cache of the portlet.

Parameters:
expCache - expiration cache of the portlet

getPortletModes

java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getPortletModes()
Gets the portlet modes of the portlet.

Returns:
portlet modes of the portlet

setPortletModes

void setPortletModes(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> portletModes)
Sets the portlet modes of the portlet.

Parameters:
portletModes - the portlet modes of the portlet

hasPortletMode

boolean hasPortletMode(java.lang.String mimeType,
                       javax.portlet.PortletMode portletMode)
Returns true if the portlet supports the specified mime type and portlet mode.

Returns:
true if the portlet supports the specified mime type and portlet mode

getAllPortletModes

java.util.Set<java.lang.String> getAllPortletModes()
Gets a list of all portlet modes supported by the portlet.

Returns:
a list of all portlet modes supported by the portlet

hasMultipleMimeTypes

boolean hasMultipleMimeTypes()
Returns true if the portlet supports more than one mime type.

Returns:
true if the portlet supports more than one mime type

getWindowStates

java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getWindowStates()
Gets the window states of the portlet.

Returns:
window states of the portlet

setWindowStates

void setWindowStates(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> windowStates)
Sets the window states of the portlet.

Parameters:
windowStates - the window states of the portlet

hasWindowState

boolean hasWindowState(java.lang.String mimeType,
                       javax.portlet.WindowState windowState)
Returns true if the portlet supports the specified mime type and window state.

Returns:
true if the portlet supports the specified mime type and window state

getAllWindowStates

java.util.Set<java.lang.String> getAllWindowStates()
Gets a list of all window states supported by the portlet.

Returns:
a list of all window states supported by the portlet

getSupportedLocales

java.util.Set<java.lang.String> getSupportedLocales()
Gets the supported locales of the portlet.

Returns:
supported locales of the portlet

setSupportedLocales

void setSupportedLocales(java.util.Set<java.lang.String> supportedLocales)
Sets the supported locales of the portlet.

Parameters:
supportedLocales - the supported locales of the portlet

getResourceBundle

java.lang.String getResourceBundle()
Gets the resource bundle of the portlet.

Returns:
resource bundle of the portlet

setResourceBundle

void setResourceBundle(java.lang.String resourceBundle)
Sets the resource bundle of the portlet.

Parameters:
resourceBundle - the resource bundle of the portlet

getPortletInfo

PortletInfo getPortletInfo()
Gets the portlet info of the portlet.

Returns:
portlet info of the portlet

setPortletInfo

void setPortletInfo(PortletInfo portletInfo)
Sets the portlet info of the portlet.

Parameters:
portletInfo - the portlet info of the portlet

getPortletFilters

java.util.Map<java.lang.String,PortletFilter> getPortletFilters()
Gets the filters of the portlet.

Returns:
filters of the portlet

setPortletFilters

void setPortletFilters(java.util.Map<java.lang.String,PortletFilter> portletFilters)
Sets the filters of the portlet.

Parameters:
portletFilters - the filters of the portlet

addProcessingEvent

void addProcessingEvent(com.liferay.portal.kernel.xml.QName processingEvent)
Adds a supported processing event.


getProcessingEvent

com.liferay.portal.kernel.xml.QName getProcessingEvent(java.lang.String uri,
                                                       java.lang.String localPart)
Gets the supported processing event from a namespace URI and a local part.

Returns:
the supported processing event from a namespace URI and a local part

getProcessingEvents

java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents()
Gets the supported processing events of the portlet.

Returns:
supported processing events of the portlet

setProcessingEvents

void setProcessingEvents(java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents)
Sets the supported processing events of the portlet.

Parameters:
processingEvents - the supported processing events of the portlet

addPublishingEvent

void addPublishingEvent(com.liferay.portal.kernel.xml.QName publishingEvent)
Adds a supported publishing event.


getPublishingEvents

java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents()
Gets the supported publishing events of the portlet.

Returns:
supported publishing events of the portlet

setPublishingEvents

void setPublishingEvents(java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents)
Sets the supported publishing events of the portlet.

Parameters:
publishingEvents - the supported publishing events of the portlet

addPublicRenderParameter

void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
Adds a supported public render parameter.

Parameters:
publicRenderParameter - a supported public render parameter

getPublicRenderParameter

PublicRenderParameter getPublicRenderParameter(java.lang.String identifier)
Gets the supported public render parameter from an identifier.

Returns:
the supported public render parameter from an identifier

getPublicRenderParameter

PublicRenderParameter getPublicRenderParameter(java.lang.String uri,
                                               java.lang.String localPart)
Gets the supported public render parameter from a namespace URI and a local part.

Returns:
the supported public render parameter from a namespace URI and a local part

getPublicRenderParameters

java.util.Set<PublicRenderParameter> getPublicRenderParameters()
Gets the supported public render parameters of the portlet.

Returns:
the supported public render parameters of the portlet

setPublicRenderParameters

void setPublicRenderParameters(java.util.Set<PublicRenderParameter> publicRenderParameters)
Sets the supported public render parameters of the portlet.

Parameters:
publicRenderParameters - the supported public render parameters of the portlet

getContextPath

java.lang.String getContextPath()
Gets the servlet context path of the portlet.

Returns:
the servlet context path of the portlet

getPortletApp

PortletApp getPortletApp()
Get the application this portlet belongs to.

Returns:
the application this portlet belongs to

setPortletApp

void setPortletApp(PortletApp portletApp)
Sets the application this portlet belongs to.

Parameters:
portletApp - the application this portlet belongs to

getClonedInstance

Portlet getClonedInstance(java.lang.String portletId)
Returns true if the portlet is found in a WAR file.

Parameters:
portletId - the cloned instance portlet id
Returns:
a cloned instance of the portlet

getStatic

boolean getStatic()
Returns true if the portlet is a static portlet that is cannot be moved.

Returns:
true if the portlet is a static portlet that is cannot be moved

isStatic

boolean isStatic()
Returns true if the portlet is a static portlet that is cannot be moved.

Returns:
true if the portlet is a static portlet that is cannot be moved

setStatic

void setStatic(boolean staticPortlet)
Set to true if the portlet is a static portlet that is cannot be moved.

Parameters:
staticPortlet - boolean value for whether the portlet is a static portlet that cannot be moved

getStaticStart

boolean getStaticStart()
Returns true if the portlet is a static portlet at the start of a list of portlets.

Returns:
true if the portlet is a static portlet at the start of a list of portlets

isStaticStart

boolean isStaticStart()
Returns true if the portlet is a static portlet at the start of a list of portlets.

Returns:
true if the portlet is a static portlet at the start of a list of portlets

setStaticStart

void setStaticStart(boolean staticPortletStart)
Set to true if the portlet is a static portlet at the start of a list of portlets.

Parameters:
staticPortletStart - boolean value for whether the portlet is a static portlet at the start of a list of portlets

getStaticEnd

boolean getStaticEnd()
Returns true if the portlet is a static portlet at the end of a list of portlets.

Returns:
true if the portlet is a static portlet at the end of a list of portlets

isStaticEnd

boolean isStaticEnd()
Returns true if the portlet is a static portlet at the end of a list of portlets.

Returns:
true if the portlet is a static portlet at the end of a list of portlets

getUndeployedPortlet

boolean getUndeployedPortlet()
Returns true if the portlet is an undeployed portlet.

Returns:
true if the portlet is a placeholder of an undeployed portlet

isUndeployedPortlet

boolean isUndeployedPortlet()
Returns true if the portlet is an undeployed portlet.

Returns:
true if the portlet is a placeholder of an undeployed portlet

setUndeployedPortlet

void setUndeployedPortlet(boolean undeployedPortlet)
Set to true if the portlet is an undeployed portlet.

Parameters:
undeployedPortlet - boolean value for whether the portlet is an undeployed portlet

clone

java.lang.Object clone()
Creates and returns a copy of this object.

Specified by:
clone in interface BaseModel<Portlet>
Specified by:
clone in interface PortletModel
Returns:
a copy of this object

compareTo

int compareTo(Portlet portlet)
Compares this portlet to the specified object.

Specified by:
compareTo in interface java.lang.Comparable<Portlet>
Specified by:
compareTo in interface PortletModel
Parameters:
portlet - the portlet to compare this portlet against
Returns:
the value 0 if the argument portlet is equal to this portlet; a value less than -1 if this portlet is less than the portlet argument; and 1 if this portlet is greater than the portlet argument

equals

boolean equals(java.lang.Object obj)
Checks whether this portlet is equal to the specified object.

Overrides:
equals in class java.lang.Object
Parameters:
obj - the object to compare this portlet against
Returns:
true if the portlet is equal to the specified object