Interface Portlet

All Superinterfaces:
BaseModel<Portlet>, ClassedModel, Cloneable, Comparable<Portlet>, MVCCModel, PersistedModel, PortletModel, Serializable, ShardedModel
All Known Implementing Classes:
PortletWrapper

@ProviderType public interface Portlet extends PersistedModel, PortletModel
The extended model interface for the Portlet service. Represents a row in the "Portlet" database table, with each column mapped to a property of this class.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Field Details

  • Method Details

    • addApplicationType

      void addApplicationType(ApplicationType applicationType)
      Adds an application type.
      Parameters:
      applicationType - an application type
    • addPortletDependency

      void addPortletDependency(PortletDependency portletDependency)
      Adds a portlet CSS/JavaScript resource dependency.
      Parameters:
      portletDependency - the portlet CSS/JavaScript resource dependency
    • addProcessingEvent

      void addProcessingEvent(QName processingEvent)
      Adds a processing event.
    • addPublicRenderParameter

      void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
      Adds a public render parameter.
      Parameters:
      publicRenderParameter - a public render parameter
    • addPublishingEvent

      void addPublishingEvent(QName publishingEvent)
      Adds a publishing event.
    • addSchedulerEntry

      void addSchedulerEntry(SchedulerEntry schedulerEntry)
      Adds a scheduler entry.
    • clone

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

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

      boolean equals(Object object)
      Checks whether this portlet is equal to the specified object.
      Overrides:
      equals in class Object
      Parameters:
      object - the object to compare this portlet against
      Returns:
      true if the portlet is equal to the specified object
    • getActionTimeout

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

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

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

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

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

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

      Set<ApplicationType> getApplicationTypes()
      Returns the application types of the portlet.
      Returns:
      the application types of the portlet
    • getAssetRendererFactoryClasses

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

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

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

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

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

      ConfigurationAction getConfigurationActionInstance()
      Returns the configuration action instance of the portlet.
      Returns:
      the configuration action instance of the portlet
    • getContextName

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

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

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

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

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

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

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

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

      List<CustomAttributesDisplay> getCustomAttributesDisplayInstances()
      Returns the custom attribute display instances of the portlet.
      Returns:
      the custom attribute display instances of the portlet
    • getDefaultPluginSetting

      PluginSetting getDefaultPluginSetting()
      Get the default plugin settings of the portlet.
      Returns:
      the plugin settings
    • getDefaultPreferences

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

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

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

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

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

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

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

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

      FriendlyURLMapper getFriendlyURLMapperInstance()
      Returns the friendly URL mapper instance of the portlet.
      Returns:
      the friendly URL mapper instance of the portlet
    • getFriendlyURLMapping

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

      String getFriendlyURLMapping(boolean lookUpFriendlyURLMapper)
    • getFriendlyURLRoutes

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

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

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

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

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

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

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

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

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

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

      List<Indexer<?>> getIndexerInstances()
      Returns the indexer instances of the portlet.
      Returns:
      the indexer instances of the portlet
    • getInitParams

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

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

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

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

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

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

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

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

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

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

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

      OpenSearch getOpenSearchInstance()
      Returns the indexer instance of the portlet.
      Returns:
      the indexer instance of the portlet
    • getParentStrutsPath

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

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

      PermissionPropagator getPermissionPropagatorInstance()
      Returns the permission propagator instance of the portlet.
      Returns:
      the permission propagator instance of the portlet
    • getPluginId

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

      PluginPackage getPluginPackage()
      Returns this portlet's plugin package.
      Returns:
      this portlet's plugin package
    • getPluginType

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

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

      MessageListener getPopMessageListenerInstance()
      Returns the POP message listener instance of the portlet.
      Returns:
      the POP message listener instance of the portlet
    • getPopUpPrint

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

      PortletApp getPortletApp()
      Returns this portlet's application.
      Returns:
      this portlet's application
    • getPortletClass

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

      String getPortletConfigurationListenerClass()
    • getPortletConfigurationListenerInstance

      PortletConfigurationListener getPortletConfigurationListenerInstance()
    • getPortletDataHandlerClass

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

      PortletDataHandler getPortletDataHandlerInstance()
      Returns the portlet data handler instance of the portlet.
      Returns:
      the portlet data handler instance of the portlet
    • getPortletDependencies

      List<PortletDependency> getPortletDependencies()
      Returns the portlet's CSS/JavaScript resource dependencies.
      Returns:
      the portlet's CSS/JavaScript resource dependencies
    • getPortletFilters

      Map<String,PortletFilter> getPortletFilters()
      Returns the filters of the portlet.
      Returns:
      filters of the portlet
    • getPortletInfo

      PortletInfo getPortletInfo()
      Returns the portlet info of the portlet.
      Returns:
      portlet info of the portlet
    • getPortletLayoutListenerClass

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

      PortletLayoutListener getPortletLayoutListenerInstance()
      Returns the portlet layout listener instance of the portlet.
      Returns:
      the portlet layout listener instance of the portlet
    • getPortletModes

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

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

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

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

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

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

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

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

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

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

      Set<QName> getProcessingEvents()
      Returns the processing events of the portlet.
      Returns:
      the processing events of the portlet
    • getPublicRenderParameter

      PublicRenderParameter getPublicRenderParameter(String identifier)
      Returns the public render parameter from an identifier.
      Parameters:
      identifier - the identifier
      Returns:
      the public render parameter from an identifier
    • getPublicRenderParameter

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

      Set<PublicRenderParameter> getPublicRenderParameters()
      Returns the public render parameters of the portlet.
      Returns:
      the public render parameters of the portlet
    • getPublishingEvents

      Set<QName> getPublishingEvents()
      Returns the publishing events of the portlet.
      Returns:
      the publishing events of the portlet
    • getReady

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

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

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

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

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

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

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

      Portlet getRootPortlet()
      Returns the root portlet of this portlet instance.
      Returns:
      the root portlet of this portlet instance
    • getRootPortletId

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

      List<SchedulerEntry> getSchedulerEntries()
      Returns the scheduler entries of the portlet.
      Returns:
      the scheduler entries of the portlet
    • getScopeable

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

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

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

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

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

      List<SocialActivityInterpreter> getSocialActivityInterpreterInstances()
      Returns the social activity interpreter instances of the portlet.
      Returns:
      the social activity interpreter instances of the portlet
    • getSocialRequestInterpreterClass

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

      SocialRequestInterpreter getSocialRequestInterpreterInstance()
      Returns the name of the social request interpreter instance of the portlet.
      Returns:
      the name of the social request interpreter instance of the portlet
    • getStagedModelDataHandlerClasses

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

      List<StagedModelDataHandler<?>> getStagedModelDataHandlerInstances()
      Returns the staged model data handler instances of the portlet.
      Returns:
      the staged model data handler instances of the portlet
    • getStatic

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

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

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

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

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

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

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

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

      TemplateHandler getTemplateHandlerInstance()
      Returns the template handler instance of the portlet.
      Returns:
      the template handler instance of the portlet
    • getTimestamp

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

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

      List<TrashHandler> getTrashHandlerInstances()
      Returns the trash handler instances of the portlet.
      Returns:
      the trash handler instances of the portlet
    • getUndeployedPortlet

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

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

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

      URLEncoder getURLEncoderInstance()
      Returns the URL encoder instance of the portlet.
      Returns:
      the URL encoder instance of the portlet
    • getUseDefaultTemplate

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

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

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

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

      List<UserNotificationHandler> getUserNotificationHandlerInstances()
      Returns the user notification handler instances of the portlet.
      Returns:
      the user notification handler instances of the portlet
    • getUserPrincipalStrategy

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

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

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

      WebDAVStorage getWebDAVStorageInstance()
      Returns the name of the WebDAV storage instance of the portlet.
      Returns:
      the name of the WebDAV storage instance of the portlet
    • getWebDAVStorageToken

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

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

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

      List<WorkflowHandler<?>> getWorkflowHandlerInstances()
      Returns the workflow handler instances of the portlet.
      Returns:
      the workflow handler instances of the portlet
    • getXmlRpcMethodClass

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

      Method getXmlRpcMethodInstance()
      Returns the name of the XML-RPC method instance of the portlet.
      Returns:
      the name of the XML-RPC method instance of the portlet
    • hasAddPortletPermission

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

      boolean hasFooterPortalCss()
    • hasFooterPortalJavaScript

      boolean hasFooterPortalJavaScript()
    • hasFooterPortletCss

      boolean hasFooterPortletCss()
    • hasFooterPortletJavaScript

      boolean hasFooterPortletJavaScript()
    • hashCode

      int hashCode()
      Overrides:
      hashCode in class Object
    • hasHeaderPortalCss

      boolean hasHeaderPortalCss()
    • hasHeaderPortalJavaScript

      boolean hasHeaderPortalJavaScript()
    • hasHeaderPortletCss

      boolean hasHeaderPortletCss()
    • hasHeaderPortletJavaScript

      boolean hasHeaderPortletJavaScript()
    • hasMultipleMimeTypes

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

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

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

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

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

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

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

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

      boolean isFullPageDisplayable()
    • isInclude

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      void setApplicationTypes(Set<ApplicationType> applicationTypes)
      Sets the application types of the portlet.
      Parameters:
      applicationTypes - the application types of the portlet
    • setAssetRendererFactoryClasses

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

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

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

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

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

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

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

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

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

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

      void setDefaultPluginSetting(PluginSetting pluginSetting)
      Sets the default plugin settings of the portlet.
      Parameters:
      pluginSetting - the plugin setting
    • setDefaultPreferences

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      void setPluginPackage(PluginPackage pluginPackage)
      Sets this portlet's plugin package.
      Parameters:
      pluginPackage - this portlet's plugin package
    • setPopMessageListenerClass

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

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

      void setPortletApp(PortletApp portletApp)
      Sets this portlet's application.
      Parameters:
      portletApp - this portlet's application
    • setPortletClass

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

      void setPortletConfigurationListenerClass(String portletConfigurationListenerClass)
    • setPortletDataHandlerClass

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

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

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

      void setPortletFilters(Map<String,PortletFilter> portletFilters)
      Sets the filters of the portlet.
      Parameters:
      portletFilters - the filters of the portlet
    • setPortletInfo

      void setPortletInfo(PortletInfo portletInfo)
      Sets the portlet info of the portlet.
      Parameters:
      portletInfo - the portlet info of the portlet
    • setPortletLayoutListenerClass

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

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

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

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

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

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

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

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

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

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

      void setProcessingEvents(Set<QName> processingEvents)
      Sets the processing events of the portlet.
      Parameters:
      processingEvents - the processing events of the portlet
    • setPublicRenderParameters

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

      void setPublishingEvents(Set<QName> publishingEvents)
      Sets the publishing events of the portlet.
      Parameters:
      publishingEvents - the publishing events of the portlet
    • setReady

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      void unsetReady()