com.liferay.portal.model
Class PortletWrapper

java.lang.Object
  extended by com.liferay.portal.model.PortletWrapper
All Implemented Interfaces:
BaseModel<Portlet>, Portlet, PortletModel, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Portlet>

public class PortletWrapper
extends java.lang.Object
implements Portlet

View Source

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

This class is a wrapper for Portlet.

Author:
Brian Wing Shun Chan
See Also:
Portlet, Serialized Form
Generated:

Constructor Summary
PortletWrapper(Portlet portlet)
           
 
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 getActive()
           
 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.
 long getCompanyId()
           
 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.
 ExpandoBridge getExpandoBridge()
           
 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.
 long getId()
           
 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.
 java.lang.String getPortletId()
           
 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.
 long getPrimaryKey()
           
 java.io.Serializable getPrimaryKeyObj()
           
 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 getRoles()
           
 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.
 Portlet getWrappedPortlet()
           
 boolean hasAddPortletPermission(long userId)
          Returns true if the user has the permission to add the portlet to a layout.
 int hashCode()
           
 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 isActive()
           
 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 isCachedModel()
           
 boolean isEscapedModel()
           
 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 isNew()
           
 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 setActive(boolean active)
           
 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 setCachedModel(boolean cachedModel)
           
 void setCompanyId(long companyId)
           
 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 setEscapedModel(boolean escapedModel)
           
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
           
 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 setId(long id)
           
 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.
 boolean setNew(boolean n)
           
 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 setPortletId(java.lang.String portletId)
           
 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 setPrimaryKey(long pk)
           
 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.
 Portlet toEscapedModel()
           
 java.lang.String toString()
           
 java.lang.String toXmlString()
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PortletWrapper

public PortletWrapper(Portlet portlet)
Method Detail

getPrimaryKey

public long getPrimaryKey()
Specified by:
getPrimaryKey in interface PortletModel

setPrimaryKey

public void setPrimaryKey(long pk)
Specified by:
setPrimaryKey in interface PortletModel

getId

public long getId()
Specified by:
getId in interface PortletModel

setId

public void setId(long id)
Specified by:
setId in interface PortletModel

getCompanyId

public long getCompanyId()
Specified by:
getCompanyId in interface PortletModel

setCompanyId

public void setCompanyId(long companyId)
Specified by:
setCompanyId in interface PortletModel

getPortletId

public java.lang.String getPortletId()
Specified by:
getPortletId in interface PortletModel

setPortletId

public void setPortletId(java.lang.String portletId)
Specified by:
setPortletId in interface PortletModel

getRoles

public java.lang.String getRoles()
Specified by:
getRoles in interface PortletModel

setRoles

public void setRoles(java.lang.String roles)
Description copied from interface: Portlet
Sets a string of ordered comma delimited portlet ids.

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

getActive

public boolean getActive()
Specified by:
getActive in interface PortletModel

isActive

public boolean isActive()
Specified by:
isActive in interface PortletModel

setActive

public void setActive(boolean active)
Specified by:
setActive in interface PortletModel

isNew

public boolean isNew()
Specified by:
isNew in interface BaseModel<Portlet>
Specified by:
isNew in interface PortletModel

setNew

public boolean setNew(boolean n)
Specified by:
setNew in interface BaseModel<Portlet>
Specified by:
setNew in interface PortletModel

isCachedModel

public boolean isCachedModel()
Specified by:
isCachedModel in interface BaseModel<Portlet>
Specified by:
isCachedModel in interface PortletModel

setCachedModel

public void setCachedModel(boolean cachedModel)
Specified by:
setCachedModel in interface BaseModel<Portlet>
Specified by:
setCachedModel in interface PortletModel

isEscapedModel

public boolean isEscapedModel()
Specified by:
isEscapedModel in interface BaseModel<Portlet>
Specified by:
isEscapedModel in interface PortletModel

setEscapedModel

public void setEscapedModel(boolean escapedModel)
Specified by:
setEscapedModel in interface BaseModel<Portlet>
Specified by:
setEscapedModel in interface PortletModel

getPrimaryKeyObj

public java.io.Serializable getPrimaryKeyObj()
Specified by:
getPrimaryKeyObj in interface BaseModel<Portlet>
Specified by:
getPrimaryKeyObj in interface PortletModel

getExpandoBridge

public ExpandoBridge getExpandoBridge()
Specified by:
getExpandoBridge in interface BaseModel<Portlet>
Specified by:
getExpandoBridge in interface PortletModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ServiceContext serviceContext)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<Portlet>
Specified by:
setExpandoBridgeAttributes in interface PortletModel

clone

public java.lang.Object clone()
Description copied from interface: Portlet
Creates and returns a copy of this object.

Specified by:
clone in interface BaseModel<Portlet>
Specified by:
clone in interface Portlet
Specified by:
clone in interface PortletModel
Overrides:
clone in class java.lang.Object
Returns:
a copy of this object

compareTo

public int compareTo(Portlet portlet)
Description copied from interface: Portlet
Compares this portlet to the specified object.

Specified by:
compareTo in interface Portlet
Specified by:
compareTo in interface PortletModel
Specified by:
compareTo in interface java.lang.Comparable<Portlet>
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

hashCode

public int hashCode()
Specified by:
hashCode in interface PortletModel
Overrides:
hashCode in class java.lang.Object

toEscapedModel

public Portlet toEscapedModel()
Specified by:
toEscapedModel in interface BaseModel<Portlet>
Specified by:
toEscapedModel in interface PortletModel

toString

public java.lang.String toString()
Specified by:
toString in interface PortletModel
Overrides:
toString in class java.lang.Object

toXmlString

public java.lang.String toXmlString()
Specified by:
toXmlString in interface BaseModel<Portlet>
Specified by:
toXmlString in interface PortletModel

getRootPortletId

public java.lang.String getRootPortletId()
Description copied from interface: Portlet
Gets the root portlet id of the portlet.

Specified by:
getRootPortletId in interface Portlet
Returns:
the root portlet id of the portlet

getInstanceId

public java.lang.String getInstanceId()
Description copied from interface: Portlet
Gets the instance id of the portlet.

Specified by:
getInstanceId in interface Portlet
Returns:
the instance id of the portlet

getPluginId

public java.lang.String getPluginId()
Description copied from interface: Portlet
Gets the plugin id of the portlet.

Specified by:
getPluginId in interface Portlet
Returns:
the plugin id of the portlet

getPluginType

public java.lang.String getPluginType()
Description copied from interface: Portlet
Gets the plugin type of the portlet.

Specified by:
getPluginType in interface Portlet
Returns:
the plugin type of the portlet

getPluginPackage

public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage()
Description copied from interface: Portlet
Get the package to which the portlet belongs to.

Specified by:
getPluginPackage in interface Portlet
Returns:
the plugin package of the portlet

setPluginPackage

