Class PortletWrapper

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

public class PortletWrapper extends BaseModelWrapper<Portlet> implements ModelWrapper<Portlet>, Portlet

This class is a wrapper for Portlet.

Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • PortletWrapper

      public PortletWrapper(Portlet portlet)
  • Method Details

    • getModelAttributes

      public Map<String,Object> getModelAttributes()
      Specified by:
      getModelAttributes in interface BaseModel<Portlet>
    • setModelAttributes

      public void setModelAttributes(Map<String,Object> attributes)
      Specified by:
      setModelAttributes in interface BaseModel<Portlet>
    • addApplicationType

      public void addApplicationType(ApplicationType applicationType)
      Adds an application type.
      Specified by:
      addApplicationType in interface Portlet
      Parameters:
      applicationType - an application type
    • addPortletDependency

      public void addPortletDependency(PortletDependency portletDependency)
      Adds a portlet CSS/JavaScript resource dependency.
      Specified by:
      addPortletDependency in interface Portlet
      Parameters:
      portletDependency - the portlet CSS/JavaScript resource dependency
    • addProcessingEvent

      public void addProcessingEvent(QName processingEvent)
      Adds a processing event.
      Specified by:
      addProcessingEvent in interface Portlet
    • addPublicRenderParameter

      public void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
      Adds a public render parameter.
      Specified by:
      addPublicRenderParameter in interface Portlet
      Parameters:
      publicRenderParameter - a public render parameter
    • addPublishingEvent

      public void addPublishingEvent(QName publishingEvent)
      Adds a publishing event.
      Specified by:
      addPublishingEvent in interface Portlet
    • addSchedulerEntry

      public void addSchedulerEntry(SchedulerEntry schedulerEntry)
      Adds a scheduler entry.
      Specified by:
      addSchedulerEntry in interface Portlet
    • clone

      public Object clone()
      Creates and returns a copy of this object.
      Specified by:
      clone in interface BaseModel<Portlet>
      Specified by:
      clone in interface Portlet
      Overrides:
      clone in class BaseModelWrapper<Portlet>
      Returns:
      a copy of this object
    • cloneWithOriginalValues

      public Portlet cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface BaseModel<Portlet>
      Specified by:
      cloneWithOriginalValues in interface PortletModel
    • compareTo

      public int compareTo(Portlet portlet)
      Compares this portlet to the specified object.
      Specified by:
      compareTo in interface Comparable<Portlet>
      Specified by:
      compareTo in interface Portlet
      Overrides:
      compareTo in class BaseModelWrapper<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
    • equals

      public boolean equals(Object object)
      Checks whether this portlet is equal to the specified object.
      Specified by:
      equals in interface Portlet
      Overrides:
      equals in class BaseModelWrapper<Portlet>
      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.
      Specified by:
      getActionTimeout in interface 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.
      Specified by:
      getActionURLRedirect in interface Portlet
      Returns:
      true if an action URL for this portlet should cause an auto redirect
    • getActive

      public boolean getActive()
      Returns the active of this portlet.
      Specified by:
      getActive in interface PortletModel
      Returns:
      the active of this portlet
    • getAddDefaultResource

      public boolean getAddDefaultResource()
      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
    • getAjaxable

      public boolean getAjaxable()
      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
    • getAllPortletModes

      public Set<String> getAllPortletModes()
      Returns the portlet modes of the portlet.
      Specified by:
      getAllPortletModes in interface Portlet
      Returns:
      the portlet modes of the portlet
    • getAllWindowStates

      public Set<String> getAllWindowStates()
      Returns the window states of the portlet.
      Specified by:
      getAllWindowStates in interface Portlet
      Returns:
      the window states of the portlet
    • getApplicationTypes

      public Set<ApplicationType> getApplicationTypes()
      Returns the application types of the portlet.
      Specified by:
      getApplicationTypes in interface 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.
      Specified by:
      getAssetRendererFactoryClasses in interface 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.
      Specified by:
      getAutopropagatedParameters in interface 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.
      Specified by:
      getCategoryNames in interface Portlet
      Returns:
      the category names of the portlet
    • getClonedInstance

      public Portlet getClonedInstance(String portletId)
      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
    • getCompanyId

      public long getCompanyId()
      Returns the company ID of this portlet.
      Specified by:
      getCompanyId in interface PortletModel
      Specified by:
      getCompanyId in interface ShardedModel
      Returns:
      the company ID of this portlet
    • getConfigurationActionClass

      public String getConfigurationActionClass()
      Returns the configuration action class of the portlet.
      Specified by:
      getConfigurationActionClass in interface Portlet
      Returns:
      the configuration action class of the portlet
    • getConfigurationActionInstance

      public ConfigurationAction getConfigurationActionInstance()
      Returns the configuration action instance of the portlet.
      Specified by:
      getConfigurationActionInstance in interface Portlet
      Returns:
      the configuration action instance of the portlet
    • getContextName

      public String getContextName()
      Returns the servlet context name of the portlet.
      Specified by:
      getContextName in interface Portlet
      Returns:
      the servlet context name of the portlet
    • getContextPath

      public String getContextPath()
      Returns the servlet context path of the portlet.
      Specified by:
      getContextPath in interface 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.
      Specified by:
      getControlPanelEntryCategory in interface Portlet
      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.
      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
    • getControlPanelEntryInstance

      public ControlPanelEntry getControlPanelEntryInstance()
      Returns 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
    • 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.
      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
    • getCssClassWrapper

      public String getCssClassWrapper()
      Returns 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
    • getCustomAttributesDisplayClasses

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

      public List<CustomAttributesDisplay> getCustomAttributesDisplayInstances()
      Returns the custom attribute display instances of the portlet.
      Specified by:
      getCustomAttributesDisplayInstances in interface Portlet
      Returns:
      the custom attribute display instances of the portlet
    • getDefaultPluginSetting

      public PluginSetting getDefaultPluginSetting()
      Get the default plugin settings of the portlet.
      Specified by:
      getDefaultPluginSetting in interface Portlet
      Returns:
      the plugin settings
    • getDefaultPreferences

      public String getDefaultPreferences()
      Returns the default preferences of the portlet.
      Specified by:
      getDefaultPreferences in interface Portlet
      Returns:
      the default preferences of the portlet
    • getDisplayName

      public String getDisplayName()
      Returns the display name of the portlet.
      Specified by:
      getDisplayName in interface Portlet
      Returns:
      the display name of the portlet
    • getExpCache

      public Integer getExpCache()
      Returns expiration cache of the portlet.
      Specified by:
      getExpCache in interface 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.
      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
    • 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.
      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
    • 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.
      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
    • 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.
      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
    • getFriendlyURLMapperClass

      public String getFriendlyURLMapperClass()
      Returns 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
    • getFriendlyURLMapperInstance

      public FriendlyURLMapper getFriendlyURLMapperInstance()
      Returns the friendly URL mapper instance of the portlet.
      Specified by:
      getFriendlyURLMapperInstance in interface 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.
      Specified by:
      getFriendlyURLMapping in interface Portlet
      Returns:
      the name of the friendly URL mapping of the portlet
    • getFriendlyURLMapping

      public String getFriendlyURLMapping(boolean lookUpFriendlyURLMapper)
      Specified by:
      getFriendlyURLMapping in interface Portlet
    • getFriendlyURLRoutes

      public String getFriendlyURLRoutes()
      Returns the class loader resource path to the friendly URL routes of the portlet.
      Specified by:
      getFriendlyURLRoutes in interface 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.
      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
    • 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.
      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
    • 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.
      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
    • 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.
      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
    • 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.
      Specified by:
      getHeaderRequestAttributePrefixes in interface Portlet
      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.
      Specified by:
      getHeaderTimeout in interface Portlet
      Returns:
      the header timeout of the portlet
    • getIcon

      public String getIcon()
      Returns the icon of the portlet.
      Specified by:
      getIcon in interface Portlet
      Returns:
      the icon of the portlet
    • getId

      public long getId()
      Returns the ID of this portlet.
      Specified by:
      getId in interface PortletModel
      Returns:
      the ID of this portlet
    • getInclude

      public boolean getInclude()
      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
    • getIndexerClasses

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

      public List<Indexer<?>> getIndexerInstances()
      Returns the indexer instances of the portlet.
      Specified by:
      getIndexerInstances in interface Portlet
      Returns:
      the indexer instances of the portlet
    • getInitParams

      public Map<String,String> getInitParams()
      Returns the init parameters of the portlet.
      Specified by:
      getInitParams in interface Portlet
      Returns:
      init parameters of the portlet
    • getInstanceable

      public boolean getInstanceable()
      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
    • getInstanceId

      public String getInstanceId()
      Returns the instance ID of the portlet.
      Specified by:
      getInstanceId in interface Portlet
      Returns:
      the instance ID of the portlet
    • getLayoutCacheable

      public boolean getLayoutCacheable()
      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
    • getMaximizeEdit

      public boolean getMaximizeEdit()
      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
    • getMaximizeHelp

      public boolean getMaximizeHelp()
      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
    • getMultipartFileSizeThreshold

      public int getMultipartFileSizeThreshold()
      Returns the maximum size of buffered bytes before storing occurs.
      Specified by:
      getMultipartFileSizeThreshold in interface Portlet
      Returns:
      the maximum size of buffered bytes before storing occurs
    • getMultipartLocation

      public String getMultipartLocation()
      Returns the directory for storing uploaded files.
      Specified by:
      getMultipartLocation in interface Portlet
      Returns:
      the directory for storing uploaded files
    • getMultipartMaxFileSize

      public long getMultipartMaxFileSize()
      Returns the maximum number of bytes permitted for an uploaded file.
      Specified by:
      getMultipartMaxFileSize in interface Portlet
      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.
      Specified by:
      getMultipartMaxRequestSize in interface Portlet
      Returns:
      the maximum number of bytes permitted for a multipart request
    • getMvccVersion

      public long getMvccVersion()
      Returns the mvcc version of this portlet.
      Specified by:
      getMvccVersion in interface MVCCModel
      Specified by:
      getMvccVersion in interface PortletModel
      Returns:
      the mvcc version of this portlet
    • getOpenSearchClass

      public String getOpenSearchClass()
      Returns 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
    • getOpenSearchInstance

      public OpenSearch getOpenSearchInstance()
      Returns the indexer instance of the portlet.
      Specified by:
      getOpenSearchInstance in interface Portlet
      Returns:
      the indexer instance of the portlet
    • getParentStrutsPath

      public String getParentStrutsPath()
      Returns the parent struts path of the portlet.
      Specified by:
      getParentStrutsPath in interface Portlet
      Returns:
      the parent struts path of the portlet.
    • getPermissionPropagatorClass

      public String getPermissionPropagatorClass()
      Returns the name of the permission propagator class of the portlet.
      Specified by:
      getPermissionPropagatorClass in interface Portlet
      Returns:
      the name of the permission propagator class of the portlet
    • getPermissionPropagatorInstance

      public PermissionPropagator getPermissionPropagatorInstance()
      Returns the permission propagator instance of the portlet.
      Specified by:
      getPermissionPropagatorInstance in interface Portlet
      Returns:
      the permission propagator instance of the portlet
    • getPluginId

      public String getPluginId()
      Returns the plugin ID of the portlet.
      Specified by:
      getPluginId in interface Portlet
      Returns:
      the plugin ID of the portlet
    • getPluginPackage

      public PluginPackage getPluginPackage()
      Returns this portlet's plugin package.
      Specified by:
      getPluginPackage in interface Portlet
      Returns:
      this portlet's plugin package
    • getPluginType

      public String getPluginType()
      Returns the plugin type of the portlet.
      Specified by:
      getPluginType in interface Portlet
      Returns:
      the plugin type of the portlet
    • getPopMessageListenerClass

      public String getPopMessageListenerClass()
      Returns 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
    • getPopMessageListenerInstance

      public MessageListener getPopMessageListenerInstance()
      Returns the POP message listener instance of the portlet.
      Specified by:
      getPopMessageListenerInstance in interface 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.
      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
    • getPortletApp

      public PortletApp getPortletApp()
      Returns this portlet's application.
      Specified by:
      getPortletApp in interface Portlet
      Returns:
      this portlet's application
    • getPortletClass

      public String getPortletClass()
      Returns 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
    • getPortletConfigurationListenerClass

      public String getPortletConfigurationListenerClass()
      Specified by:
      getPortletConfigurationListenerClass in interface Portlet
    • getPortletConfigurationListenerInstance

      public PortletConfigurationListener getPortletConfigurationListenerInstance()
      Specified by:
      getPortletConfigurationListenerInstance in interface Portlet
    • getPortletDataHandlerClass

      public String getPortletDataHandlerClass()
      Returns 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
    • getPortletDataHandlerInstance

      public PortletDataHandler getPortletDataHandlerInstance()
      Returns the portlet data handler instance of the portlet.
      Specified by:
      getPortletDataHandlerInstance in interface Portlet
      Returns:
      the portlet data handler instance of the portlet
    • getPortletDependencies

      public List<PortletDependency> getPortletDependencies()
      Returns the portlet's CSS/JavaScript resource dependencies.
      Specified by:
      getPortletDependencies in interface Portlet
      Returns:
      the portlet's CSS/JavaScript resource dependencies
    • getPortletFilters

      public Map<String,PortletFilter> getPortletFilters()
      Returns the filters of the portlet.
      Specified by:
      getPortletFilters in interface Portlet
      Returns:
      filters of the portlet
    • getPortletId

      public String getPortletId()
      Returns the portlet ID of this portlet.
      Specified by:
      getPortletId in interface PortletModel
      Returns:
      the portlet ID of this portlet
    • getPortletInfo

      public PortletInfo getPortletInfo()
      Returns the portlet info of the portlet.
      Specified by:
      getPortletInfo in interface Portlet
      Returns:
      portlet info of the portlet
    • getPortletLayoutListenerClass

      public String getPortletLayoutListenerClass()
      Returns 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
    • getPortletLayoutListenerInstance

      public PortletLayoutListener getPortletLayoutListenerInstance()
      Returns the portlet layout listener instance of the portlet.
      Specified by:
      getPortletLayoutListenerInstance in interface Portlet
      Returns:
      the portlet layout listener instance of the portlet
    • getPortletModes

      public Map<String,Set<String>> getPortletModes()
      Returns the portlet modes of the portlet.
      Specified by:
      getPortletModes in interface Portlet
      Returns:
      portlet modes of the portlet
    • getPortletName

      public String getPortletName()
      Returns the name of the portlet.
      Specified by:
      getPortletName in interface Portlet
      Returns:
      the display name of the portlet
    • getPortletURLClass

      public String getPortletURLClass()
      Returns 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
    • getPreferencesCompanyWide

      public boolean getPreferencesCompanyWide()
      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
    • 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.
      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.
    • getPreferencesUniquePerLayout

      public boolean getPreferencesUniquePerLayout()
      Returns true if preferences are unique per layout.
      Specified by:
      getPreferencesUniquePerLayout in interface Portlet
      Returns:
      true if preferences are unique per layout
    • getPreferencesValidator

      public String getPreferencesValidator()
      Returns 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
    • getPrimaryKey

      public long getPrimaryKey()
      Returns the primary key of this portlet.
      Specified by:
      getPrimaryKey in interface PortletModel
      Returns:
      the primary key of this portlet
    • getPrivateRequestAttributes

      public boolean getPrivateRequestAttributes()
      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
    • getPrivateSessionAttributes

      public boolean getPrivateSessionAttributes()
      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
    • getProcessingEvent

      public QName getProcessingEvent(String uri, String localPart)
      Returns the processing event from a namespace URI and a local part.
      Specified by:
      getProcessingEvent in interface Portlet
      Parameters:
      uri - the namespace URI
      localPart - the local part
      Returns:
      the processing event from a namespace URI and a local part
    • getProcessingEvents

      public Set<QName> getProcessingEvents()
      Returns the processing events of the portlet.
      Specified by:
      getProcessingEvents in interface Portlet
      Returns:
      the processing events of the portlet
    • getPublicRenderParameter

      public PublicRenderParameter getPublicRenderParameter(String identifier)
      Returns the public render parameter from an identifier.
      Specified by:
      getPublicRenderParameter in interface Portlet
      Parameters:
      identifier - the identifier
      Returns:
      the public render parameter from an identifier
    • getPublicRenderParameter

      public PublicRenderParameter getPublicRenderParameter(String uri, String localPart)
      Returns the spublic render parameter from a namespace URI and a local part.
      Specified by:
      getPublicRenderParameter in interface Portlet
      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<PublicRenderParameter> getPublicRenderParameters()
      Returns the public render parameters of the portlet.
      Specified by:
      getPublicRenderParameters in interface Portlet
      Returns:
      the public render parameters of the portlet
    • getPublishingEvents

      public Set<QName> getPublishingEvents()
      Returns the publishing events of the portlet.
      Specified by:
      getPublishingEvents in interface Portlet
      Returns:
      the publishing events of the portlet
    • getReady

      public boolean getReady()
      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
    • getRenderTimeout

      public int getRenderTimeout()
      Returns the render timeout of the portlet.
      Specified by:
      getRenderTimeout in interface Portlet
      Returns:
      the render timeout of the portlet
    • getRenderWeight

      public int getRenderWeight()
      Returns the render weight of the portlet.
      Specified by:
      getRenderWeight in interface Portlet
      Returns:
      the render weight of the portlet
    • getResourceBundle

      public String getResourceBundle()
      Returns the resource bundle of the portlet.
      Specified by:
      getResourceBundle in interface 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.
      Specified by:
      getRestoreCurrentView in interface Portlet
      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.
      Specified by:
      getRoleMappers in interface Portlet
      Returns:
      role mappers of the portlet
    • getRoles

      public String getRoles()
      Returns the roles of this portlet.
      Specified by:
      getRoles in interface PortletModel
      Returns:
      the roles of this portlet
    • getRolesArray

      public String[] getRolesArray()
      Returns an array of required roles of the portlet.
      Specified by:
      getRolesArray in interface Portlet
      Returns:
      an array of required roles of the portlet
    • getRootPortlet

      public Portlet getRootPortlet()
      Returns the root portlet of this portlet instance.
      Specified by:
      getRootPortlet in interface Portlet
      Returns:
      the root portlet of this portlet instance
    • getRootPortletId

      public String getRootPortletId()
      Returns the root portlet ID of the portlet.
      Specified by:
      getRootPortletId in interface Portlet
      Returns:
      the root portlet ID of the portlet
    • getSchedulerEntries

      public List<SchedulerEntry> getSchedulerEntries()
      Returns the scheduler entries of the portlet.
      Specified by:
      getSchedulerEntries in interface Portlet
      Returns:
      the scheduler entries of the portlet
    • getScopeable

      public boolean getScopeable()
      Returns true if the portlet supports scoping of data.
      Specified by:
      getScopeable in interface Portlet
      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.
      Specified by:
      getShowPortletAccessDenied in interface 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.
      Specified by:
      getShowPortletInactive in interface Portlet
      Returns:
      true if users are shown that the portlet is inactive
    • getSinglePageApplication

      public boolean getSinglePageApplication()
      Returns true if the portlet uses Single Page Application.
      Specified by:
      getSinglePageApplication in interface Portlet
      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.
      Specified by:
      getSocialActivityInterpreterClasses in interface Portlet
      Returns:
      the names of the classes that represent social activity interpreters associated with the portlet
    • getSocialActivityInterpreterInstances

      public List<SocialActivityInterpreter> getSocialActivityInterpreterInstances()
      Returns the social activity interpreter instances of the portlet.
      Specified by:
      getSocialActivityInterpreterInstances in interface 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.
      Specified by:
      getSocialRequestInterpreterClass in interface Portlet
      Returns:
      the name of the social request interpreter class of the portlet
    • getSocialRequestInterpreterInstance

      public SocialRequestInterpreter getSocialRequestInterpreterInstance()
      Returns 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
    • getStagedModelDataHandlerClasses

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

      public List<StagedModelDataHandler<?>> getStagedModelDataHandlerInstances()
      Returns the staged model data handler instances of the portlet.
      Specified by:
      getStagedModelDataHandlerInstances in interface 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.
      Specified by:
      getStatic in interface Portlet
      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.
      Specified by:
      getStaticEnd in interface Portlet
      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.
      Specified by:
      getStaticResourcePath in interface 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.
      Specified by:
      getStaticStart in interface Portlet
      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.
      Specified by:
      getStrutsPath in interface Portlet
      Returns:
      the struts path of the portlet
    • getSupportedLocales

      public Set<String> getSupportedLocales()
      Returns the supported locales of the portlet.
      Specified by:
      getSupportedLocales in interface 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.
      Specified by:
      getSystem in interface Portlet
      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.
      Specified by:
      getTemplateHandlerClass in interface Portlet
      Returns:
      the name of the template handler class of the portlet
    • getTemplateHandlerInstance

      public TemplateHandler getTemplateHandlerInstance()
      Returns the template handler instance of the portlet.
      Specified by:
      getTemplateHandlerInstance in interface Portlet
      Returns:
      the template handler instance of the portlet
    • getTimestamp

      public long getTimestamp()
      Returns the timestamp of the portlet.
      Specified by:
      getTimestamp in interface 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.
      Specified by:
      getTrashHandlerClasses in interface Portlet
      Returns:
      the names of the classes that represent trash handlers associated with the portlet
    • getTrashHandlerInstances

      public List<TrashHandler> getTrashHandlerInstances()
      Returns the trash handler instances of the portlet.
      Specified by:
      getTrashHandlerInstances in interface Portlet
      Returns:
      the trash handler instances of the portlet
    • getUndeployedPortlet

      public boolean getUndeployedPortlet()
      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
    • getUnlinkedRoles

      public Set<String> getUnlinkedRoles()
      Returns the unlinked roles of the portlet.
      Specified by:
      getUnlinkedRoles in interface Portlet
      Returns:
      unlinked roles of the portlet
    • getURLEncoderClass

      public String getURLEncoderClass()
      Returns 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
    • getURLEncoderInstance

      public URLEncoder getURLEncoderInstance()
      Returns the URL encoder instance of the portlet.
      Specified by:
      getURLEncoderInstance in interface Portlet
      Returns:
      the URL encoder instance of the portlet
    • getUseDefaultTemplate

      public boolean getUseDefaultTemplate()
      Returns true if the portlet uses the default template.
      Specified by:
      getUseDefaultTemplate in interface Portlet
      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.
      Specified by:
      getUserId in interface Portlet
      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.
      Specified by:
      getUserNotificationDefinitions in interface 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.
      Specified by:
      getUserNotificationHandlerClasses in interface Portlet
      Returns:
      the names of the classes that represent user notification handlers associated with the portlet
    • getUserNotificationHandlerInstances

      public List<UserNotificationHandler> getUserNotificationHandlerInstances()
      Returns the user notification handler instances of the portlet.
      Specified by:
      getUserNotificationHandlerInstances in interface Portlet
      Returns:
      the user notification handler instances of the portlet
    • getUserPrincipalStrategy

      public String getUserPrincipalStrategy()
      Returns the user principal strategy of the portlet.
      Specified by:
      getUserPrincipalStrategy in interface Portlet
      Returns:
      the user principal strategy of the portlet
    • getVirtualPath

      public String getVirtualPath()
      Returns the virtual path of the portlet.
      Specified by:
      getVirtualPath in interface Portlet
      Returns:
      the virtual path of the portlet
    • getWebDAVStorageClass

      public String getWebDAVStorageClass()
      Returns 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
    • getWebDAVStorageInstance

      public WebDAVStorage getWebDAVStorageInstance()
      Returns 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
    • getWebDAVStorageToken

      public String getWebDAVStorageToken()
      Returns 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
    • getWindowStates

      public Map<String,Set<String>> getWindowStates()
      Returns the window states of the portlet.
      Specified by:
      getWindowStates in interface 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.
      Specified by:
      getWorkflowHandlerClasses in interface Portlet
      Returns:
      the names of the classes that represent workflow handlers associated with the portlet
    • getWorkflowHandlerInstances

      public List<WorkflowHandler<?>> getWorkflowHandlerInstances()
      Returns the workflow handler instances of the portlet.
      Specified by:
      getWorkflowHandlerInstances in interface 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.
      Specified by:
      getXmlRpcMethodClass in interface Portlet
      Returns:
      the name of the XML-RPC method class of the portlet
    • getXmlRpcMethodInstance

      public Method getXmlRpcMethodInstance()
      Returns the name of the XML-RPC method instance of the portlet.
      Specified by:
      getXmlRpcMethodInstance in interface 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.
      Specified by:
      hasAddPortletPermission in interface Portlet
      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()
      Specified by:
      hasFooterPortalCss in interface Portlet
    • hasFooterPortalJavaScript

      public boolean hasFooterPortalJavaScript()
      Specified by:
      hasFooterPortalJavaScript in interface Portlet
    • hasFooterPortletCss

      public boolean hasFooterPortletCss()
      Specified by:
      hasFooterPortletCss in interface Portlet
    • hasFooterPortletJavaScript

      public boolean hasFooterPortletJavaScript()
      Specified by:
      hasFooterPortletJavaScript in interface Portlet
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface Portlet
      Overrides:
      hashCode in class BaseModelWrapper<Portlet>
    • hasHeaderPortalCss

      public boolean hasHeaderPortalCss()
      Specified by:
      hasHeaderPortalCss in interface Portlet
    • hasHeaderPortalJavaScript

      public boolean hasHeaderPortalJavaScript()
      Specified by:
      hasHeaderPortalJavaScript in interface Portlet
    • hasHeaderPortletCss

      public boolean hasHeaderPortletCss()
      Specified by:
      hasHeaderPortletCss in interface Portlet
    • hasHeaderPortletJavaScript

      public boolean hasHeaderPortletJavaScript()
      Specified by:
      hasHeaderPortletJavaScript in interface Portlet
    • hasMultipleMimeTypes

      public boolean hasMultipleMimeTypes()
      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
    • hasPortletMode

      public boolean hasPortletMode(String mimeType, PortletMode portletMode)
      Returns true if the portlet supports the specified mime type and portlet mode.
      Specified by:
      hasPortletMode in interface Portlet
      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.
      Specified by:
      hasRoleWithName in interface Portlet
      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.
      Specified by:
      hasWindowState in interface Portlet
      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.
      Specified by:
      isActionURLRedirect in interface Portlet
      Returns:
      true if an action URL for this portlet should cause an auto redirect
    • isActive

      public boolean isActive()
      Returns true if this portlet is active.
      Specified by:
      isActive in interface PortletModel
      Returns:
      true if this portlet is active; false otherwise
    • isAddDefaultResource

      public boolean isAddDefaultResource()
      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
    • isAjaxable

      public boolean isAjaxable()
      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
    • isAsyncSupported

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

      public boolean isFullPageDisplayable()
      Specified by:
      isFullPageDisplayable in interface Portlet
    • isInclude

      public boolean isInclude()
      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
    • isInstanceable

      public boolean isInstanceable()
      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
    • isLayoutCacheable

      public boolean isLayoutCacheable()
      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
    • isMaximizeEdit

      public boolean isMaximizeEdit()
      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
    • isMaximizeHelp

      public boolean isMaximizeHelp()
      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
    • 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.
      Specified by:
      isPartialActionServeResource in interface Portlet
      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.
      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
    • 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.
      Specified by:
      isPortletDependencyCssEnabled in interface Portlet
      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.
      Specified by:
      isPortletDependencyJavaScriptEnabled in interface Portlet
      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.
      Specified by:
      isPreferencesCompanyWide in interface Portlet
      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.
      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.
    • isPreferencesUniquePerLayout

      public boolean isPreferencesUniquePerLayout()
      Returns true if preferences are unique per layout.
      Specified by:
      isPreferencesUniquePerLayout in interface Portlet
      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.
      Specified by:
      isPrivateRequestAttributes in interface Portlet
      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.
      Specified by:
      isPrivateSessionAttributes in interface Portlet
      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.
      Specified by:
      isReady in interface Portlet
      Returns:
      true if the portlet is ready to be used
    • isRequiresNamespacedParameters

      public boolean isRequiresNamespacedParameters()
      Returns true if the portlet will only process namespaced parameters.
      Specified by:
      isRequiresNamespacedParameters in interface Portlet
      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.
      Specified by:
      isRestoreCurrentView in interface Portlet
      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.
      Specified by:
      isScopeable in interface Portlet
      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.
      Specified by:
      isShowPortletAccessDenied in interface 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.
      Specified by:
      isShowPortletInactive in interface Portlet
      Returns:
      true if users are shown that the portlet is inactive
    • isSinglePageApplication

      public boolean isSinglePageApplication()
      Returns true if the portlet uses Single Page Application.
      Specified by:
      isSinglePageApplication in interface Portlet
      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.
      Specified by:
      isStatic in interface Portlet
      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.
      Specified by:
      isStaticEnd in interface Portlet
      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.
      Specified by:
      isStaticStart in interface Portlet
      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.
      Specified by:
      isSystem in interface Portlet
      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.
      Specified by:
      isUndeployedPortlet in interface 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.
      Specified by:
      isUseDefaultTemplate in interface Portlet
      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.
      Specified by:
      linkRoles in interface Portlet
    • persist

      public void persist()
      Description copied from interface: PersistedModel
      Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
      Specified by:
      persist in interface PersistedModel
    • setActionTimeout

      public void setActionTimeout(int actionTimeout)
      Sets the action timeout of the portlet.
      Specified by:
      setActionTimeout in interface 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.
      Specified by:
      setActionURLRedirect in interface Portlet
      Parameters:
      actionURLRedirect - boolean value for whether an action URL for this portlet should cause an auto redirect
    • setActive

      public void setActive(boolean active)
      Sets whether this portlet is active.
      Specified by:
      setActive in interface PortletModel
      Parameters:
      active - the active of this portlet
    • setAddDefaultResource

      public void setAddDefaultResource(boolean addDefaultResource)
      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
    • setAjaxable

      public void setAjaxable(boolean ajaxable)
      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
    • setApplicationTypes

      public void setApplicationTypes(Set<ApplicationType> applicationTypes)
      Sets the application types of the portlet.
      Specified by:
      setApplicationTypes in interface 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.
      Specified by:
      setAssetRendererFactoryClasses in interface 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.
      Specified by:
      setAsyncSupported in interface Portlet
      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.
      Specified by:
      setAutopropagatedParameters in interface 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.
      Specified by:
      setCategoryNames in interface Portlet
      Parameters:
      categoryNames - the category names of the portlet
    • setCompanyId

      public void setCompanyId(long companyId)
      Sets the company ID of this portlet.
      Specified by:
      setCompanyId in interface PortletModel
      Specified by:
      setCompanyId in interface ShardedModel
      Parameters:
      companyId - the company ID of this portlet
    • setConfigurationActionClass

      public void setConfigurationActionClass(String configurationActionClass)
      Sets the configuration action class of the portlet.
      Specified by:
      setConfigurationActionClass in interface 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.
      Specified by:
      setControlPanelEntryCategory in interface Portlet
      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.
      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
    • 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.
      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
    • setCssClassWrapper

      public void setCssClassWrapper(String cssClassWrapper)
      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
    • setCustomAttributesDisplayClasses

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

      public void setDefaultPluginSetting(PluginSetting pluginSetting)
      Sets the default plugin settings of the portlet.
      Specified by:
      setDefaultPluginSetting in interface Portlet
      Parameters:
      pluginSetting - the plugin setting
    • setDefaultPreferences

      public void setDefaultPreferences(String defaultPreferences)
      Sets the default preferences of the portlet.
      Specified by:
      setDefaultPreferences in interface Portlet
      Parameters:
      defaultPreferences - the default preferences of the portlet
    • setDisplayName

      public void setDisplayName(String displayName)
      Sets the display name of the portlet.
      Specified by:
      setDisplayName in interface Portlet
      Parameters:
      displayName - the display name of the portlet
    • setExpCache

      public void setExpCache(Integer expCache)
      Sets expiration cache of the portlet.
      Specified by:
      setExpCache in interface 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.
      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
    • 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.
      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
    • 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.
      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
    • 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.
      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
    • setFriendlyURLMapperClass

      public void setFriendlyURLMapperClass(String friendlyURLMapperClass)
      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
    • setFriendlyURLMapping

      public void setFriendlyURLMapping(String friendlyURLMapping)
      Sets the name of the friendly URL mapping of the portlet.
      Specified by:
      setFriendlyURLMapping in interface 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.
      Specified by:
      setFriendlyURLRoutes in interface 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.
      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
    • 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.
      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
    • 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.
      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
    • 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.
      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
    • 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.
      Specified by:
      setHeaderRequestAttributePrefixes in interface Portlet
      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.
      Specified by:
      setHeaderTimeout in interface Portlet
      Parameters:
      headerTimeout - the header timeout of the portlet
    • setIcon

      public void setIcon(String icon)
      Sets the icon of the portlet.
      Specified by:
      setIcon in interface Portlet
      Parameters:
      icon - the icon of the portlet
    • setId

      public void setId(long id)
      Sets the ID of this portlet.
      Specified by:
      setId in interface PortletModel
      Parameters:
      id - the ID of this portlet
    • setInclude

      public void setInclude(boolean include)
      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
    • setIndexerClasses

      public void setIndexerClasses(List<String> indexerClasses)
      Sets the names of the classes that represent indexers associated with the portlet.
      Specified by:
      setIndexerClasses in interface 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.
      Specified by:
      setInitParams in interface 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.
      Specified by:
      setInstanceable in interface Portlet
      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.
      Specified by:
      setLayoutCacheable in interface Portlet
      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.
      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
    • 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.
      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
    • setMultipartFileSizeThreshold

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

      public void setMultipartLocation(String multipartLocation)
      Sets the directory for storing uploaded files.
      Specified by:
      setMultipartLocation in interface Portlet
      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.
      Specified by:
      setMultipartMaxFileSize in interface Portlet
      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.
      Specified by:
      setMultipartMaxRequestSize in interface Portlet
      Parameters:
      multipartMaxRequestSize - the maximum number of bytes permitted for a multipart request
    • setMvccVersion

      public void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this portlet.
      Specified by:
      setMvccVersion in interface MVCCModel
      Specified by:
      setMvccVersion in interface PortletModel
      Parameters:
      mvccVersion - the mvcc version of this portlet
    • setOpenSearchClass

      public void setOpenSearchClass(String openSearchClass)
      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
    • setParentStrutsPath

      public void setParentStrutsPath(String parentStrutsPath)
      Sets the parent struts path of the portlet.
      Specified by:
      setParentStrutsPath in interface 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.
      Specified by:
      setPartialActionServeResource in interface Portlet
      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.
      Specified by:
      setPermissionPropagatorClass in interface Portlet
    • setPluginPackage

      public void setPluginPackage(PluginPackage pluginPackage)
      Sets this portlet's plugin package.
      Specified by:
      setPluginPackage in interface Portlet
      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.
      Specified by:
      setPopMessageListenerClass in interface 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.
      Specified by:
      setPopUpPrint in interface Portlet
      Parameters:
      popUpPrint - whether the portlet goes into the pop up state when the user goes into the print mode
    • setPortletApp

      public void setPortletApp(PortletApp portletApp)
      Sets this portlet's application.
      Specified by:
      setPortletApp in interface Portlet
      Parameters:
      portletApp - this portlet's application
    • setPortletClass

      public void setPortletClass(String portletClass)
      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
    • setPortletConfigurationListenerClass

      public void setPortletConfigurationListenerClass(String portletConfigurationListenerClass)
      Specified by:
      setPortletConfigurationListenerClass in interface Portlet
    • setPortletDataHandlerClass

      public void setPortletDataHandlerClass(String portletDataHandlerClass)
      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
    • 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.
      Specified by:
      setPortletDependencyCssEnabled in interface Portlet
      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.
      Specified by:
      setPortletDependencyJavaScriptEnabled in interface Portlet
      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,PortletFilter> portletFilters)
      Sets the filters of the portlet.
      Specified by:
      setPortletFilters in interface Portlet
      Parameters:
      portletFilters - the filters of the portlet
    • setPortletId

      public void setPortletId(String portletId)
      Sets the portlet ID of this portlet.
      Specified by:
      setPortletId in interface PortletModel
      Parameters:
      portletId - the portlet ID of this portlet
    • setPortletInfo

      public void setPortletInfo(PortletInfo portletInfo)
      Sets the portlet info of the portlet.
      Specified by:
      setPortletInfo in interface 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.
      Specified by:
      setPortletLayoutListenerClass in interface 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.
      Specified by:
      setPortletModes in interface Portlet
      Parameters:
      portletModes - the portlet modes of the portlet
    • setPortletName

      public void setPortletName(String portletName)
      Sets the name of the portlet.
      Specified by:
      setPortletName in interface 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.
      Specified by:
      setPortletURLClass in interface 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.
      Specified by:
      setPreferencesCompanyWide in interface Portlet
      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.
      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
    • setPreferencesUniquePerLayout

      public void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
      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
    • setPreferencesValidator

      public void setPreferencesValidator(String preferencesValidator)
      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
    • setPrimaryKey

      public void setPrimaryKey(long primaryKey)
      Sets the primary key of this portlet.
      Specified by:
      setPrimaryKey in interface PortletModel
      Parameters:
      primaryKey - the primary key of this 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.
      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
    • setPrivateSessionAttributes

      public void setPrivateSessionAttributes(boolean privateSessionAttributes)
      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
    • setProcessingEvents

      public void setProcessingEvents(Set<QName> processingEvents)
      Sets the processing events of the portlet.
      Specified by:
      setProcessingEvents in interface Portlet
      Parameters:
      processingEvents - the processing events of the portlet
    • setPublicRenderParameters

      public void setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)
      Sets the public render parameters of the portlet.
      Specified by:
      setPublicRenderParameters in interface Portlet
      Parameters:
      publicRenderParameters - the public render parameters of the portlet
    • setPublishingEvents

      public void setPublishingEvents(Set<QName> publishingEvents)
      Sets the publishing events of the portlet.
      Specified by:
      setPublishingEvents in interface 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.
      Specified by:
      setReady in interface Portlet
      Parameters:
      ready - whether the portlet is ready to be used
    • setRenderTimeout

      public void setRenderTimeout(int renderTimeout)
      Sets the render timeout of the portlet.
      Specified by:
      setRenderTimeout in interface Portlet
      Parameters:
      renderTimeout - the render timeout of the portlet
    • setRenderWeight

      public void setRenderWeight(int renderWeight)
      Sets the render weight of the portlet.
      Specified by:
      setRenderWeight in interface 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.
      Specified by:
      setRequiresNamespacedParameters in interface Portlet
      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.
      Specified by:
      setResourceBundle in interface 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.
      Specified by:
      setRestoreCurrentView in interface Portlet
      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.
      Specified by:
      setRoleMappers in interface Portlet
      Parameters:
      roleMappers - the role mappers of the portlet
    • setRoles

      public void setRoles(String roles)
      Sets the roles of this portlet.
      Specified by:
      setRoles in interface PortletModel
      Parameters:
      roles - the roles of this portlet
    • setRolesArray

      public void setRolesArray(String[] rolesArray)
      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
    • setSchedulerEntries

      public void setSchedulerEntries(List<SchedulerEntry> schedulerEntries)
      Sets the scheduler entries of the portlet.
      Specified by:
      setSchedulerEntries in interface 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.
      Specified by:
      setScopeable in interface Portlet
      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.
      Specified by:
      setShowPortletAccessDenied in interface 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.
      Specified by:
      setShowPortletInactive in interface Portlet
      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.
      Specified by:
      setSinglePageApplication in interface Portlet
      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.
      Specified by:
      setSocialActivityInterpreterClasses in interface 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.
      Specified by:
      setSocialRequestInterpreterClass in interface 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.
      Specified by:
      setStagedModelDataHandlerClasses in interface 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.
      Specified by:
      setStatic in interface Portlet
      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.
      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
    • setStrutsPath

      public void setStrutsPath(String strutsPath)
      Sets the struts path of the portlet.
      Specified by:
      setStrutsPath in interface Portlet
      Parameters:
      strutsPath - the struts path of the portlet
    • setSupportedLocales

      public void setSupportedLocales(Set<String> supportedLocales)
      Sets the supported locales of the portlet.
      Specified by:
      setSupportedLocales in interface 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.
      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
    • setTemplateHandlerClass

      public void setTemplateHandlerClass(String templateHandlerClass)
      Sets the name of the template handler class of the portlet.
      Specified by:
      setTemplateHandlerClass in interface 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.
      Specified by:
      setTrashHandlerClasses in interface 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.
      Specified by:
      setUndeployedPortlet in interface 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.
      Specified by:
      setUnlinkedRoles in interface 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.
      Specified by:
      setURLEncoderClass in interface 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.
      Specified by:
      setUseDefaultTemplate in interface Portlet
      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.
      Specified by:
      setUserNotificationDefinitions in interface 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.
      Specified by:
      setUserNotificationHandlerClasses in interface 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.
      Specified by:
      setUserPrincipalStrategy in interface Portlet
      Parameters:
      userPrincipalStrategy - the user principal strategy of the portlet
    • setVirtualPath

      public void setVirtualPath(String virtualPath)
      Sets the virtual path of the portlet.
      Specified by:
      setVirtualPath in interface 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.
      Specified by:
      setWebDAVStorageClass in interface 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.
      Specified by:
      setWebDAVStorageToken in interface 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.
      Specified by:
      setWindowStates in interface 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.
      Specified by:
      setWorkflowHandlerClasses in interface 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.
      Specified by:
      setXmlRpcMethodClass in interface Portlet
      Parameters:
      xmlRpcMethodClass - the name of the XML-RPC method class of the portlet
    • toXmlString

      public String toXmlString()
      Specified by:
      toXmlString in interface PortletModel
    • unsetReady

      public void unsetReady()
      Specified by:
      unsetReady in interface Portlet
    • wrap

      protected PortletWrapper wrap(Portlet portlet)
      Specified by:
      wrap in class BaseModelWrapper<Portlet>