Class PortletImpl

Object
com.liferay.portal.kernel.model.impl.BaseModelImpl<com.liferay.portal.kernel.model.Portlet>
All Implemented Interfaces:
com.liferay.portal.kernel.model.BaseModel<com.liferay.portal.kernel.model.Portlet>, com.liferay.portal.kernel.model.ClassedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.PersistedModel, com.liferay.portal.kernel.model.Portlet, com.liferay.portal.kernel.model.PortletModel, com.liferay.portal.kernel.model.ShardedModel, Serializable, Cloneable, Comparable<com.liferay.portal.kernel.model.Portlet>

public class PortletImpl extends PortletBaseImpl
Author:
Brian Wing Shun Chan
See Also:
  • Constructor Details

    • PortletImpl

      public PortletImpl()
      Constructs a portlet with no parameters.
    • PortletImpl

      public PortletImpl(long companyId, String portletId)
      Constructs a portlet with the specified parameters.
    • PortletImpl

      public PortletImpl(String portletId, com.liferay.portal.kernel.model.Portlet rootPortlet, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage, com.liferay.portal.kernel.model.PluginSetting defaultPluginSetting, long companyId, String icon, String virtualPath, String strutsPath, String parentStrutsPath, String portletName, String displayName, Set<String> categoryNames, String portletClass, String configurationActionClass, List<String> indexerClasses, String openSearchClass, List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries, String portletURLClass, String friendlyURLMapperClass, String friendlyURLMapping, String friendlyURLRoutes, String urlEncoderClass, String portletDataHandlerClass, List<String> stagedModelDataHandlerClasses, String templateHandlerClass, String portletConfigurationListenerClass, String portletLayoutListenerClass, String popMessageListenerClass, List<String> socialActivityInterpreterClasses, String socialRequestInterpreterClass, String userNotificationDefinitions, List<String> userNotificationHandlerClasses, String webDAVStorageToken, String webDAVStorageClass, String xmlRpcMethodClass, String controlPanelEntryCategory, double controlPanelEntryWeight, String controlPanelEntryClass, List<String> assetRendererFactoryClasses, List<String> customAttributesDisplayClasses, String permissionPropagatorClass, List<String> trashHandlerClasses, List<String> workflowHandlerClasses, String defaultPreferences, String preferencesValidator, boolean preferencesCompanyWide, boolean preferencesUniquePerLayout, boolean preferencesOwnedByGroup, boolean useDefaultTemplate, boolean showPortletAccessDenied, boolean showPortletInactive, boolean actionURLRedirect, boolean restoreCurrentView, boolean maximizeEdit, boolean maximizeHelp, boolean popUpPrint, boolean layoutCacheable, boolean instanceable, boolean scopeable, boolean singlePageApplication, String userPrincipalStrategy, boolean privateRequestAttributes, boolean privateSessionAttributes, Set<String> autopropagatedParameters, boolean requiresNamespacedParameters, int actionTimeout, int renderTimeout, int renderWeight, boolean ajaxable, List<String> headerPortalCss, List<String> headerPortletCss, List<String> headerPortalJavaScript, List<String> headerPortletJavaScript, List<String> headerRequestAttributePrefixes, int headerTimeout, List<String> footerPortalCss, List<String> footerPortletCss, List<String> footerPortalJavaScript, List<String> footerPortletJavaScript, boolean partialActionServeResource, boolean portletDependencyCssEnabled, boolean portletDependencyJavaScriptEnabled, List<com.liferay.portal.kernel.model.portlet.PortletDependency> portletDependencies, String cssClassWrapper, boolean addDefaultResource, String roles, Set<String> unlinkedRoles, Map<String,String> roleMappers, boolean system, boolean active, boolean include, Map<String,String> initParams, Integer expCache, boolean asyncSupported, int multipartFileSizeThreshold, String multipartLocation, long multipartMaxFileSize, long multipartMaxRequestSize, Map<String,Set<String>> portletModes, Map<String,Set<String>> windowStates, Set<String> supportedLocales, String resourceBundle, com.liferay.portal.kernel.model.PortletInfo portletInfo, Map<String,com.liferay.portal.kernel.model.PortletFilter> portletFilters, Set<com.liferay.portal.kernel.xml.QName> processingEvents, Set<com.liferay.portal.kernel.xml.QName> publishingEvents, Set<com.liferay.portal.kernel.model.PublicRenderParameter> publicRenderParameters, com.liferay.portal.kernel.model.PortletApp portletApp)
      Constructs a portlet with the specified parameters.
  • Method Details

    • addApplicationType

      public void addApplicationType(com.liferay.portal.kernel.application.type.ApplicationType applicationType)
      Adds an application type.
      Parameters:
      applicationType - an application type
    • addPortletDependency

      public void addPortletDependency(com.liferay.portal.kernel.model.portlet.PortletDependency portletDependency)
      Adds a portlet CSS/JavaScript resource dependency.
      Parameters:
      portletDependency - the portlet CSS/JavaScript resource dependency
    • addProcessingEvent

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

      public void addPublicRenderParameter(com.liferay.portal.kernel.model.PublicRenderParameter publicRenderParameter)
      Adds a public render parameter.
      Parameters:
      publicRenderParameter - a public render parameter
    • addPublishingEvent

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

      public void addSchedulerEntry(com.liferay.portal.kernel.scheduler.SchedulerEntry schedulerEntry)
      Adds a scheduler entry.
    • clone

      public Object clone()
      Creates and returns a copy of this object.
      Specified by:
      clone in interface com.liferay.portal.kernel.model.BaseModel<com.liferay.portal.kernel.model.Portlet>
      Specified by:
      clone in interface com.liferay.portal.kernel.model.Portlet
      Overrides:
      clone in class PortletModelImpl
      Returns:
      a copy of this object
    • compareTo

      public int compareTo(com.liferay.portal.kernel.model.Portlet portlet)
      Compares this portlet to the specified object.
      Specified by:
      compareTo in interface Comparable<com.liferay.portal.kernel.model.Portlet>
      Specified by:
      compareTo in interface com.liferay.portal.kernel.model.Portlet
      Overrides:
      compareTo in class PortletModelImpl
      Parameters:
      portlet - the portlet to compare this portlet against
      Returns:
      the value 0 if the argument portlet is equal to this portlet; a value less than -1 if this portlet is less than the portlet argument; and 1 if this portlet is greater than the portlet argument
    • equals

      public boolean equals(Object object)
      Checks whether this portlet is equal to the specified object.
      Specified by:
      equals in interface com.liferay.portal.kernel.model.Portlet
      Overrides:
      equals in class PortletModelImpl
      Parameters:
      object - the object to compare this portlet against
      Returns:
      true if the portlet is equal to the specified object
    • getActionTimeout

      public int getActionTimeout()
      Returns the action timeout of the portlet.
      Returns:
      the action timeout of the portlet
    • getActionURLRedirect

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

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

      public boolean getAjaxable()
      Returns true if the portlet can be displayed via Ajax.
      Returns:
      true if the portlet can be displayed via Ajax
    • getAllPortletModes

      public Set<String> getAllPortletModes()
      Returns the portlet modes of the portlet.
      Returns:
      the portlet modes of the portlet
    • getAllWindowStates

      public Set<String> getAllWindowStates()
      Returns the window states of the portlet.
      Returns:
      the window states of the portlet
    • getApplicationTypes

      public Set<com.liferay.portal.kernel.application.type.ApplicationType> getApplicationTypes()
      Returns the application types of the portlet.
      Returns:
      the application types of the portlet
    • getAssetRendererFactoryClasses

      public List<String> getAssetRendererFactoryClasses()
      Returns the names of the classes that represent asset types associated with the portlet.
      Returns:
      the names of the classes that represent asset types associated with the portlet
    • getAutopropagatedParameters

      public Set<String> getAutopropagatedParameters()
      Returns the names of the parameters that will be automatically propagated through the portlet.
      Returns:
      the names of the parameters that will be automatically propagated through the portlet
    • getCategoryNames

      public Set<String> getCategoryNames()
      Returns the category names of the portlet.
      Returns:
      the category names of the portlet
    • getClonedInstance

      public com.liferay.portal.kernel.model.Portlet getClonedInstance(String portletId)
      Returns true if the portlet is found in a WAR file.
      Parameters:
      portletId - the cloned instance portlet ID
      Returns:
      a cloned instance of the portlet
    • getConfigurationActionClass

      public String getConfigurationActionClass()
      Returns the configuration action class of the portlet.
      Returns:
      the configuration action class of the portlet
    • getConfigurationActionInstance

      public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance()
      Returns the configuration action instance of the portlet.
      Returns:
      the configuration action instance of the portlet
    • getContextName

      public String getContextName()
      Returns the servlet context name of the portlet.
      Returns:
      the servlet context name of the portlet
    • getContextPath

      public String getContextPath()
      Returns the servlet context path of the portlet.
      Returns:
      the servlet context path of the portlet
    • getControlPanelEntryCategory

      public String getControlPanelEntryCategory()
      Returns the name of the category of the Control Panel where the portlet will be shown.
      Returns:
      the name of the category of the Control Panel where the portlet will be shown
    • getControlPanelEntryClass

      public String getControlPanelEntryClass()
      Returns the name of the class that will control when the portlet will be shown in the Control Panel.
      Returns:
      the name of the class that will control when the portlet will be shown in the Control Panel
    • getControlPanelEntryInstance

      public com.liferay.portal.kernel.portlet.ControlPanelEntry getControlPanelEntryInstance()
      Returns an instance of the class that will control when the portlet will be shown in the Control Panel.
      Returns:
      the instance of the class that will control when the portlet will be shown in the Control Panel
    • getControlPanelEntryWeight

      public double getControlPanelEntryWeight()
      Returns the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.
      Returns:
      the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel
    • getCssClassWrapper

      public String getCssClassWrapper()
      Returns the name of the CSS class that will be injected in the DIV that wraps this portlet.
      Returns:
      the name of the CSS class that will be injected in the DIV that wraps this portlet
    • getCustomAttributesDisplayClasses

      public List<String> getCustomAttributesDisplayClasses()
      Returns the names of the classes that represent custom attribute displays associated with the portlet.
      Returns:
      the names of the classes that represent asset types associated with the portlet
    • getCustomAttributesDisplayInstances

      public List<com.liferay.expando.kernel.model.CustomAttributesDisplay> getCustomAttributesDisplayInstances()
      Returns the custom attribute display instances of the portlet.
      Returns:
      the custom attribute display instances of the portlet
    • getDefaultPluginSetting

      public com.liferay.portal.kernel.model.PluginSetting getDefaultPluginSetting()
      Get the default plugin settings of the portlet.
      Returns:
      the plugin settings
    • getDefaultPreferences

      public String getDefaultPreferences()
      Returns the default preferences of the portlet.
      Returns:
      the default preferences of the portlet
    • getDisplayName

      public String getDisplayName()
      Returns the display name of the portlet.
      Returns:
      the display name of the portlet
    • getExpCache

      public Integer getExpCache()
      Returns expiration cache of the portlet.
      Returns:
      expiration cache of the portlet
    • getFooterPortalCss

      public List<String> getFooterPortalCss()
      Returns a list of CSS files that will be referenced from the page's footer relative to the portal's context path.
      Returns:
      a list of CSS files that will be referenced from the page's footer relative to the portal's context path
    • getFooterPortalJavaScript

      public List<String> getFooterPortalJavaScript()
      Returns a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.
      Returns:
      a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path
    • getFooterPortletCss

      public List<String> getFooterPortletCss()
      Returns a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.
      Returns:
      a list of CSS files that will be referenced from the page's footer relative to the portlet's context path
    • getFooterPortletJavaScript

      public List<String> getFooterPortletJavaScript()
      Returns a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.
      Returns:
      a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path
    • getFriendlyURLMapperClass

      public String getFriendlyURLMapperClass()
      Returns the name of the friendly URL mapper class of the portlet.
      Returns:
      the name of the friendly URL mapper class of the portlet
    • getFriendlyURLMapperInstance

      public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance()
      Returns the friendly URL mapper instance of the portlet.
      Returns:
      the friendly URL mapper instance of the portlet
    • getFriendlyURLMapping

      public String getFriendlyURLMapping()
      Returns the name of the friendly URL mapping of the portlet.
      Returns:
      the name of the friendly URL mapping of the portlet
    • getFriendlyURLMapping

      public String getFriendlyURLMapping(boolean lookUpFriendlyURLMapper)
    • getFriendlyURLRoutes

      public String getFriendlyURLRoutes()
      Returns the class loader resource path to the friendly URL routes of the portlet.
      Returns:
      the class loader resource path to the friendly URL routes of the portlet
    • getHeaderPortalCss

      public List<String> getHeaderPortalCss()
      Returns a list of CSS files that will be referenced from the page's header relative to the portal's context path.
      Returns:
      a list of CSS files that will be referenced from the page's header relative to the portal's context path
    • getHeaderPortalJavaScript

      public List<String> getHeaderPortalJavaScript()
      Returns a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.
      Returns:
      a list of JavaScript files that will be referenced from the page's header relative to the portal's context path
    • getHeaderPortletCss

      public List<String> getHeaderPortletCss()
      Returns a list of CSS files that will be referenced from the page's header relative to the portlet's context path.
      Returns:
      a list of CSS files that will be referenced from the page's header relative to the portlet's context path
    • getHeaderPortletJavaScript

      public List<String> getHeaderPortletJavaScript()
      Returns a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.
      Returns:
      a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path
    • getHeaderRequestAttributePrefixes

      public List<String> getHeaderRequestAttributePrefixes()
      Returns a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet. Header request attributes that have names starting with any of the prefixes will be copied from the header request to the subsequent render request.
      Returns:
      a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet. Header request attributes that have names starting with any of the prefixes will be copied from the header request to the subsequent render request.
    • getHeaderTimeout

      public int getHeaderTimeout()
      Returns the header timeout of the portlet.
      Returns:
      the header timeout of the portlet
    • getIcon

      public String getIcon()
      Returns the icon of the portlet.
      Returns:
      the icon of the portlet
    • getInclude

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

      public List<String> getIndexerClasses()
      Returns the names of the classes that represent indexers associated with the portlet.
      Returns:
      the names of the classes that represent indexers associated with the portlet
    • getIndexerInstances

      public List<com.liferay.portal.kernel.search.Indexer<?>> getIndexerInstances()
      Returns the indexer instances of the portlet.
      Returns:
      the indexer instances of the portlet
    • getInitParams

      public Map<String,String> getInitParams()
      Returns the init parameters of the portlet.
      Returns:
      init parameters of the portlet
    • getInstanceable

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

      public String getInstanceId()
      Returns the instance ID of the portlet.
      Returns:
      the instance ID of the portlet
    • getLayoutCacheable

      public boolean getLayoutCacheable()
      Returns true to allow the portlet to be cached within the layout.
      Returns:
      true if the portlet can be cached within the layout
    • getMaximizeEdit

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

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

      public int getMultipartFileSizeThreshold()
      Returns the maximum size of buffered bytes before storing occurs.
      Returns:
      the maximum size of buffered bytes before storing occurs
    • getMultipartLocation

      public String getMultipartLocation()
      Returns the directory for storing uploaded files.
      Returns:
      the directory for storing uploaded files
    • getMultipartMaxFileSize

      public long getMultipartMaxFileSize()
      Returns the maximum number of bytes permitted for an uploaded file.
      Returns:
      the maximum number of bytes permitted for an uploaded file
    • getMultipartMaxRequestSize

      public long getMultipartMaxRequestSize()
      Returns the maximum number of bytes permitted for a multipart request.
      Returns:
      the maximum number of bytes permitted for a multipart request
    • getOpenSearchClass

      public String getOpenSearchClass()
      Returns the name of the open search class of the portlet.
      Returns:
      the name of the open search class of the portlet
    • getOpenSearchInstance

      public com.liferay.portal.kernel.search.OpenSearch getOpenSearchInstance()
      Returns the indexer instance of the portlet.
      Returns:
      the indexer instance of the portlet
    • getParentStrutsPath

      public String getParentStrutsPath()
      Returns the parent struts path of the portlet.
      Returns:
      the parent struts path of the portlet.
    • getPermissionPropagatorClass

      public String getPermissionPropagatorClass()
      Returns the name of the permission propagator class of the portlet.
      Returns:
      the name of the permission propagator class of the portlet
    • getPermissionPropagatorInstance

      public com.liferay.portal.kernel.security.permission.propagator.PermissionPropagator getPermissionPropagatorInstance()
      Returns the permission propagator instance of the portlet.
      Returns:
      the permission propagator instance of the portlet
    • getPluginId

      public String getPluginId()
      Returns the plugin ID of the portlet.
      Returns:
      the plugin ID of the portlet
    • getPluginPackage

      public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage()
      Returns this portlet's plugin package.
      Returns:
      this portlet's plugin package
    • getPluginType

      public String getPluginType()
      Returns the plugin type of the portlet.
      Returns:
      the plugin type of the portlet
    • getPopMessageListenerClass

      public String getPopMessageListenerClass()
      Returns the name of the POP message listener class of the portlet.
      Returns:
      the name of the POP message listener class of the portlet
    • getPopMessageListenerInstance

      public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance()
      Returns the POP message listener instance of the portlet.
      Returns:
      the POP message listener instance of the portlet
    • getPopUpPrint

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

      public com.liferay.portal.kernel.model.PortletApp getPortletApp()
      Returns this portlet's application.
      Returns:
      this portlet's application
    • getPortletClass

      public String getPortletClass()
      Returns the name of the portlet class of the portlet.
      Returns:
      the name of the portlet class of the portlet
    • getPortletConfigurationListenerClass

      public String getPortletConfigurationListenerClass()
    • getPortletConfigurationListenerInstance

      public com.liferay.portal.kernel.portlet.PortletConfigurationListener getPortletConfigurationListenerInstance()
    • getPortletDataHandlerClass

      public String getPortletDataHandlerClass()
      Returns the name of the portlet data handler class of the portlet.
      Returns:
      the name of the portlet data handler class of the portlet
    • getPortletDataHandlerInstance

      public com.liferay.exportimport.kernel.lar.PortletDataHandler getPortletDataHandlerInstance()
      Returns the portlet data handler instance of the portlet.
      Returns:
      the portlet data handler instance of the portlet
    • getPortletDependencies

      public List<com.liferay.portal.kernel.model.portlet.PortletDependency> getPortletDependencies()
      Returns the portlet's CSS/JavaScript resource dependencies.
      Returns:
      the portlet's CSS/JavaScript resource dependencies
    • getPortletFilters

      public Map<String,com.liferay.portal.kernel.model.PortletFilter> getPortletFilters()
      Returns the filters of the portlet.
      Returns:
      filters of the portlet
    • getPortletInfo

      public com.liferay.portal.kernel.model.PortletInfo getPortletInfo()
      Returns the portlet info of the portlet.
      Returns:
      portlet info of the portlet
    • getPortletLayoutListenerClass

      public String getPortletLayoutListenerClass()
      Returns the name of the portlet layout listener class of the portlet.
      Returns:
      the name of the portlet layout listener class of the portlet
    • getPortletLayoutListenerInstance

      public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance()
      Returns the portlet layout listener instance of the portlet.
      Returns:
      the portlet layout listener instance of the portlet
    • getPortletModes

      public Map<String,Set<String>> getPortletModes()
      Returns the portlet modes of the portlet.
      Returns:
      portlet modes of the portlet
    • getPortletName

      public String getPortletName()
      Returns the name of the portlet.
      Returns:
      the display name of the portlet
    • getPortletURLClass

      public String getPortletURLClass()
      Returns the name of the portlet URL class of the portlet.
      Returns:
      the name of the portlet URL class of the portlet
    • getPreferencesCompanyWide

      public boolean getPreferencesCompanyWide()
      Returns true if preferences are shared across the entire company.
      Returns:
      true if preferences are shared across the entire company
    • getPreferencesOwnedByGroup

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

      public boolean getPreferencesUniquePerLayout()
      Returns true if preferences are unique per layout.
      Returns:
      true if preferences are unique per layout
    • getPreferencesValidator

      public String getPreferencesValidator()
      Returns the name of the preferences validator class of the portlet.
      Returns:
      the name of the preferences validator class of the portlet
    • getPrivateRequestAttributes

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

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

      public com.liferay.portal.kernel.xml.QName getProcessingEvent(String uri, String localPart)
      Returns the processing event from a namespace URI and a local part.
      Parameters:
      uri - the namespace URI
      localPart - the local part
      Returns:
      the processing event from a namespace URI and a local part
    • getProcessingEvents

      public Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents()
      Returns the processing events of the portlet.
      Returns:
      the processing events of the portlet
    • getPublicRenderParameter

      public com.liferay.portal.kernel.model.PublicRenderParameter getPublicRenderParameter(String identifier)
      Returns the public render parameter from an identifier.
      Parameters:
      identifier - the identifier
      Returns:
      the public render parameter from an identifier
    • getPublicRenderParameter

      public com.liferay.portal.kernel.model.PublicRenderParameter getPublicRenderParameter(String uri, String localPart)
      Returns the spublic render parameter from a namespace URI and a local part.
      Parameters:
      uri - the namespace URI
      localPart - the local part
      Returns:
      the spublic render parameter from a namespace URI and a local part
    • getPublicRenderParameters

      public Set<com.liferay.portal.kernel.model.PublicRenderParameter> getPublicRenderParameters()
      Returns the public render parameters of the portlet.
      Returns:
      the public render parameters of the portlet
    • getPublishingEvents

      public Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents()
      Returns the publishing events of the portlet.
      Returns:
      the publishing events of the portlet
    • getReady

      public boolean getReady()
      Returns true if the portlet is ready to be used.
      Returns:
      true if the portlet is ready to be used
    • getRenderTimeout

      public int getRenderTimeout()
      Returns the render timeout of the portlet.
      Returns:
      the render timeout of the portlet
    • getRenderWeight

      public int getRenderWeight()
      Returns the render weight of the portlet.
      Returns:
      the render weight of the portlet
    • getResourceBundle

      public String getResourceBundle()
      Returns the resource bundle of the portlet.
      Returns:
      resource bundle of the portlet
    • getRestoreCurrentView

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

      public Map<String,String> getRoleMappers()
      Returns the role mappers of the portlet.
      Returns:
      role mappers of the portlet
    • getRolesArray

      public String[] getRolesArray()
      Returns an array of required roles of the portlet.
      Returns:
      an array of required roles of the portlet
    • getRootPortlet

      public com.liferay.portal.kernel.model.Portlet getRootPortlet()
      Returns the root portlet of this portlet instance.
      Returns:
      the root portlet of this portlet instance
    • getRootPortletId

      public String getRootPortletId()
      Returns the root portlet ID of the portlet.
      Returns:
      the root portlet ID of the portlet
    • getSchedulerEntries

      public List<com.liferay.portal.kernel.scheduler.SchedulerEntry> getSchedulerEntries()
      Returns the scheduler entries of the portlet.
      Returns:
      the scheduler entries of the portlet
    • getScopeable

      public boolean getScopeable()
      Returns true if the portlet supports scoping of data.
      Returns:
      true if the portlet supports scoping of data
    • getShowPortletAccessDenied

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

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

      public boolean getSinglePageApplication()
      Returns true if the portlet uses Single Page Application.
      Returns:
      true if the portlet uses Single Page Application
    • getSocialActivityInterpreterClasses

      public List<String> getSocialActivityInterpreterClasses()
      Returns the names of the classes that represent social activity interpreters associated with the portlet.
      Returns:
      the names of the classes that represent social activity interpreters associated with the portlet
    • getSocialActivityInterpreterInstances

      public List<com.liferay.social.kernel.model.SocialActivityInterpreter> getSocialActivityInterpreterInstances()
      Returns the social activity interpreter instances of the portlet.
      Returns:
      the social activity interpreter instances of the portlet
    • getSocialRequestInterpreterClass

      public String getSocialRequestInterpreterClass()
      Returns the name of the social request interpreter class of the portlet.
      Returns:
      the name of the social request interpreter class of the portlet
    • getSocialRequestInterpreterInstance

      public com.liferay.social.kernel.model.SocialRequestInterpreter getSocialRequestInterpreterInstance()
      Returns the name of the social request interpreter instance of the portlet.
      Returns:
      the name of the social request interpreter instance of the portlet
    • getStagedModelDataHandlerClasses

      public List<String> getStagedModelDataHandlerClasses()
      Returns the names of the classes that represent staged model data handlers associated with the portlet.
      Returns:
      the names of the classes that represent staged model data handlers associated with the portlet
    • getStagedModelDataHandlerInstances

      public List<com.liferay.exportimport.kernel.lar.StagedModelDataHandler<?>> getStagedModelDataHandlerInstances()
      Returns the staged model data handler instances of the portlet.
      Returns:
      the staged model data handler instances of the portlet
    • getStatic

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

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

      public String getStaticResourcePath()
      Returns the path for static resources served by this portlet.
      Returns:
      the path for static resources served by this portlet
    • getStaticStart

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

      public String getStrutsPath()
      Returns the struts path of the portlet.
      Returns:
      the struts path of the portlet
    • getSupportedLocales

      public Set<String> getSupportedLocales()
      Returns the supported locales of the portlet.
      Returns:
      the supported locales of the portlet
    • getSystem

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

      public String getTemplateHandlerClass()
      Returns the name of the template handler class of the portlet.
      Returns:
      the name of the template handler class of the portlet
    • getTemplateHandlerInstance

      public com.liferay.portal.kernel.template.TemplateHandler getTemplateHandlerInstance()
      Returns the template handler instance of the portlet.
      Returns:
      the template handler instance of the portlet
    • getTimestamp

      public long getTimestamp()
      Returns the timestamp of the portlet.
      Returns:
      the timestamp of the portlet
    • getTrashHandlerClasses

      public List<String> getTrashHandlerClasses()
      Returns the names of the classes that represent trash handlers associated with the portlet.
      Returns:
      the names of the classes that represent trash handlers associated with the portlet
    • getTrashHandlerInstances

      public List<com.liferay.portal.kernel.trash.TrashHandler> getTrashHandlerInstances()
      Returns the trash handler instances of the portlet.
      Returns:
      the trash handler instances of the portlet
    • getUndeployedPortlet

      public boolean getUndeployedPortlet()
      Returns true if the portlet is an undeployed portlet.
      Returns:
      true if the portlet is a placeholder of an undeployed portlet
    • getUnlinkedRoles

      public Set<String> getUnlinkedRoles()
      Returns the unlinked roles of the portlet.
      Returns:
      unlinked roles of the portlet
    • getURLEncoderClass

      public String getURLEncoderClass()
      Returns the name of the URL encoder class of the portlet.
      Returns:
      the name of the URL encoder class of the portlet
    • getURLEncoderInstance

      public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance()
      Returns the URL encoder instance of the portlet.
      Returns:
      the URL encoder instance of the portlet
    • getUseDefaultTemplate

      public boolean getUseDefaultTemplate()
      Returns true if the portlet uses the default template.
      Returns:
      true if the portlet uses the default template
    • getUserId

      public long getUserId()
      Returns the user ID of the portlet. This only applies when the portlet is added by a user in a customizable layout.
      Returns:
      the user ID of the portlet
    • getUserNotificationDefinitions

      public String getUserNotificationDefinitions()
      Returns the class loader resource path to the use notification definitions of the portlet.
      Returns:
      the class loader resource path to the use notification definitions of the portlet
    • getUserNotificationHandlerClasses

      public List<String> getUserNotificationHandlerClasses()
      Returns the names of the classes that represent user notification handlers associated with the portlet.
      Returns:
      the names of the classes that represent user notification handlers associated with the portlet
    • getUserNotificationHandlerInstances

      public List<com.liferay.portal.kernel.notifications.UserNotificationHandler> getUserNotificationHandlerInstances()
      Returns the user notification handler instances of the portlet.
      Returns:
      the user notification handler instances of the portlet
    • getUserPrincipalStrategy

      public String getUserPrincipalStrategy()
      Returns the user principal strategy of the portlet.
      Returns:
      the user principal strategy of the portlet
    • getVirtualPath

      public String getVirtualPath()
      Returns the virtual path of the portlet.
      Returns:
      the virtual path of the portlet
    • getWebDAVStorageClass

      public String getWebDAVStorageClass()
      Returns the name of the WebDAV storage class of the portlet.
      Returns:
      the name of the WebDAV storage class of the portlet
    • getWebDAVStorageInstance

      public com.liferay.portal.kernel.webdav.WebDAVStorage getWebDAVStorageInstance()
      Returns the name of the WebDAV storage instance of the portlet.
      Returns:
      the name of the WebDAV storage instance of the portlet
    • getWebDAVStorageToken

      public String getWebDAVStorageToken()
      Returns the name of the WebDAV storage token of the portlet.
      Returns:
      the name of the WebDAV storage token of the portlet
    • getWindowStates

      public Map<String,Set<String>> getWindowStates()
      Returns the window states of the portlet.
      Returns:
      window states of the portlet
    • getWorkflowHandlerClasses

      public List<String> getWorkflowHandlerClasses()
      Returns the names of the classes that represent workflow handlers associated with the portlet.
      Returns:
      the names of the classes that represent workflow handlers associated with the portlet
    • getWorkflowHandlerInstances

      public List<com.liferay.portal.kernel.workflow.WorkflowHandler<?>> getWorkflowHandlerInstances()
      Returns the workflow handler instances of the portlet.
      Returns:
      the workflow handler instances of the portlet
    • getXmlRpcMethodClass

      public String getXmlRpcMethodClass()
      Returns the name of the XML-RPC method class of the portlet.
      Returns:
      the name of the XML-RPC method class of the portlet
    • getXmlRpcMethodInstance

      public com.liferay.portal.kernel.xmlrpc.Method getXmlRpcMethodInstance()
      Returns the name of the XML-RPC method instance of the portlet.
      Returns:
      the name of the XML-RPC method instance of the portlet
    • hasAddPortletPermission

      public boolean hasAddPortletPermission(long userId)
      Returns true if the user has the permission to add the portlet to a layout.
      Parameters:
      userId - the primary key of the user
      Returns:
      true if the user has the permission to add the portlet to a layout
    • hasFooterPortalCss

      public boolean hasFooterPortalCss()
    • hasFooterPortalJavaScript

      public boolean hasFooterPortalJavaScript()
    • hasFooterPortletCss

      public boolean hasFooterPortletCss()
    • hasFooterPortletJavaScript

      public boolean hasFooterPortletJavaScript()
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.liferay.portal.kernel.model.Portlet
      Overrides:
      hashCode in class PortletModelImpl
    • hasHeaderPortalCss

      public boolean hasHeaderPortalCss()
    • hasHeaderPortalJavaScript

      public boolean hasHeaderPortalJavaScript()
    • hasHeaderPortletCss

      public boolean hasHeaderPortletCss()
    • hasHeaderPortletJavaScript

      public boolean hasHeaderPortletJavaScript()
    • hasMultipleMimeTypes

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

      public boolean hasPortletMode(String mimeType, PortletMode portletMode)
      Returns true if the portlet supports the specified mime type and portlet mode.
      Parameters:
      mimeType - the mime type
      portletMode - the portlet mode
      Returns:
      true if the portlet supports the specified mime type and portlet mode
    • hasRoleWithName

      public boolean hasRoleWithName(String roleName)
      Returns true if the portlet has a role with the specified name.
      Parameters:
      roleName - the role name
      Returns:
      true if the portlet has a role with the specified name
    • hasWindowState

      public boolean hasWindowState(String mimeType, WindowState windowState)
      Returns true if the portlet supports the specified mime type and window state.
      Parameters:
      mimeType - the mime type
      windowState - the window state
      Returns:
      true if the portlet supports the specified mime type and window state
    • isActionURLRedirect

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

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

      public boolean isAjaxable()
      Returns true if the portlet can be displayed via Ajax.
      Returns:
      true if the portlet can be displayed via Ajax
    • isAsyncSupported

      public boolean isAsyncSupported()
      Returns true if the portlet supports asynchronous processing in resource requests.
      Returns:
      true if the portlet supports asynchrounous processing in resource requests
    • isFullPageDisplayable

      public boolean isFullPageDisplayable()
    • isInclude

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

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

      public boolean isLayoutCacheable()
      Returns true to allow the portlet to be cached within the layout.
      Returns:
      true if the portlet can be cached within the layout
    • isMaximizeEdit

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

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

      public boolean isPartialActionServeResource()
      Returns true if the portlet's serveResource(ResourceRequest,ResourceResponse) method should be invoked during a partial action triggered by a different portlet on the same portal page.
      Returns:
      true if the portlet's serveResource(ResourceRequest,ResourceResponse) method should be invoked during a partial action triggered by a different portlet on the same portal page
    • isPopUpPrint

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

      public boolean isPortletDependencyCssEnabled()
      Returns true if the CSS resource dependencies specified in portlet.xml, @Dependency, HeaderResponse.addDependency(String, String, String), or HeaderResponse.addDependency(String, String, String, String) are to be referenced in the page's header.
      Returns:
      true if the specified CSS resource dependencies are to be referenced in the page's header
    • isPortletDependencyJavaScriptEnabled

      public boolean isPortletDependencyJavaScriptEnabled()
      Returns true if the JavaScript resource dependencies specified in portlet.xml, @Dependency, HeaderResponse.addDependency(String, String, String), or HeaderResponse.addDependency(String, String, String, String) are to be referenced in the page's header.
      Returns:
      true if the specified JavaScript resource dependencies are to be referenced in the page's header
    • isPreferencesCompanyWide

      public boolean isPreferencesCompanyWide()
      Returns true if preferences are shared across the entire company.
      Returns:
      true if preferences are shared across the entire company
    • isPreferencesOwnedByGroup

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

      public boolean isPreferencesUniquePerLayout()
      Returns true if preferences are unique per layout.
      Returns:
      true if preferences are unique per layout
    • isPrivateRequestAttributes

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

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

      public boolean isReady()
      Returns true if the portlet is ready to be used.
      Returns:
      true if the portlet is ready to be used
    • isRequiresNamespacedParameters

      public boolean isRequiresNamespacedParameters()
      Returns true if the portlet will only process namespaced parameters.
      Returns:
      true if the portlet will only process namespaced parameters
    • isRestoreCurrentView

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

      public boolean isScopeable()
      Returns true if the portlet supports scoping of data.
      Returns:
      true if the portlet supports scoping of data
    • isShowPortletAccessDenied

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

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

      public boolean isSinglePageApplication()
      Returns true if the portlet uses Single Page Application.
      Returns:
      true if the portlet uses Single Page Application
    • isStatic

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

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

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

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

      public boolean isUndeployedPortlet()
      Returns true if the portlet is an undeployed portlet.
      Returns:
      true if the portlet is a placeholder of an undeployed portlet
    • isUseDefaultTemplate

      public boolean isUseDefaultTemplate()
      Returns true if the portlet uses the default template.
      Returns:
      true if the portlet uses the default template
    • linkRoles

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

      public void setActionTimeout(int actionTimeout)
      Sets the action timeout of the portlet.
      Parameters:
      actionTimeout - the action timeout of the portlet
    • setActionURLRedirect

      public void setActionURLRedirect(boolean actionURLRedirect)
      Set to true if an action URL for this portlet should cause an auto redirect.
      Parameters:
      actionURLRedirect - boolean value for whether an action URL for this portlet should cause an auto redirect
    • setAddDefaultResource

      public void setAddDefaultResource(boolean addDefaultResource)
      Set to true if default resources for the portlet are added to a page.
      Parameters:
      addDefaultResource - boolean value for whether or not default resources for the portlet are added to a page
    • setAjaxable

      public void setAjaxable(boolean ajaxable)
      Set to true if the portlet can be displayed via Ajax.
      Parameters:
      ajaxable - boolean value for whether the portlet can be displayed via Ajax
    • setApplicationTypes

      public void setApplicationTypes(Set<com.liferay.portal.kernel.application.type.ApplicationType> applicationTypes)
      Sets the application types of the portlet.
      Parameters:
      applicationTypes - the application types of the portlet
    • setAssetRendererFactoryClasses

      public void setAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses)
      Sets the names of the classes that represent asset types associated with the portlet.
      Parameters:
      assetRendererFactoryClasses - the names of the classes that represent asset types associated with the portlet
    • setAsyncSupported

      public void setAsyncSupported(boolean asyncSupported)
      Set to true if the portlet supports asynchronous processing in resource requests.
      Parameters:
      asyncSupported - boolean value for whether the portlet supports asynchronous processing in resource requests
    • setAutopropagatedParameters

      public void setAutopropagatedParameters(Set<String> autopropagatedParameters)
      Sets the names of the parameters that will be automatically propagated through the portlet.
      Parameters:
      autopropagatedParameters - the names of the parameters that will be automatically propagated through the portlet
    • setCategoryNames

      public void setCategoryNames(Set<String> categoryNames)
      Sets the category names of the portlet.
      Parameters:
      categoryNames - the category names of the portlet
    • setConfigurationActionClass

      public void setConfigurationActionClass(String configurationActionClass)
      Sets the configuration action class of the portlet.
      Parameters:
      configurationActionClass - the configuration action class of the portlet
    • setControlPanelEntryCategory

      public void setControlPanelEntryCategory(String controlPanelEntryCategory)
      Set the name of the category of the Control Panel where the portlet will be shown.
      Parameters:
      controlPanelEntryCategory - the name of the category of the Control Panel where the portlet will be shown
    • setControlPanelEntryClass

      public void setControlPanelEntryClass(String controlPanelEntryClass)
      Sets the name of the class that will control when the portlet will be shown in the Control Panel.
      Parameters:
      controlPanelEntryClass - the name of the class that will control when the portlet will be shown in the Control Panel
    • setControlPanelEntryWeight

      public void setControlPanelEntryWeight(double controlPanelEntryWeight)
      Sets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.
      Parameters:
      controlPanelEntryWeight - the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel
    • setCssClassWrapper

      public void setCssClassWrapper(String cssClassWrapper)
      Sets the name of the CSS class that will be injected in the DIV that wraps this portlet.
      Parameters:
      cssClassWrapper - the name of the CSS class that will be injected in the DIV that wraps this portlet
    • setCustomAttributesDisplayClasses

      public void setCustomAttributesDisplayClasses(List<String> customAttributesDisplayClasses)
      Sets the names of the classes that represent custom attribute displays associated with the portlet.
      Parameters:
      customAttributesDisplayClasses - the names of the classes that represent custom attribute displays associated with the portlet
    • setDefaultPluginSetting

      public void setDefaultPluginSetting(com.liferay.portal.kernel.model.PluginSetting pluginSetting)
      Sets the default plugin settings of the portlet.
      Parameters:
      pluginSetting - the plugin setting
    • setDefaultPreferences

      public void setDefaultPreferences(String defaultPreferences)
      Sets the default preferences of the portlet.
      Parameters:
      defaultPreferences - the default preferences of the portlet
    • setDisplayName

      public void setDisplayName(String displayName)
      Sets the display name of the portlet.
      Parameters:
      displayName - the display name of the portlet
    • setExpCache

      public void setExpCache(Integer expCache)
      Sets expiration cache of the portlet.
      Parameters:
      expCache - expiration cache of the portlet
    • setFooterPortalCss

      public void setFooterPortalCss(List<String> footerPortalCss)
      Sets a list of CSS files that will be referenced from the page's footer relative to the portal's context path.
      Parameters:
      footerPortalCss - a list of CSS files that will be referenced from the page's footer relative to the portal's context path
    • setFooterPortalJavaScript

      public void setFooterPortalJavaScript(List<String> footerPortalJavaScript)
      Sets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.
      Parameters:
      footerPortalJavaScript - a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path
    • setFooterPortletCss

      public void setFooterPortletCss(List<String> footerPortletCss)
      Sets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.
      Parameters:
      footerPortletCss - a list of CSS files that will be referenced from the page's footer relative to the portlet's context path
    • setFooterPortletJavaScript

      public void setFooterPortletJavaScript(List<String> footerPortletJavaScript)
      Sets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.
      Parameters:
      footerPortletJavaScript - a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path
    • setFriendlyURLMapperClass

      public void setFriendlyURLMapperClass(String friendlyURLMapperClass)
      Sets the name of the friendly URL mapper class of the portlet.
      Parameters:
      friendlyURLMapperClass - the name of the friendly URL mapper class of the portlet
    • setFriendlyURLMapping

      public void setFriendlyURLMapping(String friendlyURLMapping)
      Sets the name of the friendly URL mapping of the portlet.
      Parameters:
      friendlyURLMapping - the name of the friendly URL mapping of the portlet
    • setFriendlyURLRoutes

      public void setFriendlyURLRoutes(String friendlyURLRoutes)
      Sets the class loader resource path to the friendly URL routes of the portlet.
      Parameters:
      friendlyURLRoutes - the class loader resource path to the friendly URL routes of the portlet
    • setHeaderPortalCss

      public void setHeaderPortalCss(List<String> headerPortalCss)
      Sets a list of CSS files that will be referenced from the page's header relative to the portal's context path.
      Parameters:
      headerPortalCss - a list of CSS files that will be referenced from the page's header relative to the portal's context path
    • setHeaderPortalJavaScript

      public void setHeaderPortalJavaScript(List<String> headerPortalJavaScript)
      Sets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.
      Parameters:
      headerPortalJavaScript - a list of JavaScript files that will be referenced from the page's header relative to the portal's context path
    • setHeaderPortletCss

      public void setHeaderPortletCss(List<String> headerPortletCss)
      Sets a list of CSS files that will be referenced from the page's header relative to the portlet's context path.
      Parameters:
      headerPortletCss - a list of CSS files that will be referenced from the page's header relative to the portlet's context path
    • setHeaderPortletJavaScript

      public void setHeaderPortletJavaScript(List<String> headerPortletJavaScript)
      Sets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.
      Parameters:
      headerPortletJavaScript - a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path
    • setHeaderRequestAttributePrefixes

      public void setHeaderRequestAttributePrefixes(List<String> headerRequestAttributePrefixes)
      Sets a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet. Header request attributes that have names starting with any of the prefixes will be copied from the header request to the subsequent render request.
      Parameters:
      headerRequestAttributePrefixes - a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet. Header request attributes that have names starting with any of the prefixes will be copied from the header request to the subsequent render request.
    • setHeaderTimeout

      public void setHeaderTimeout(int headerTimeout)
      Sets the header timeout of the portlet.
      Parameters:
      headerTimeout - the header timeout of the portlet
    • setIcon

      public void setIcon(String icon)
      Sets the icon of the portlet.
      Parameters:
      icon - the icon of the portlet
    • setInclude

      public void setInclude(boolean include)
      Set to true to include the portlet and make it available to be made active.
      Parameters:
      include - boolean value for whether to include the portlet and make it available to be made active
    • setIndexerClasses

      public void setIndexerClasses(List<String> indexerClasses)
      Sets the names of the classes that represent indexers associated with the portlet.
      Parameters:
      indexerClasses - the names of the classes that represent indexers associated with the portlet
    • setInitParams

      public void setInitParams(Map<String,String> initParams)
      Sets the init parameters of the portlet.
      Parameters:
      initParams - the init parameters of the portlet
    • setInstanceable

      public void setInstanceable(boolean instanceable)
      Set to true if the portlet can be added multiple times to a layout.
      Parameters:
      instanceable - boolean value for whether the portlet can be added multiple times to a layout
    • setLayoutCacheable

      public void setLayoutCacheable(boolean layoutCacheable)
      Set to true to allow the portlet to be cached within the layout.
      Parameters:
      layoutCacheable - boolean value for whether the portlet can be cached within the layout
    • setMaximizeEdit

      public void setMaximizeEdit(boolean maximizeEdit)
      Set to true if the portlet goes into the maximized state when the user goes into the edit mode.
      Parameters:
      maximizeEdit - boolean value for whether the portlet goes into the maximized state when the user goes into the edit mode
    • setMaximizeHelp

      public void setMaximizeHelp(boolean maximizeHelp)
      Set to true if the portlet goes into the maximized state when the user goes into the help mode.
      Parameters:
      maximizeHelp - boolean value for whether the portlet goes into the maximized state when the user goes into the help mode
    • setMultipartFileSizeThreshold

      public void setMultipartFileSizeThreshold(int multipartFileSizeThreshold)
      Sets the maximum size of buffered bytes before storing occurs.
      Parameters:
      multipartFileSizeThreshold - the maximum size of buffered bytes before storing occurs
    • setMultipartLocation

      public void setMultipartLocation(String multipartLocation)
      Sets the directory for storing uploaded files.
      Parameters:
      multipartLocation - the directory for storing uploaded files
    • setMultipartMaxFileSize

      public void setMultipartMaxFileSize(long multipartMaxFileSize)
      Sets the maximum number of bytes permitted for an uploaded file.
      Parameters:
      multipartMaxFileSize - the maximum number of bytes permitted for an uploaded file
    • setMultipartMaxRequestSize

      public void setMultipartMaxRequestSize(long multipartMaxRequestSize)
      Sets the maximum number of bytes permitted for a multipart request.
      Parameters:
      multipartMaxRequestSize - the maximum number of bytes permitted for a multipart request
    • setOpenSearchClass

      public void setOpenSearchClass(String openSearchClass)
      Sets the name of the open search class of the portlet.
      Parameters:
      openSearchClass - the name of the open search class of the portlet
    • setParentStrutsPath

      public void setParentStrutsPath(String parentStrutsPath)
      Sets the parent struts path of the portlet.
      Parameters:
      parentStrutsPath - the parent struts path of the portlet
    • setPartialActionServeResource

      public void setPartialActionServeResource(boolean partialActionServeResource)
      Sets whether the portlet's serve resource should be invoked during a partial action triggered by a different portlet on the same portal page.
      Parameters:
      partialActionServeResource - whether the portlet's serveResource(ResourceRequest,ResourceResponse) method should be invoked during a partial action triggered by a different portlet on the same portal page
    • setPermissionPropagatorClass

      public void setPermissionPropagatorClass(String permissionPropagatorClass)
      Sets the name of the permission propagator class of the portlet.
    • setPluginPackage

      public void setPluginPackage(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
      Sets this portlet's plugin package.
      Parameters:
      pluginPackage - this portlet's plugin package
    • setPopMessageListenerClass

      public void setPopMessageListenerClass(String popMessageListenerClass)
      Sets the name of the POP message listener class of the portlet.
      Parameters:
      popMessageListenerClass - the name of the POP message listener class of the portlet
    • setPopUpPrint

      public void setPopUpPrint(boolean popUpPrint)
      Sets whether the portlet goes into the pop up state when the user goes into the print mode.
      Parameters:
      popUpPrint - whether the portlet goes into the pop up state when the user goes into the print mode
    • setPortletApp

      public void setPortletApp(com.liferay.portal.kernel.model.PortletApp portletApp)
      Sets this portlet's application.
      Parameters:
      portletApp - this portlet's application
    • setPortletClass

      public void setPortletClass(String portletClass)
      Sets the name of the portlet class of the portlet.
      Parameters:
      portletClass - the name of the portlet class of the portlet
    • setPortletConfigurationListenerClass

      public void setPortletConfigurationListenerClass(String portletConfigurationListenerClass)
    • setPortletDataHandlerClass

      public void setPortletDataHandlerClass(String portletDataHandlerClass)
      Sets the name of the portlet data handler class of the portlet.
      Parameters:
      portletDataHandlerClass - the name of portlet data handler class of the portlet
    • setPortletDependencyCssEnabled

      public void setPortletDependencyCssEnabled(boolean portletDependencyCssEnabled)
      Sets whether the CSS resource dependencies specified in portlet.xml, @Dependency, HeaderResponse.addDependency(String, String, String), or HeaderResponse.addDependency(String, String, String, String) are to be referenced in the page's header.
      Parameters:
      portletDependencyCssEnabled - whether the CSS resource dependencies that are specified in portlet.xml,
    • setPortletDependencyJavaScriptEnabled

      public void setPortletDependencyJavaScriptEnabled(boolean portletDependencyJavaScriptEnabled)
      Sets whether the JavaScript resource dependencies specified in portlet.xml, @Dependency, HeaderResponse.addDependency(String, String, String), or HeaderResponse.addDependency(String, String, String, String) are to be referenced in the page's header.
      Parameters:
      portletDependencyJavaScriptEnabled - whether the JavaScript resource dependencies specified in portlet.xml, @Dependency, HeaderResponse.addDependency(String, String, String), or HeaderResponse.addDependency(String, String, String, String) are to be referenced in the page's header
    • setPortletFilters

      public void setPortletFilters(Map<String,com.liferay.portal.kernel.model.PortletFilter> portletFilters)
      Sets the filters of the portlet.
      Parameters:
      portletFilters - the filters of the portlet
    • setPortletId

      public void setPortletId(String portletId)
      Specified by:
      setPortletId in interface com.liferay.portal.kernel.model.PortletModel
      Overrides:
      setPortletId in class PortletModelImpl
    • setPortletInfo

      public void setPortletInfo(com.liferay.portal.kernel.model.PortletInfo portletInfo)
      Sets the portlet info of the portlet.
      Parameters:
      portletInfo - the portlet info of the portlet
    • setPortletLayoutListenerClass

      public void setPortletLayoutListenerClass(String portletLayoutListenerClass)
      Sets the name of the portlet layout listener class of the portlet.
      Parameters:
      portletLayoutListenerClass - the name of the portlet layout listener class of the portlet
    • setPortletModes

      public void setPortletModes(Map<String,Set<String>> portletModes)
      Sets the portlet modes of the portlet.
      Parameters:
      portletModes - the portlet modes of the portlet
    • setPortletName

      public void setPortletName(String portletName)
      Sets the name of the portlet.
      Parameters:
      portletName - the name of the portlet
    • setPortletURLClass

      public void setPortletURLClass(String portletURLClass)
      Sets the name of the portlet URL class of the portlet.
      Parameters:
      portletURLClass - the name of the portlet URL class of the portlet
    • setPreferencesCompanyWide

      public void setPreferencesCompanyWide(boolean preferencesCompanyWide)
      Set to true if preferences are shared across the entire company.
      Parameters:
      preferencesCompanyWide - boolean value for whether preferences are shared across the entire company
    • setPreferencesOwnedByGroup

      public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
      Set to true if preferences are owned by the group when the portlet is shown in a group layout. Set to false if preferences are owned by the user at all times.
      Parameters:
      preferencesOwnedByGroup - boolean value for whether preferences are owned by the group when the portlet is shown in a group layout or preferences are owned by the user at all times
    • setPreferencesUniquePerLayout

      public void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
      Set to true if preferences are unique per layout.
      Parameters:
      preferencesUniquePerLayout - boolean value for whether preferences are unique per layout
    • setPreferencesValidator

      public void setPreferencesValidator(String preferencesValidator)
      Sets the name of the preferences validator class of the portlet.
      Parameters:
      preferencesValidator - the name of the preferences validator class of the portlet
    • setPrivateRequestAttributes

      public void setPrivateRequestAttributes(boolean privateRequestAttributes)
      Set to true if the portlet does not share request attributes with the portal or portlets from another WAR.
      Parameters:
      privateRequestAttributes - boolean value for whether the portlet shares request attributes with the portal or portlets from another WAR
    • setPrivateSessionAttributes

      public void setPrivateSessionAttributes(boolean privateSessionAttributes)
      Set to true if the portlet does not share session attributes with the portal.
      Parameters:
      privateSessionAttributes - boolean value for whether the portlet shares session attributes with the portal
    • setProcessingEvents

      public void setProcessingEvents(Set<com.liferay.portal.kernel.xml.QName> processingEvents)
      Sets the processing events of the portlet.
      Parameters:
      processingEvents - the processing events of the portlet
    • setPublicRenderParameters

      public void setPublicRenderParameters(Set<com.liferay.portal.kernel.model.PublicRenderParameter> publicRenderParameters)
      Sets the public render parameters of the portlet.
      Parameters:
      publicRenderParameters - the public render parameters of the portlet
    • setPublishingEvents

      public void setPublishingEvents(Set<com.liferay.portal.kernel.xml.QName> publishingEvents)
      Sets the publishing events of the portlet.
      Parameters:
      publishingEvents - the publishing events of the portlet
    • setReady

      public void setReady(boolean ready)
      Set to true if the portlet is ready to be used.
      Parameters:
      ready - whether the portlet is ready to be used
    • setRenderTimeout

      public void setRenderTimeout(int renderTimeout)
      Sets the render timeout of the portlet.
      Parameters:
      renderTimeout - the render timeout of the portlet
    • setRenderWeight

      public void setRenderWeight(int renderWeight)
      Sets the render weight of the portlet.
      Parameters:
      renderWeight - int value for the render weight of the portlet
    • setRequiresNamespacedParameters

      public void setRequiresNamespacedParameters(boolean requiresNamespacedParameters)
      Set to true if the portlet will only process namespaced parameters.
      Parameters:
      requiresNamespacedParameters - boolean value for whether the portlet will only process namespaced parameters
    • setResourceBundle

      public void setResourceBundle(String resourceBundle)
      Sets the resource bundle of the portlet.
      Parameters:
      resourceBundle - the resource bundle of the portlet
    • setRestoreCurrentView

      public void setRestoreCurrentView(boolean restoreCurrentView)
      Set to true if the portlet restores to the current view from the maximized state.
      Parameters:
      restoreCurrentView - boolean value for whether the portlet restores to the current view from the maximized state
    • setRoleMappers

      public void setRoleMappers(Map<String,String> roleMappers)
      Sets the role mappers of the portlet.
      Parameters:
      roleMappers - the role mappers of the portlet
    • setRoles

      public void setRoles(String roles)
      Sets a string of ordered comma delimited portlet IDs.
      Specified by:
      setRoles in interface com.liferay.portal.kernel.model.PortletModel
      Overrides:
      setRoles in class PortletModelImpl
      Parameters:
      roles - a string of ordered comma delimited portlet IDs
    • setRolesArray

      public void setRolesArray(String[] rolesArray)
      Sets an array of required roles of the portlet.
      Parameters:
      rolesArray - an array of required roles of the portlet
    • setSchedulerEntries

      public void setSchedulerEntries(List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries)
      Sets the scheduler entries of the portlet.
      Parameters:
      schedulerEntries - the scheduler entries of the portlet
    • setScopeable

      public void setScopeable(boolean scopeable)
      Set to true if the portlet supports scoping of data.
      Parameters:
      scopeable - boolean value for whether or not the the portlet supports scoping of data
    • setShowPortletAccessDenied

      public void setShowPortletAccessDenied(boolean showPortletAccessDenied)
      Set to true if users are shown that they do not have access to the portlet.
      Parameters:
      showPortletAccessDenied - boolean value for whether users are shown that they do not have access to the portlet
    • setShowPortletInactive

      public void setShowPortletInactive(boolean showPortletInactive)
      Set to true if users are shown that the portlet is inactive.
      Parameters:
      showPortletInactive - boolean value for whether users are shown that the portlet is inactive
    • setSinglePageApplication

      public void setSinglePageApplication(boolean singlePageApplication)
      Set to true if the portlet uses Single Page Application.
      Parameters:
      singlePageApplication - boolean value for whether or not the the portlet uses Single Page Application
    • setSocialActivityInterpreterClasses

      public void setSocialActivityInterpreterClasses(List<String> socialActivityInterpreterClasses)
      Sets the names of the classes that represent social activity interpreters associated with the portlet.
      Parameters:
      socialActivityInterpreterClasses - the names of the classes that represent social activity interpreters associated with the portlet
    • setSocialRequestInterpreterClass

      public void setSocialRequestInterpreterClass(String socialRequestInterpreterClass)
      Sets the name of the social request interpreter class of the portlet.
      Parameters:
      socialRequestInterpreterClass - the name of the request interpreter class of the portlet
    • setStagedModelDataHandlerClasses

      public void setStagedModelDataHandlerClasses(List<String> stagedModelDataHandlerClasses)
      Sets the names of the classes that represent staged model data handlers associated with the portlet.
      Parameters:
      stagedModelDataHandlerClasses - the names of the classes that represent staged model data handlers associated with the portlet
    • setStatic

      public void setStatic(boolean staticPortlet)
      Set to true if the portlet is a static portlet that is cannot be moved.
      Parameters:
      staticPortlet - boolean value for whether the portlet is a static portlet that cannot be moved
    • setStaticStart

      public void setStaticStart(boolean staticPortletStart)
      Set to true if the portlet is a static portlet at the start of a list of portlets.
      Parameters:
      staticPortletStart - boolean value for whether the portlet is a static portlet at the start of a list of portlets
    • setStrutsPath

      public void setStrutsPath(String strutsPath)
      Sets the struts path of the portlet.
      Parameters:
      strutsPath - the struts path of the portlet
    • setSupportedLocales

      public void setSupportedLocales(Set<String> supportedLocales)
      Sets the supported locales of the portlet.
      Parameters:
      supportedLocales - the supported locales of the portlet
    • setSystem

      public void setSystem(boolean system)
      Set to true if the portlet is a system portlet that a user cannot manually add to their page.
      Parameters:
      system - boolean value for whether the portlet is a system portlet that a user cannot manually add to their page
    • setTemplateHandlerClass

      public void setTemplateHandlerClass(String templateHandlerClass)
      Sets the name of the template handler class of the portlet.
      Parameters:
      templateHandlerClass - the name of template handler class of the portlet
    • setTrashHandlerClasses

      public void setTrashHandlerClasses(List<String> trashHandlerClasses)
      Sets the names of the classes that represent trash handlers associated to the portlet.
      Parameters:
      trashHandlerClasses - the names of the classes that represent trash handlers associated with the portlet
    • setUndeployedPortlet

      public void setUndeployedPortlet(boolean undeployedPortlet)
      Set to true if the portlet is an undeployed portlet.
      Parameters:
      undeployedPortlet - boolean value for whether the portlet is an undeployed portlet
    • setUnlinkedRoles

      public void setUnlinkedRoles(Set<String> unlinkedRoles)
      Sets the unlinked roles of the portlet.
      Parameters:
      unlinkedRoles - the unlinked roles of the portlet
    • setURLEncoderClass

      public void setURLEncoderClass(String urlEncoderClass)
      Sets the name of the URL encoder class of the portlet.
      Parameters:
      urlEncoderClass - the name of the URL encoder class of the portlet
    • setUseDefaultTemplate

      public void setUseDefaultTemplate(boolean useDefaultTemplate)
      Set to true if the portlet uses the default template.
      Parameters:
      useDefaultTemplate - boolean value for whether the portlet uses the default template
    • setUserNotificationDefinitions

      public void setUserNotificationDefinitions(String userNotificationDefinitions)
      Sets the class loader resource path to the user notification definitions of the portlet.
      Parameters:
      userNotificationDefinitions - the class loader resource path to the user notification definitions of the portlet
    • setUserNotificationHandlerClasses

      public void setUserNotificationHandlerClasses(List<String> userNotificationHandlerClasses)
      Sets the names of the classes that represent user notification handlers associated with the portlet.
      Parameters:
      userNotificationHandlerClasses - the names of the classes that represent user notification handlers associated with the portlet
    • setUserPrincipalStrategy

      public void setUserPrincipalStrategy(String userPrincipalStrategy)
      Sets the user principal strategy of the portlet.
      Parameters:
      userPrincipalStrategy - the user principal strategy of the portlet
    • setVirtualPath

      public void setVirtualPath(String virtualPath)
      Sets the virtual path of the portlet.
      Parameters:
      virtualPath - the virtual path of the portlet
    • setWebDAVStorageClass

      public void setWebDAVStorageClass(String webDAVStorageClass)
      Sets the name of the WebDAV storage class of the portlet.
      Parameters:
      webDAVStorageClass - the name of the WebDAV storage class of the portlet
    • setWebDAVStorageToken

      public void setWebDAVStorageToken(String webDAVStorageToken)
      Sets the name of the WebDAV storage token of the portlet.
      Parameters:
      webDAVStorageToken - the name of the WebDAV storage token of the portlet
    • setWindowStates

      public void setWindowStates(Map<String,Set<String>> windowStates)
      Sets the window states of the portlet.
      Parameters:
      windowStates - the window states of the portlet
    • setWorkflowHandlerClasses

      public void setWorkflowHandlerClasses(List<String> workflowHandlerClasses)
      Sets the names of the classes that represent workflow handlers associated to the portlet.
      Parameters:
      workflowHandlerClasses - the names of the classes that represent workflow handlers associated with the portlet
    • setXmlRpcMethodClass

      public void setXmlRpcMethodClass(String xmlRpcMethodClass)
      Sets the name of the XML-RPC method class of the portlet.
      Parameters:
      xmlRpcMethodClass - the name of the XML-RPC method class of the portlet
    • unsetReady

      public void unsetReady()