public void setPluginPackage(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
Description copied from interface: Portlet
Sets the plugin package this portlet belongs to.

Specified by:
setPluginPackage in interface Portlet
Parameters:
pluginPackage - the plugin package

getDefaultPluginSetting

public PluginSetting getDefaultPluginSetting()
Description copied from interface: Portlet
Get the default plugin settings of the portlet.

Specified by:
getDefaultPluginSetting in interface Portlet
Returns:
the plugin settings

setDefaultPluginSetting

public void setDefaultPluginSetting(PluginSetting pluginSetting)
Description copied from interface: Portlet
Sets the default plugin settings of the portlet.

Specified by:
setDefaultPluginSetting in interface Portlet
Parameters:
pluginSetting - the plugin setting

getTimestamp

public long getTimestamp()
Description copied from interface: Portlet
Gets the timestamp of the portlet.

Specified by:
getTimestamp in interface Portlet
Returns:
the timestamp of the portlet

setTimestamp

public void setTimestamp(long timestamp)
Description copied from interface: Portlet
Sets the timestamp of the portlet.

Specified by:
setTimestamp in interface Portlet
Parameters:
timestamp - the timestamp of the portlet

getIcon

public java.lang.String getIcon()
Description copied from interface: Portlet
Gets the icon of the portlet.

Specified by:
getIcon in interface Portlet
Returns:
the icon of the portlet

setIcon

public void setIcon(java.lang.String icon)
Description copied from interface: Portlet
Sets the icon of the portlet.

Specified by:
setIcon in interface Portlet
Parameters:
icon - the icon of the portlet

getVirtualPath

public java.lang.String getVirtualPath()
Description copied from interface: Portlet
Gets the virtual path of the portlet.

Specified by:
getVirtualPath in interface Portlet
Returns:
the virtual path of the portlet

setVirtualPath

public void setVirtualPath(java.lang.String virtualPath)
Description copied from interface: Portlet
Sets the virtual path of the portlet.

Specified by:
setVirtualPath in interface Portlet
Parameters:
virtualPath - the virtual path of the portlet

getStrutsPath

public java.lang.String getStrutsPath()
Description copied from interface: Portlet
Gets the struts path of the portlet.

Specified by:
getStrutsPath in interface Portlet
Returns:
the struts path of the portlet

setStrutsPath

public void setStrutsPath(java.lang.String strutsPath)
Description copied from interface: Portlet
Sets the struts path of the portlet.

Specified by:
setStrutsPath in interface Portlet
Parameters:
strutsPath - the struts path of the portlet

getPortletName

public java.lang.String getPortletName()
Description copied from interface: Portlet
Gets the name of the portlet.

Specified by:
getPortletName in interface Portlet
Returns:
the display name of the portlet

setPortletName

public void setPortletName(java.lang.String portletName)
Description copied from interface: Portlet
Sets the name of the portlet.

Specified by:
setPortletName in interface Portlet
Parameters:
portletName - the name of the portlet

getDisplayName

public java.lang.String getDisplayName()
Description copied from interface: Portlet
Gets the display name of the portlet.

Specified by:
getDisplayName in interface Portlet
Returns:
the display name of the portlet

setDisplayName

public void setDisplayName(java.lang.String displayName)
Description copied from interface: Portlet
Sets the display name of the portlet.

Specified by:
setDisplayName in interface Portlet
Parameters:
displayName - the display name of the portlet

getPortletClass

public java.lang.String getPortletClass()
Description copied from interface: Portlet
Gets the name of the portlet class of the portlet.

Specified by:
getPortletClass in interface Portlet
Returns:
the name of the portlet class of the portlet

setPortletClass

public void setPortletClass(java.lang.String portletClass)
Description copied from interface: Portlet
Sets the name of the portlet class of the portlet.

Specified by:
setPortletClass in interface Portlet
Parameters:
portletClass - the name of the portlet class of the portlet

getConfigurationActionClass

public java.lang.String getConfigurationActionClass()
Description copied from interface: Portlet
Gets the configuration action class of the portlet.

Specified by:
getConfigurationActionClass in interface Portlet
Returns:
the configuration action class of the portlet

setConfigurationActionClass

public void setConfigurationActionClass(java.lang.String configurationActionClass)
Description copied from interface: Portlet
Sets the configuration action class of the portlet.

Specified by:
setConfigurationActionClass in interface Portlet
Parameters:
configurationActionClass - the configuration action class of the portlet

getConfigurationActionInstance

public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance()
Description copied from interface: Portlet
Gets the configuration action instance of the portlet.

Specified by:
getConfigurationActionInstance in interface Portlet
Returns:
the configuration action instance of the portlet

getIndexerClass

public java.lang.String getIndexerClass()
Description copied from interface: Portlet
Gets the name of the indexer class of the portlet.

Specified by:
getIndexerClass in interface Portlet
Returns:
the name of the indexer class of the portlet

setIndexerClass

public void setIndexerClass(java.lang.String indexerClass)
Description copied from interface: Portlet
Sets the name of the indexer class of the portlet.

Specified by:
setIndexerClass in interface Portlet
Parameters:
indexerClass - the name of the indexer class of the portlet

getIndexerInstance

public com.liferay.portal.kernel.search.Indexer getIndexerInstance()
Description copied from interface: Portlet
Gets the indexer instance of the portlet.

Specified by:
getIndexerInstance in interface Portlet
Returns:
the indexer instance of the portlet

getOpenSearchClass

public java.lang.String getOpenSearchClass()
Description copied from interface: Portlet
Gets the name of the open search class of the portlet.

Specified by:
getOpenSearchClass in interface Portlet
Returns:
the name of the open search class of the portlet

setOpenSearchClass

public void setOpenSearchClass(java.lang.String openSearchClass)
Description copied from interface: Portlet
Sets the name of the open search class of the portlet.

Specified by:
setOpenSearchClass in interface Portlet
Parameters:
openSearchClass - the name of the open search class of the portlet

getOpenSearchInstance

public com.liferay.portal.kernel.search.OpenSearch getOpenSearchInstance()
Description copied from interface: Portlet
Gets the indexer instance of the portlet.

Specified by:
getOpenSearchInstance in interface Portlet
Returns:
the indexer instance of the portlet

getSchedulerClass

public java.lang.String getSchedulerClass()
Description copied from interface: Portlet
Gets the name of the scheduler class of the portlet.

Specified by:
getSchedulerClass in interface Portlet
Returns:
the name of the scheduler class of the portlet

setSchedulerClass

public void setSchedulerClass(java.lang.String schedulerClass)
Description copied from interface: Portlet
Sets the name of the scheduler class of the portlet.

Specified by:
setSchedulerClass in interface Portlet
Parameters:
schedulerClass - the name of the scheduler class of the portlet

getSchedulerInstance

public com.liferay.portal.kernel.job.Scheduler getSchedulerInstance()
Description copied from interface: Portlet
Gets the scheduler instance of the portlet.

Specified by:
getSchedulerInstance in interface Portlet
Returns:
the scheduler instance of the portlet

getPortletURLClass

public java.lang.String getPortletURLClass()
Description copied from interface: Portlet
Gets the name of the portlet URL class of the portlet.

Specified by:
getPortletURLClass in interface Portlet
Returns:
the name of the portlet URL class of the portlet

setPortletURLClass

public void setPortletURLClass(java.lang.String portletURLClass)
Description copied from interface: Portlet
Sets the name of the portlet URL class of the portlet.

Specified by:
setPortletURLClass in interface Portlet
Parameters:
portletURLClass - the name of the portlet URL class of the portlet

getFriendlyURLMapperClass

public java.lang.String getFriendlyURLMapperClass()
Description copied from interface: Portlet
Gets the name of the friendly URL mapper class of the portlet.

Specified by:
getFriendlyURLMapperClass in interface Portlet
Returns:
the name of the friendly URL mapper class of the portlet

setFriendlyURLMapperClass

public void setFriendlyURLMapperClass(java.lang.String friendlyURLMapperClass)
Description copied from interface: Portlet
Sets the name of the friendly URL mapper class of the portlet.

Specified by:
setFriendlyURLMapperClass in interface Portlet
Parameters:
friendlyURLMapperClass - the name of the friendly URL mapper class of the portlet

getFriendlyURLMapperInstance

public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance()
Description copied from interface: Portlet
Gets the friendly URL mapper instance of the portlet.

Specified by:
getFriendlyURLMapperInstance in interface Portlet
Returns:
the friendly URL mapper instance of the portlet

getURLEncoderClass

public java.lang.String getURLEncoderClass()
Description copied from interface: Portlet
Gets the name of the URL encoder class of the portlet.

Specified by:
getURLEncoderClass in interface Portlet
Returns:
the name of the URL encoder class of the portlet

setURLEncoderClass

public void setURLEncoderClass(java.lang.String urlEncoderClass)
Description copied from interface: Portlet
Sets the name of the URL encoder class of the portlet.

Specified by:
setURLEncoderClass in interface Portlet
Parameters:
urlEncoderClass - the name of the URL encoder class of the portlet

getURLEncoderInstance

public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance()
Description copied from interface: Portlet
Gets the URL encoder instance of the portlet.

Specified by:
getURLEncoderInstance in interface Portlet
Returns:
the URL encoder instance of the portlet

getPortletDataHandlerClass

public java.lang.String getPortletDataHandlerClass()
Description copied from interface: Portlet
Gets the name of the portlet data handler class of the portlet.

Specified by:
getPortletDataHandlerClass in interface Portlet
Returns:
the name of the portlet data handler class of the portlet

setPortletDataHandlerClass

public void setPortletDataHandlerClass(java.lang.String portletDataHandlerClass)
Description copied from interface: Portlet
Sets the name of the portlet data handler class of the portlet.

Specified by:
setPortletDataHandlerClass in interface Portlet
Parameters:
portletDataHandlerClass - the name of portlet data handler class of the portlet

getPortletDataHandlerInstance

public PortletDataHandler getPortletDataHandlerInstance()
Description copied from interface: Portlet
Gets the portlet data handler instance of the portlet.

Specified by:
getPortletDataHandlerInstance in interface Portlet
Returns:
the portlet data handler instance of the portlet

getPortletLayoutListenerClass

public java.lang.String getPortletLayoutListenerClass()
Description copied from interface: Portlet
Gets the name of the portlet layout listener class of the portlet.

Specified by:
getPortletLayoutListenerClass in interface Portlet
Returns:
the name of the portlet layout listener class of the portlet

setPortletLayoutListenerClass

public void setPortletLayoutListenerClass(java.lang.String portletLayoutListenerClass)
Description copied from interface: Portlet
Sets the name of the portlet layout listener class of the portlet.

Specified by:
setPortletLayoutListenerClass in interface Portlet
Parameters:
portletLayoutListenerClass - the name of the portlet layout listener class of the portlet

getPortletLayoutListenerInstance

public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance()
Description copied from interface: Portlet
Gets the portlet layout listener instance of the portlet.

Specified by:
getPortletLayoutListenerInstance in interface Portlet
Returns:
the portlet layout listener instance of the portlet

getPollerProcessorClass

public java.lang.String getPollerProcessorClass()
Description copied from interface: Portlet
Gets the name of the poller processor class of the portlet.

Specified by:
getPollerProcessorClass in interface Portlet
Returns:
the name of the poller processor class of the portlet

setPollerProcessorClass

public void setPollerProcessorClass(java.lang.String pollerProcessorClass)
Description copied from interface: Portlet
Sets the name of the poller processor class of the portlet.

Specified by:
setPollerProcessorClass in interface Portlet
Parameters:
pollerProcessorClass - the name of the poller processor class of the portlet

getPollerProcessorInstance

public com.liferay.portal.kernel.poller.PollerProcessor getPollerProcessorInstance()
Description copied from interface: Portlet
Gets the poller processor instance of the portlet.

Specified by:
getPollerProcessorInstance in interface Portlet
Returns:
the poller processor instance of the portlet

getPopMessageListenerClass

public java.lang.String getPopMessageListenerClass()
Description copied from interface: Portlet
Gets the name of the POP message listener class of the portlet.

Specified by:
getPopMessageListenerClass in interface Portlet
Returns:
the name of the POP message listener class of the portlet

setPopMessageListenerClass

public void setPopMessageListenerClass(java.lang.String popMessageListenerClass)
Description copied from interface: Portlet
Sets the name of the POP message listener class of the portlet.

Specified by:
setPopMessageListenerClass in interface Portlet
Parameters:
popMessageListenerClass - the name of the POP message listener class of the portlet

getPopMessageListenerInstance

public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance()
Description copied from interface: Portlet
Gets the POP message listener instance of the portlet.

Specified by:
getPopMessageListenerInstance in interface Portlet
Returns:
the POP message listener instance of the portlet

getSocialActivityInterpreterClass

public java.lang.String getSocialActivityInterpreterClass()
Description copied from interface: Portlet
Gets the name of the social activity interpreter class of the portlet.

Specified by:
getSocialActivityInterpreterClass in interface Portlet
Returns:
the name of the social activity interpreter class of the portlet

setSocialActivityInterpreterClass

public void setSocialActivityInterpreterClass(java.lang.String socialActivityInterpreterClass)
Description copied from interface: Portlet
Sets the name of the social activity interpreter class of the portlet.

Specified by:
setSocialActivityInterpreterClass in interface Portlet
Parameters:
socialActivityInterpreterClass - the name of the activity interpreter class of the portlet

getSocialActivityInterpreterInstance

public SocialActivityInterpreter getSocialActivityInterpreterInstance()
Description copied from interface: Portlet
Gets the name of the social activity interpreter instance of the portlet.

Specified by:
getSocialActivityInterpreterInstance in interface Portlet
Returns:
the name of the social activity interpreter instance of the portlet

getSocialRequestInterpreterClass

public java.lang.String getSocialRequestInterpreterClass()
Description copied from interface: Portlet
Gets the name of the social request interpreter class of the portlet.

Specified by:
getSocialRequestInterpreterClass in interface Portlet
Returns:
the name of the social request interpreter class of the portlet

setSocialRequestInterpreterClass

public void setSocialRequestInterpreterClass(java.lang.String socialRequestInterpreterClass)
Description copied from interface: Portlet
Sets the name of the social request interpreter class of the portlet.

Specified by:
setSocialRequestInterpreterClass in interface Portlet
Parameters:
socialRequestInterpreterClass - the name of the request interpreter class of the portlet

getSocialRequestInterpreterInstance

public SocialRequestInterpreter getSocialRequestInterpreterInstance()
Description copied from interface: Portlet
Gets the name of the social request interpreter instance of the portlet.

Specified by:
getSocialRequestInterpreterInstance in interface Portlet
Returns:
the name of the social request interpreter instance of the portlet

getWebDAVStorageToken

public java.lang.String getWebDAVStorageToken()
Description copied from interface: Portlet
Gets the name of the WebDAV storage token of the portlet.

Specified by:
getWebDAVStorageToken in interface Portlet
Returns:
the name of the WebDAV storage token of the portlet

setWebDAVStorageToken

public void setWebDAVStorageToken(java.lang.String webDAVStorageToken)
Description copied from interface: Portlet
Sets the name of the WebDAV storage token of the portlet.

Specified by:
setWebDAVStorageToken in interface Portlet
Parameters:
webDAVStorageToken - the name of the WebDAV storage token of the portlet

getWebDAVStorageClass

public java.lang.String getWebDAVStorageClass()
Description copied from interface: Portlet
Gets the name of the WebDAV storage class of the portlet.

Specified by:
getWebDAVStorageClass in interface Portlet
Returns:
the name of the WebDAV storage class of the portlet

setWebDAVStorageClass

public void setWebDAVStorageClass(java.lang.String webDAVStorageClass)
Description copied from interface: Portlet
Sets the name of the WebDAV storage class of the portlet.

Specified by:
setWebDAVStorageClass in interface Portlet
Parameters:
webDAVStorageClass - the name of the WebDAV storage class of the portlet

getWebDAVStorageInstance

public WebDAVStorage getWebDAVStorageInstance()
Description copied from interface: Portlet
Gets the name of the WebDAV storage instance of the portlet.

Specified by:
getWebDAVStorageInstance in interface Portlet
Returns:
the name of the WebDAV storage instance of the portlet

getControlPanelEntryCategory

public java.lang.String getControlPanelEntryCategory()
Description copied from interface: Portlet
Gets the name of the category of the Control Panel where the portlet will be shown.

Specified by:
getControlPanelEntryCategory in interface Portlet
Returns:
the name of of the category of the Control Panel where the portlet will be shown

setControlPanelEntryCategory

public void setControlPanelEntryCategory(java.lang.String controlPanelEntryCategory)
Description copied from interface: Portlet
Set the name of the category of the Control Panel where the portlet will be shown.

Specified by:
setControlPanelEntryCategory in interface Portlet
Parameters:
controlPanelEntryCategory - the name of the category of the Control Panel where the portlet will be shown

getControlPanelEntryWeight

public double getControlPanelEntryWeight()
Description copied from interface: Portlet
Gets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.

Specified by:
getControlPanelEntryWeight in interface Portlet
Returns:
the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel

setControlPanelEntryWeight

public void setControlPanelEntryWeight(double controlPanelEntryWeight)
Description copied from interface: Portlet
Sets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.

Specified by:
setControlPanelEntryWeight in interface Portlet
Parameters:
controlPanelEntryWeight - the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel

getControlPanelEntryClass

public java.lang.String getControlPanelEntryClass()
Description copied from interface: Portlet
Gets the name of the class that will control when the portlet will be shown in the Control Panel.

Specified by:
getControlPanelEntryClass in interface Portlet
Returns:
the name of the class that will control when the portlet will be shown in the Control Panel

setControlPanelEntryClass

public void setControlPanelEntryClass(java.lang.String controlPanelEntryClass)
Description copied from interface: Portlet
Sets the name of the class that will control when the portlet will be shown in the Control Panel.

Specified by:
setControlPanelEntryClass in interface Portlet
Parameters:
controlPanelEntryClass - the name of the class that will control when the portlet will be shown in the Control Panel

getControlPanelEntryInstance

public ControlPanelEntry getControlPanelEntryInstance()
Description copied from interface: Portlet
Gets an instance of the class that will control when the portlet will be shown in the Control Panel.

Specified by:
getControlPanelEntryInstance in interface Portlet
Returns:
the instance of the class that will control when the portlet will be shown in the Control Panel

getDefaultPreferences

public java.lang.String getDefaultPreferences()
Description copied from interface: Portlet
Gets the default preferences of the portlet.

Specified by:
getDefaultPreferences in interface Portlet
Returns:
the default preferences of the portlet

setDefaultPreferences

public void setDefaultPreferences(java.lang.String defaultPreferences)
Description copied from interface: Portlet
Sets the default preferences of the portlet.

Specified by:
setDefaultPreferences in interface Portlet
Parameters:
defaultPreferences - the default preferences of the portlet

getPreferencesValidator

public java.lang.String getPreferencesValidator()
Description copied from interface: Portlet
Gets the name of the preferences validator class of the portlet.

Specified by:
getPreferencesValidator in interface Portlet
Returns:
the name of the preferences validator class of the portlet

setPreferencesValidator

public void setPreferencesValidator(java.lang.String preferencesValidator)
Description copied from interface: Portlet
Sets the name of the preferences validator class of the portlet.

Specified by:
setPreferencesValidator in interface Portlet
Parameters:
preferencesValidator - the name of the preferences validator class of the portlet

getPreferencesCompanyWide

public boolean getPreferencesCompanyWide()
Description copied from interface: Portlet
Returns true if preferences are shared across the entire company.

Specified by:
getPreferencesCompanyWide in interface Portlet
Returns:
true if preferences are shared across the entire company

isPreferencesCompanyWide

public boolean isPreferencesCompanyWide()
Description copied from interface: Portlet
Returns true if preferences are shared across the entire company.

Specified by:
isPreferencesCompanyWide in interface Portlet
Returns:
true if preferences are shared across the entire company

setPreferencesCompanyWide

public void setPreferencesCompanyWide(boolean preferencesCompanyWide)
Description copied from interface: Portlet
Set to true if preferences are shared across the entire company.

Specified by:
setPreferencesCompanyWide in interface Portlet
Parameters:
preferencesCompanyWide - boolean value for whether preferences are shared across the entire company

getPreferencesUniquePerLayout

public boolean getPreferencesUniquePerLayout()
Description copied from interface: Portlet
Returns true if preferences are unique per layout.

Specified by:
getPreferencesUniquePerLayout in interface Portlet
Returns:
true if preferences are unique per layout

isPreferencesUniquePerLayout

public boolean isPreferencesUniquePerLayout()
Description copied from interface: Portlet
Returns true if preferences are unique per layout.

Specified by:
isPreferencesUniquePerLayout in interface Portlet
Returns:
true if preferences are unique per layout

setPreferencesUniquePerLayout

public void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
Description copied from interface: Portlet
Set to true if preferences are unique per layout.

Specified by:
setPreferencesUniquePerLayout in interface Portlet
Parameters:
preferencesUniquePerLayout - boolean value for whether preferences are unique per layout

getPreferencesOwnedByGroup

public boolean getPreferencesOwnedByGroup()
Description copied from interface: Portlet
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.

Specified by:
getPreferencesOwnedByGroup in interface Portlet
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

public boolean isPreferencesOwnedByGroup()
Description copied from interface: Portlet
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.

Specified by:
isPreferencesOwnedByGroup in interface Portlet
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

public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
Description copied from interface: Portlet
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.

Specified by:
setPreferencesOwnedByGroup in interface Portlet
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

public boolean getUseDefaultTemplate()
Description copied from interface: Portlet
Returns true if the portlet uses the default template.

Specified by:
getUseDefaultTemplate in interface Portlet
Returns:
true if the portlet uses the default template

isUseDefaultTemplate

public boolean isUseDefaultTemplate()
Description copied from interface: Portlet
Returns true if the portlet uses the default template.

Specified by:
isUseDefaultTemplate in interface Portlet
Returns:
true if the portlet uses the default template

setUseDefaultTemplate

public void setUseDefaultTemplate(boolean useDefaultTemplate)
Description copied from interface: Portlet
Set to true if the portlet uses the default template.

Specified by:
setUseDefaultTemplate in interface Portlet
Parameters:
useDefaultTemplate - boolean value for whether the portlet uses the default template

getShowPortletAccessDenied

public boolean getShowPortletAccessDenied()
Description copied from interface: Portlet
Returns true if users are shown that they do not have access to the portlet.

Specified by:
getShowPortletAccessDenied in interface Portlet
Returns:
true if users are shown that they do not have access to the portlet

isShowPortletAccessDenied

public boolean isShowPortletAccessDenied()
Description copied from interface: Portlet
Returns true if users are shown that they do not have access to the portlet.

Specified by:
isShowPortletAccessDenied in interface Portlet
Returns:
true if users are shown that they do not have access to the portlet

setShowPortletAccessDenied

public void setShowPortletAccessDenied(boolean showPortletAccessDenied)
Description copied from interface: Portlet
Set to true if users are shown that they do not have access to the portlet.

Specified by:
setShowPortletAccessDenied in interface Portlet
Parameters:
showPortletAccessDenied - boolean value for whether users are shown that they do not have access to the portlet

getShowPortletInactive

public boolean getShowPortletInactive()
Description copied from interface: Portlet
Returns true if users are shown that the portlet is inactive.

Specified by:
getShowPortletInactive in interface Portlet
Returns:
true if users are shown that the portlet is inactive

isShowPortletInactive

public boolean isShowPortletInactive()
Description copied from interface: Portlet
Returns true if users are shown that the portlet is inactive.

Specified by:
isShowPortletInactive in interface Portlet
Returns:
true if users are shown that the portlet is inactive

setShowPortletInactive

public void setShowPortletInactive(boolean showPortletInactive)
Description copied from interface: Portlet
Set to true if users are shown that the portlet is inactive.

Specified by:
setShowPortletInactive in interface Portlet
Parameters:
showPortletInactive - boolean value for whether users are shown that the portlet is inactive

getActionURLRedirect

public boolean getActionURLRedirect()
Description copied from interface: Portlet
Returns true if an action URL for this portlet should cause an auto redirect.

Specified by:
getActionURLRedirect in interface Portlet
Returns:
true if an action URL for this portlet should cause an auto redirect

isActionURLRedirect

public boolean isActionURLRedirect()
Description copied from interface: Portlet
Returns true if an action URL for this portlet should cause an auto redirect.

Specified by:
isActionURLRedirect in interface Portlet
Returns:
true if an action URL for this portlet should cause an auto redirect

setActionURLRedirect

public void setActionURLRedirect(boolean actionURLRedirect)
Description copied from interface: Portlet
Set to true if an action URL for this portlet should cause an auto redirect.

Specified by:
setActionURLRedirect in interface Portlet
Parameters:
actionURLRedirect - boolean value for whether an action URL for this portlet should cause an auto redirect

getRestoreCurrentView

public boolean getRestoreCurrentView()
Description copied from interface: Portlet
Returns true if the portlet restores to the current view from the maximized state.

Specified by:
getRestoreCurrentView in interface Portlet
Returns:
true if the portlet restores to the current view from the maximized state

isRestoreCurrentView

public boolean isRestoreCurrentView()
Description copied from interface: Portlet
Returns true if the portlet restores to the current view from the maximized state.

Specified by:
isRestoreCurrentView in interface Portlet
Returns:
true if the portlet restores to the current view from the maximized state

setRestoreCurrentView

public void setRestoreCurrentView(boolean restoreCurrentView)
Description copied from interface: Portlet
Set to true if the portlet restores to the current view from the maximized state.

Specified by:
setRestoreCurrentView in interface Portlet
Parameters:
restoreCurrentView - boolean value for whether the portlet restores to the current view from the maximized state

getMaximizeEdit

public boolean getMaximizeEdit()
Description copied from interface: Portlet
Returns true if the portlet goes into the maximized state when the user goes into the edit mode.

Specified by:
getMaximizeEdit in interface Portlet
Returns:
true if the portlet goes into the maximized state when the user goes into the edit mode

isMaximizeEdit

public boolean isMaximizeEdit()
Description copied from interface: Portlet
Returns true if the portlet goes into the maximized state when the user goes into the edit mode.

Specified by:
isMaximizeEdit in interface Portlet
Returns:
true if the portlet goes into the maximized state when the user goes into the edit mode

setMaximizeEdit

public void setMaximizeEdit(boolean maximizeEdit)
Description copied from interface: Portlet
Set to true if the portlet goes into the maximized state when the user goes into the edit mode.

Specified by:
setMaximizeEdit in interface Portlet
Parameters:
maximizeEdit - boolean value for whether the portlet goes into the maximized state when the user goes into the edit mode

getMaximizeHelp

public boolean getMaximizeHelp()
Description copied from interface: Portlet
Returns true if the portlet goes into the maximized state when the user goes into the help mode.

Specified by:
getMaximizeHelp in interface Portlet
Returns:
true if the portlet goes into the maximized state when the user goes into the help mode

isMaximizeHelp

public boolean isMaximizeHelp()
Description copied from interface: Portlet
Returns true if the portlet goes into the maximized state when the user goes into the help mode.

Specified by:
isMaximizeHelp in interface Portlet
Returns:
true if the portlet goes into the maximized state when the user goes into the help mode

setMaximizeHelp

public void setMaximizeHelp(boolean maximizeHelp)
Description copied from interface: Portlet
Set to true if the portlet goes into the maximized state when the user goes into the help mode.

Specified by:
setMaximizeHelp in interface Portlet
Parameters:
maximizeHelp - boolean value for whether the portlet goes into the maximized state when the user goes into the help mode

getPopUpPrint

public boolean getPopUpPrint()
Description copied from interface: Portlet
Returns true if the portlet goes into the pop up state when the user goes into the print mode.

Specified by:
getPopUpPrint in interface Portlet
Returns:
true if the portlet goes into the pop up state when the user goes into the print mode

isPopUpPrint

public boolean isPopUpPrint()
Description copied from interface: Portlet
Returns true if the portlet goes into the pop up state when the user goes into the print mode.

Specified by:
isPopUpPrint in interface Portlet
Returns:
true if the portlet goes into the pop up state when the user goes into the print mode

setPopUpPrint

public void setPopUpPrint(boolean popUpPrint)
Description copied from interface: Portlet
Set to true if the portlet goes into the pop up state when the user goes into the print mode.

Specified by:
setPopUpPrint in interface Portlet
Parameters:
popUpPrint - boolean value for whether the portlet goes into the pop up state when the user goes into the print mode

getLayoutCacheable

public boolean getLayoutCacheable()
Description copied from interface: Portlet
Returns true to allow the portlet to be cached within the layout.

Specified by:
getLayoutCacheable in interface Portlet
Returns:
true if the portlet can be cached within the layout

isLayoutCacheable

public boolean isLayoutCacheable()
Description copied from interface: Portlet
Returns true to allow the portlet to be cached within the layout.

Specified by:
isLayoutCacheable in interface Portlet
Returns:
true if the portlet can be cached within the layout

setLayoutCacheable

public void setLayoutCacheable(boolean layoutCacheable)
Description copied from interface: Portlet
Set to true to allow the portlet to be cached within the layout.

Specified by:
setLayoutCacheable in interface Portlet
Parameters:
layoutCacheable - boolean value for whether the portlet can be cached within the layout

getInstanceable

public boolean getInstanceable()
Description copied from interface: Portlet
Returns true if the portlet can be added multiple times to a layout.

Specified by:
getInstanceable in interface Portlet
Returns:
true if the portlet can be added multiple times to a layout

isInstanceable

public boolean isInstanceable()
Description copied from interface: Portlet
Returns true if the portlet can be added multiple times to a layout.

Specified by:
isInstanceable in interface Portlet
Returns:
true if the portlet can be added multiple times to a layout

setInstanceable

public void setInstanceable(boolean instanceable)
Description copied from interface: Portlet
Set to true if the portlet can be added multiple times to a layout.

Specified by:
setInstanceable in interface Portlet
Parameters:
instanceable - boolean value for whether the portlet can be added multiple times to a layout

getScopeable

public boolean getScopeable()
Description copied from interface: Portlet
Returns true if the portlet supports scoping of data.

Specified by:
getScopeable in interface Portlet
Returns:
true if the portlet supports scoping of data

isScopeable

public boolean isScopeable()
Description copied from interface: Portlet
Returns true if the portlet supports scoping of data.

Specified by:
isScopeable in interface Portlet
Returns:
true if the portlet supports scoping of data

setScopeable

public void setScopeable(boolean scopeable)
Description copied from interface: Portlet
Set to true if the portlet supports scoping of data.

Specified by:
setScopeable in interface Portlet
Parameters:
scopeable - boolean value for whether or not the the portlet supports scoping of data

getUserPrincipalStrategy

public java.lang.String getUserPrincipalStrategy()
Description copied from interface: Portlet
Gets the user principal strategy of the portlet.

Specified by:
getUserPrincipalStrategy in interface Portlet
Returns:
the user principal strategy of the portlet

setUserPrincipalStrategy

public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy)
Description copied from interface: Portlet
Sets the user principal strategy of the portlet.

Specified by:
setUserPrincipalStrategy in interface Portlet
Parameters:
userPrincipalStrategy - the user principal strategy of the portlet

getPrivateRequestAttributes

public boolean getPrivateRequestAttributes()
Description copied from interface: Portlet
Returns true if the portlet does not share request attributes with the portal or portlets from another WAR.

Specified by:
getPrivateRequestAttributes in interface Portlet
Returns:
true if the portlet does not share request attributes with the portal or portlets from another WAR

isPrivateRequestAttributes

public boolean isPrivateRequestAttributes()
Description copied from interface: Portlet
Returns true if the portlet does not share request attributes with the portal or portlets from another WAR.

Specified by:
isPrivateRequestAttributes in interface Portlet
Returns:
true if the portlet does not share request attributes with the portal or portlets from another WAR

setPrivateRequestAttributes

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

Specified by:
setPrivateRequestAttributes in interface Portlet
Parameters:
privateRequestAttributes - boolean value for whether the portlet shares request attributes with the portal or portlets from another WAR

getPrivateSessionAttributes

public boolean getPrivateSessionAttributes()
Description copied from interface: Portlet
Returns true if the portlet does not share session attributes with the portal.

Specified by:
getPrivateSessionAttributes in interface Portlet
Returns:
true if the portlet does not share session attributes with the portal

isPrivateSessionAttributes

public boolean isPrivateSessionAttributes()
Description copied from interface: Portlet
Returns true if the portlet does not share session attributes with the portal.

Specified by:
isPrivateSessionAttributes in interface Portlet
Returns:
true if the portlet does not share session attributes with the portal

setPrivateSessionAttributes

public void setPrivateSessionAttributes(boolean privateSessionAttributes)
Description copied from interface: Portlet
Set to true if the portlet does not share session attributes with the portal.

Specified by:
setPrivateSessionAttributes in interface Portlet
Parameters:
privateSessionAttributes - boolean value for whether the portlet shares session attributes with the portal

getRenderWeight

public int getRenderWeight()
Description copied from interface: Portlet
Returns the render weight of the portlet.

Specified by:
getRenderWeight in interface Portlet
Returns:
the render weight of the portlet

setRenderWeight

public void setRenderWeight(int renderWeight)
Description copied from interface: Portlet
Sets the render weight of the portlet.

Specified by:
setRenderWeight in interface Portlet
Parameters:
renderWeight - int value for the render weight of the portlet

getAjaxable

public boolean getAjaxable()
Description copied from interface: Portlet
Returns true if the portlet can be displayed via Ajax.

Specified by:
getAjaxable in interface Portlet
Returns:
true if the portlet can be displayed via Ajax

isAjaxable

public boolean isAjaxable()
Description copied from interface: Portlet
Returns true if the portlet can be displayed via Ajax.

Specified by:
isAjaxable in interface Portlet
Returns:
true if the portlet can be displayed via Ajax

setAjaxable

public void setAjaxable(boolean ajaxable)
Description copied from interface: Portlet
Set to true if the portlet can be displayed via Ajax.

Specified by:
setAjaxable in interface Portlet
Parameters:
ajaxable - boolean value for whether the portlet can be displayed via Ajax

getHeaderPortalCss

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

Specified by:
getHeaderPortalCss in interface Portlet
Returns:
a list of CSS files that will be referenced from the page's header relative to the portal's context path

setHeaderPortalCss

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

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

getHeaderPortletCss

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

Specified by:
getHeaderPortletCss in interface Portlet
Returns:
a list of CSS files that will be referenced from the page's header relative to the portlet's context path

setHeaderPortletCss

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

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

getHeaderPortalJavaScript

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

Specified by:
getHeaderPortalJavaScript in interface Portlet
Returns:
a list of JavaScript files that will be referenced from the page's header relative to the portal's context path

setHeaderPortalJavaScript

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

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

getHeaderPortletJavaScript

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

Specified by:
getHeaderPortletJavaScript in interface Portlet
Returns:
a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path

setHeaderPortletJavaScript

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

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

getFooterPortalCss

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

Specified by:
getFooterPortalCss in interface Portlet
Returns:
a list of CSS files that will be referenced from the page's footer relative to the portal's context path

setFooterPortalCss

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

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

getFooterPortletCss

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

Specified by:
getFooterPortletCss in interface Portlet
Returns:
a list of CSS files that will be referenced from the page's footer relative to the portlet's context path

setFooterPortletCss

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

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

getFooterPortalJavaScript

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

Specified by:
getFooterPortalJavaScript in interface Portlet
Returns:
a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path

setFooterPortalJavaScript

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

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

getFooterPortletJavaScript

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

Specified by:
getFooterPortletJavaScript in interface Portlet
Returns:
a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path

setFooterPortletJavaScript

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

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

getCssClassWrapper

public java.lang.String getCssClassWrapper()
Description copied from interface: Portlet
Gets the name of the CSS class that will be injected in the DIV that wraps this portlet.

Specified by:
getCssClassWrapper in interface Portlet
Returns:
the name of the CSS class that will be injected in the DIV that wraps this portlet

setCssClassWrapper

public void setCssClassWrapper(java.lang.String cssClassWrapper)
Description copied from interface: Portlet
Sets the name of the CSS class that will be injected in the DIV that wraps this portlet.

Specified by:
setCssClassWrapper in interface Portlet
Parameters:
cssClassWrapper - the name of the CSS class that will be injected in the DIV that wraps this portlet

getFacebookIntegration

public java.lang.String getFacebookIntegration()
Description copied from interface: Portlet
Gets the Facebook integration method of the portlet.

Specified by:
getFacebookIntegration in interface Portlet
Returns:
the Facebook integration method of the portlet

setFacebookIntegration

public void setFacebookIntegration(java.lang.String facebookIntegration)
Description copied from interface: Portlet
Sets the Facebook integration method of the portlet.

Specified by:
setFacebookIntegration in interface Portlet
Parameters:
facebookIntegration - the Facebook integration method of the portlet

getAddDefaultResource

public boolean getAddDefaultResource()
Description copied from interface: Portlet
Returns true if default resources for the portlet are added to a page.

Specified by:
getAddDefaultResource in interface Portlet
Returns:
true if default resources for the portlet are added to a page

isAddDefaultResource

public boolean isAddDefaultResource()
Description copied from interface: Portlet
Returns true if default resources for the portlet are added to a page.

Specified by:
isAddDefaultResource in interface Portlet
Returns:
true if default resources for the portlet are added to a page

setAddDefaultResource

public void setAddDefaultResource(boolean addDefaultResource)
Description copied from interface: Portlet
Set to true if default resources for the portlet are added to a page.

Specified by:
setAddDefaultResource in interface Portlet
Parameters:
addDefaultResource - boolean value for whether or not default resources for the portlet are added to a page

getRolesArray

public java.lang.String[] getRolesArray()
Description copied from interface: Portlet
Gets an array of required roles of the portlet.

Specified by:
getRolesArray in interface Portlet
Returns:
an array of required roles of the portlet

setRolesArray

public void setRolesArray(java.lang.String[] rolesArray)
Description copied from interface: Portlet
Sets an array of required roles of the portlet.

Specified by:
setRolesArray in interface Portlet
Parameters:
rolesArray - an array of required roles of the portlet

getUnlinkedRoles

public java.util.Set<java.lang.String> getUnlinkedRoles()
Description copied from interface: Portlet
Gets the unlinked roles of the portlet.

Specified by:
getUnlinkedRoles in interface Portlet
Returns:
unlinked roles of the portlet

setUnlinkedRoles

public void setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles)
Description copied from interface: Portlet
Sets the unlinked roles of the portlet.

Specified by:
setUnlinkedRoles in interface Portlet
Parameters:
unlinkedRoles - the unlinked roles of the portlet

getRoleMappers

public java.util.Map<java.lang.String,java.lang.String> getRoleMappers()
Description copied from interface: Portlet
Gets the role mappers of the portlet.

Specified by:
getRoleMappers in interface Portlet
Returns:
role mappers of the portlet

setRoleMappers

public void setRoleMappers(java.util.Map<java.lang.String,java.lang.String> roleMappers)
Description copied from interface: Portlet
Sets the role mappers of the portlet.

Specified by:
setRoleMappers in interface Portlet
Parameters:
roleMappers - the role mappers of the portlet

linkRoles

public void linkRoles()
Description copied from interface: Portlet
Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml.

Specified by:
linkRoles in interface Portlet

hasRoleWithName

public boolean hasRoleWithName(java.lang.String roleName)
Description copied from interface: Portlet
Returns true if the portlet has a role with the specified name.

Specified by:
hasRoleWithName in interface Portlet
Returns:
true if the portlet has a role with the specified name

hasAddPortletPermission

public boolean hasAddPortletPermission(long userId)
Description copied from interface: Portlet
Returns true if the user has the permission to add the portlet to a layout.

Specified by:
hasAddPortletPermission in interface Portlet
Returns:
true if the user has the permission to add the portlet to a layout

getSystem

public boolean getSystem()
Description copied from interface: Portlet
Returns true if the portlet is a system portlet that a user cannot manually add to their page.

Specified by:
getSystem in interface Portlet
Returns:
true if the portlet is a system portlet that a user cannot manually add to their page

isSystem

public boolean isSystem()
Description copied from interface: Portlet
Returns true if the portlet is a system portlet that a user cannot manually add to their page.

Specified by:
isSystem in interface Portlet
Returns:
true if the portlet is a system portlet that a user cannot manually add to their page

setSystem

public void setSystem(boolean system)
Description copied from interface: Portlet
Set to true if the portlet is a system portlet that a user cannot manually add to their page.

Specified by:
setSystem in interface Portlet
Parameters:
system - boolean value for whether the portlet is a system portlet that a user cannot manually add to their page

getInclude

public boolean getInclude()
Description copied from interface: Portlet
Returns true to include the portlet and make it available to be made active.

Specified by:
getInclude in interface Portlet
Returns:
true to include the portlet and make it available to be made active

isInclude

public boolean isInclude()
Description copied from interface: Portlet
Returns true to include the portlet and make it available to be made active.

Specified by:
isInclude in interface Portlet
Returns:
true to include the portlet and make it available to be made active

setInclude

public void setInclude(boolean include)
Description copied from interface: Portlet
Set to true to include the portlet and make it available to be made active.

Specified by:
setInclude in interface Portlet
Parameters:
include - boolean value for whether to include the portlet and make it available to be made active

getReady

public boolean getReady()
Description copied from interface: Portlet
Returns true if the portlet is ready to be used.

Specified by:
getReady in interface Portlet
Returns:
true if the portlet is ready to be used

isReady

public boolean isReady()
Description copied from interface: Portlet
Returns true if the portlet is ready to be used.

Specified by:
isReady in interface Portlet
Returns:
true if the portlet is ready to be used

setReady

public void setReady(boolean ready)
Description copied from interface: Portlet
Set to true if the portlet is ready to be used.

Specified by:
setReady in interface Portlet

getInitParams

public java.util.Map<java.lang.String,java.lang.String> getInitParams()
Description copied from interface: Portlet
Gets the init parameters of the portlet.

Specified by:
getInitParams in interface Portlet
Returns:
init parameters of the portlet

setInitParams

public void setInitParams(java.util.Map<java.lang.String,java.lang.String> initParams)
Description copied from interface: Portlet
Sets the init parameters of the portlet.

Specified by:
setInitParams in interface Portlet
Parameters:
initParams - the init parameters of the portlet

getExpCache

public java.lang.Integer getExpCache()
Description copied from interface: Portlet
Gets expiration cache of the portlet.

Specified by:
getExpCache in interface Portlet
Returns:
expiration cache of the portlet

setExpCache

public void setExpCache(java.lang.Integer expCache)
Description copied from interface: Portlet
Sets expiration cache of the portlet.

Specified by:
setExpCache in interface Portlet
Parameters:
expCache - expiration cache of the portlet

getPortletModes

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getPortletModes()
Description copied from interface: Portlet
Gets the portlet modes of the portlet.

Specified by:
getPortletModes in interface Portlet
Returns:
portlet modes of the portlet

setPortletModes

public void setPortletModes(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> portletModes)
Description copied from interface: Portlet
Sets the portlet modes of the portlet.

Specified by:
setPortletModes in interface Portlet
Parameters:
portletModes - the portlet modes of the portlet

hasPortletMode

public boolean hasPortletMode(java.lang.String mimeType,
                              javax.portlet.PortletMode portletMode)
Description copied from interface: Portlet
Returns true if the portlet supports the specified mime type and portlet mode.

Specified by:
hasPortletMode in interface Portlet
Returns:
true if the portlet supports the specified mime type and portlet mode

getAllPortletModes

public java.util.Set<java.lang.String> getAllPortletModes()
Description copied from interface: Portlet
Gets a list of all portlet modes supported by the portlet.

Specified by:
getAllPortletModes in interface Portlet
Returns:
a list of all portlet modes supported by the portlet

hasMultipleMimeTypes

public boolean hasMultipleMimeTypes()
Description copied from interface: Portlet
Returns true if the portlet supports more than one mime type.

Specified by:
hasMultipleMimeTypes in interface Portlet
Returns:
true if the portlet supports more than one mime type

getWindowStates

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getWindowStates()
Description copied from interface: Portlet
Gets the window states of the portlet.

Specified by:
getWindowStates in interface Portlet
Returns:
window states of the portlet

setWindowStates

public void setWindowStates(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> windowStates)
Description copied from interface: Portlet
Sets the window states of the portlet.

Specified by:
setWindowStates in interface Portlet
Parameters:
windowStates - the window states of the portlet

hasWindowState

public boolean hasWindowState(java.lang.String mimeType,
                              javax.portlet.WindowState windowState)
Description copied from interface: Portlet
Returns true if the portlet supports the specified mime type and window state.

Specified by:
hasWindowState in interface Portlet
Returns:
true if the portlet supports the specified mime type and window state

getAllWindowStates

public java.util.Set<java.lang.String> getAllWindowStates()
Description copied from interface: Portlet
Gets a list of all window states supported by the portlet.

Specified by:
getAllWindowStates in interface Portlet
Returns:
a list of all window states supported by the portlet

getSupportedLocales

public java.util.Set<java.lang.String> getSupportedLocales()
Description copied from interface: Portlet
Gets the supported locales of the portlet.

Specified by:
getSupportedLocales in interface Portlet
Returns:
supported locales of the portlet

setSupportedLocales

public void setSupportedLocales(java.util.Set<java.lang.String> supportedLocales)
Description copied from interface: Portlet
Sets the supported locales of the portlet.

Specified by:
setSupportedLocales in interface Portlet
Parameters:
supportedLocales - the supported locales of the portlet

getResourceBundle

public java.lang.String getResourceBundle()
Description copied from interface: Portlet
Gets the resource bundle of the portlet.

Specified by:
getResourceBundle in interface Portlet
Returns:
resource bundle of the portlet

setResourceBundle

public void setResourceBundle(java.lang.String resourceBundle)
Description copied from interface: Portlet
Sets the resource bundle of the portlet.

Specified by:
setResourceBundle in interface Portlet
Parameters:
resourceBundle - the resource bundle of the portlet

getPortletInfo

public PortletInfo getPortletInfo()
Description copied from interface: Portlet
Gets the portlet info of the portlet.

Specified by:
getPortletInfo in interface Portlet
Returns:
portlet info of the portlet

setPortletInfo

public void setPortletInfo(PortletInfo portletInfo)
Description copied from interface: Portlet
Sets the portlet info of the portlet.

Specified by:
setPortletInfo in interface Portlet
Parameters:
portletInfo - the portlet info of the portlet

getPortletFilters

public java.util.Map<java.lang.String,PortletFilter> getPortletFilters()
Description copied from interface: Portlet
Gets the filters of the portlet.

Specified by:
getPortletFilters in interface Portlet
Returns:
filters of the portlet

setPortletFilters

public void setPortletFilters(java.util.Map<java.lang.String,PortletFilter> portletFilters)
Description copied from interface: Portlet
Sets the filters of the portlet.

Specified by:
setPortletFilters in interface Portlet
Parameters:
portletFilters - the filters of the portlet

addProcessingEvent

public void addProcessingEvent(com.liferay.portal.kernel.xml.QName processingEvent)
Description copied from interface: Portlet
Adds a supported processing event.

Specified by:
addProcessingEvent in interface Portlet

getProcessingEvent

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

Specified by:
getProcessingEvent in interface Portlet
Returns:
the supported processing event from a namespace URI and a local part

getProcessingEvents

public java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents()
Description copied from interface: Portlet
Gets the supported processing events of the portlet.

Specified by:
getProcessingEvents in interface Portlet
Returns:
supported processing events of the portlet

setProcessingEvents

public void setProcessingEvents(java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents)
Description copied from interface: Portlet
Sets the supported processing events of the portlet.

Specified by:
setProcessingEvents in interface Portlet
Parameters:
processingEvents - the supported processing events of the portlet

addPublishingEvent

public void addPublishingEvent(com.liferay.portal.kernel.xml.QName publishingEvent)
Description copied from interface: Portlet
Adds a supported publishing event.

Specified by:
addPublishingEvent in interface Portlet

getPublishingEvents

public java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents()
Description copied from interface: Portlet
Gets the supported publishing events of the portlet.

Specified by:
getPublishingEvents in interface Portlet
Returns:
supported publishing events of the portlet

setPublishingEvents

public void setPublishingEvents(java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents)
Description copied from interface: Portlet
Sets the supported publishing events of the portlet.

Specified by:
setPublishingEvents in interface Portlet
Parameters:
publishingEvents - the supported publishing events of the portlet

addPublicRenderParameter

public void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
Description copied from interface: Portlet
Adds a supported public render parameter.

Specified by:
addPublicRenderParameter in interface Portlet
Parameters:
publicRenderParameter - a supported public render parameter

getPublicRenderParameter

public PublicRenderParameter getPublicRenderParameter(java.lang.String identifier)
Description copied from interface: Portlet
Gets the supported public render parameter from an identifier.

Specified by:
getPublicRenderParameter in interface Portlet
Returns:
the supported public render parameter from an identifier

getPublicRenderParameter

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

Specified by:
getPublicRenderParameter in interface Portlet
Returns:
the supported public render parameter from a namespace URI and a local part

getPublicRenderParameters

public java.util.Set<PublicRenderParameter> getPublicRenderParameters()
Description copied from interface: Portlet
Gets the supported public render parameters of the portlet.

Specified by:
getPublicRenderParameters in interface Portlet
Returns:
the supported public render parameters of the portlet

setPublicRenderParameters

public void setPublicRenderParameters(java.util.Set<PublicRenderParameter> publicRenderParameters)
Description copied from interface: Portlet
Sets the supported public render parameters of the portlet.

Specified by:
setPublicRenderParameters in interface Portlet
Parameters:
publicRenderParameters - the supported public render parameters of the portlet

getContextPath

public java.lang.String getContextPath()
Description copied from interface: Portlet
Gets the servlet context path of the portlet.

Specified by:
getContextPath in interface Portlet
Returns:
the servlet context path of the portlet

getPortletApp

public PortletApp getPortletApp()
Description copied from interface: Portlet
Get the application this portlet belongs to.

Specified by:
getPortletApp in interface Portlet
Returns:
the application this portlet belongs to

setPortletApp

public void setPortletApp(PortletApp portletApp)
Description copied from interface: Portlet
Sets the application this portlet belongs to.

Specified by:
setPortletApp in interface Portlet
Parameters:
portletApp - the application this portlet belongs to

getClonedInstance

public Portlet getClonedInstance(java.lang.String portletId)
Description copied from interface: Portlet
Returns true if the portlet is found in a WAR file.

Specified by:
getClonedInstance in interface Portlet
Parameters:
portletId - the cloned instance portlet id
Returns:
a cloned instance of the portlet

getStatic

public boolean getStatic()
Description copied from interface: Portlet
Returns true if the portlet is a static portlet that is cannot be moved.

Specified by:
getStatic in interface Portlet
Returns:
true if the portlet is a static portlet that is cannot be moved

isStatic

public boolean isStatic()
Description copied from interface: Portlet
Returns true if the portlet is a static portlet that is cannot be moved.

Specified by:
isStatic in interface Portlet
Returns:
true if the portlet is a static portlet that is cannot be moved

setStatic

public void setStatic(boolean staticPortlet)
Description copied from interface: Portlet
Set to true if the portlet is a static portlet that is cannot be moved.

Specified by:
setStatic in interface Portlet
Parameters:
staticPortlet - boolean value for whether the portlet is a static portlet that cannot be moved

getStaticStart

public boolean getStaticStart()
Description copied from interface: Portlet
Returns true if the portlet is a static portlet at the start of a list of portlets.

Specified by:
getStaticStart in interface Portlet
Returns:
true if the portlet is a static portlet at the start of a list of portlets

isStaticStart

public boolean isStaticStart()
Description copied from interface: Portlet
Returns true if the portlet is a static portlet at the start of a list of portlets.

Specified by:
isStaticStart in interface Portlet
Returns:
true if the portlet is a static portlet at the start of a list of portlets

setStaticStart

public void setStaticStart(boolean staticPortletStart)
Description copied from interface: Portlet
Set to true if the portlet is a static portlet at the start of a list of portlets.

Specified by:
setStaticStart in interface Portlet
Parameters:
staticPortletStart - boolean value for whether the portlet is a static portlet at the start of a list of portlets

getStaticEnd

public boolean getStaticEnd()
Description copied from interface: Portlet
Returns true if the portlet is a static portlet at the end of a list of portlets.

Specified by:
getStaticEnd in interface Portlet
Returns:
true if the portlet is a static portlet at the end of a list of portlets

isStaticEnd

public boolean isStaticEnd()
Description copied from interface: Portlet
Returns true if the portlet is a static portlet at the end of a list of portlets.

Specified by:
isStaticEnd in interface Portlet
Returns:
true if the portlet is a static portlet at the end of a list of portlets

getUndeployedPortlet

public boolean getUndeployedPortlet()
Description copied from interface: Portlet
Returns true if the portlet is an undeployed portlet.

Specified by:
getUndeployedPortlet in interface Portlet
Returns:
true if the portlet is a placeholder of an undeployed portlet

isUndeployedPortlet

public boolean isUndeployedPortlet()
Description copied from interface: Portlet
Returns true if the portlet is an undeployed portlet.

Specified by:
isUndeployedPortlet in interface Portlet
Returns:
true if the portlet is a placeholder of an undeployed portlet

setUndeployedPortlet

public void setUndeployedPortlet(boolean undeployedPortlet)
Description copied from interface: Portlet
Set to true if the portlet is an undeployed portlet.

Specified by:
setUndeployedPortlet in interface Portlet
Parameters:
undeployedPortlet - boolean value for whether the portlet is an undeployed portlet

equals

public boolean equals(java.lang.Object obj)
Description copied from interface: Portlet
Checks whether this portlet is equal to the specified object.

Specified by:
equals in interface Portlet
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

getWrappedPortlet

public Portlet getWrappedPortlet()