PortletImpl (Liferay 6.1.2-ce-ga3 Internal API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.1.2-ce-ga3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.model.impl
Class PortletImpl

java.lang.Object
  com.liferay.portal.model.impl.BaseModelImpl<Portlet>
      com.liferay.portal.model.impl.PortletModelImpl
          com.liferay.portal.model.impl.PortletBaseImpl
              com.liferay.portal.model.impl.PortletImpl

All Implemented Interfaces:: BaseModel<Portlet>, ClassedModel, PersistedModel, Portlet, PortletModel, Serializable, Cloneable, Comparable<Portlet>

public class PortletImpl
extends PortletBaseImpl
extends PortletBaseImpl

See Also:: Serialized Form

Field Summary

Fields inherited from class com.liferay.portal.model.impl.PortletModelImpl
`COLUMN_BITMASK_ENABLED, COMPANYID_COLUMN_BITMASK, DATA_SOURCE, ENTITY_CACHE_ENABLED, FINDER_CACHE_ENABLED, LOCK_EXPIRATION_TIME, PORTLETID_COLUMN_BITMASK, SESSION_FACTORY, TABLE_COLUMNS, TABLE_NAME, TABLE_SQL_CREATE, TABLE_SQL_DROP, TX_MANAGER`

Fields inherited from interface com.liferay.portal.model.Portlet
`PORTLET_ID_ACCESSOR`

Constructor Summary
`PortletImpl()` Constructs a portlet with no parameters.
`PortletImpl(long companyId, String portletId)` Constructs a portlet with the specified parameters.
PortletImpl(String portletId, Portlet rootPortlet, PluginPackage pluginPackage, PluginSetting pluginSetting, long companyId, long timestamp, String icon, String virtualPath, String strutsPath, String parentStrutsPath, String portletName, String displayName, String portletClass, String configurationActionClass, List<String> indexerClasses, String openSearchClass, List<SchedulerEntry> schedulerEntries, String portletURLClass, String friendlyURLMapperClass, String friendlyURLMapping, String friendlyURLRoutes, String urlEncoderClass, String portletDataHandlerClass, String portletLayoutListenerClass, String pollerProcessorClass, String popMessageListenerClass, String socialActivityInterpreterClass, String socialRequestInterpreterClass, String webDAVStorageToken, String webDAVStorageClass, String xmlRpcMethodClass, String controlPanelEntryCategory, double controlPanelEntryWeight, String controlPanelClass, List<String> assetRendererFactoryClasses, List<String> atomCollectionAdapterClasses, List<String> customAttributesDisplayClasses, String permissionPropagatorClass, List<String> workflowHandlerClasses, String defaultPreferences, String preferencesValidator, boolean preferencesCompanyWide, boolean preferencesUniquePerLayout, boolean preferencesOwnedByGroup, boolean useDefaultTemplate, boolean showPortletAccessDenied, boolean showPortletInactive, boolean actionURLRedirect, boolean restoreCurrentView, boolean maximizeEdit, boolean maximizeHelp, boolean popUpPrint, boolean layoutCacheable, boolean instanceable, boolean remoteable, boolean scopeable, String userPrincipalStrategy, boolean privateRequestAttributes, boolean privateSessionAttributes, Set<String> autopropagatedParameters, int actionTimeout, int renderTimeout, int renderWeight, boolean ajaxable, List<String> headerPortalCss, List<String> headerPortletCss, List<String> headerPortalJavaScript, List<String> headerPortletJavaScript, List<String> footerPortalCss, List<String> footerPortletCss, List<String> footerPortalJavaScript, List<String> footerPortletJavaScript, String cssClassWrapper, String facebookIntegration, boolean addDefaultResource, String roles, Set<String> unlinkedRoles, Map<String,String> roleMappers, boolean system, boolean active, boolean include, Map<String,String> initParams, Integer expCache, Map<String,Set<String>> portletModes, Map<String,Set<String>> windowStates, Set<String> supportedLocales, String resourceBundle, PortletInfo portletInfo, Map<String,PortletFilter> portletFilters, Set<QName> processingEvents, Set<QName> publishingEvents, Set<PublicRenderParameter> publicRenderParameters, PortletApp portletApp) Constructs a portlet with the specified parameters.

Method Summary
`void`	`addProcessingEvent(QName processingEvent)` Adds a supported processing event.
`void`	`addPublicRenderParameter(PublicRenderParameter publicRenderParameter)` Adds a supported public render parameter.
`void`	`addPublishingEvent(QName publishingEvent)` Adds a supported publishing event.
`void`	`addSchedulerEntry(SchedulerEntry schedulerEntry)` Adds a scheduler entry.
`Object`	`clone()` Creates and returns a copy of this object.
`int`	`compareTo(Portlet portlet)` Compares this portlet to the specified object.
`boolean`	`equals(Object obj)` Checks whether this portlet is equal to the specified object.
`int`	`getActionTimeout()` Returns the action timeout of the portlet.
`boolean`	`getActionURLRedirect()` Returns `true` if an action URL for this portlet should cause an auto redirect.
`boolean`	`getAddDefaultResource()` Returns `true` if default resources for the portlet are added to a page.
`boolean`	`getAjaxable()` Returns `true` if the portlet can be displayed via Ajax.
`Set<String>`	`getAllPortletModes()` Returns a list of all portlet modes supported by the portlet.
`Set<String>`	`getAllWindowStates()` Returns a list of all window states supported by the portlet.
`List<String>`	`getAssetRendererFactoryClasses()` Returns the names of the classes that represent asset types associated with the portlet.
`List<AssetRendererFactory>`	`getAssetRendererFactoryInstances()` Returns the asset type instances of the portlet.
`List<String>`	`getAtomCollectionAdapterClasses()` Returns the names of the classes that represent atom collection adapters associated with the portlet.
`List<AtomCollectionAdapter<?>>`	`getAtomCollectionAdapterInstances()` Returns the atom collection adapter instances of the portlet.
`Set<String>`	`getAutopropagatedParameters()` Returns the names of the parameters that will be automatically propagated through the portlet.
`Portlet`	`getClonedInstance(String portletId)` Returns `true` if the portlet is found in a WAR file.
`String`	`getConfigurationActionClass()` Returns the configuration action class of the portlet.
`ConfigurationAction`	`getConfigurationActionInstance()` Returns the configuration action instance of the portlet.
`String`	`getContextPath()` Returns the servlet context path of the portlet.
`String`	`getControlPanelEntryCategory()` Returns the name of the category of the Control Panel where the portlet will be shown.
`String`	`getControlPanelEntryClass()` Returns the name of the class that will control when the portlet will be shown in the Control Panel.
`ControlPanelEntry`	`getControlPanelEntryInstance()` Returns an instance of the class that will control when the portlet will be shown in the Control Panel.
`double`	`getControlPanelEntryWeight()` Returns the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.
`String`	`getCssClassWrapper()` Returns the name of the CSS class that will be injected in the DIV that wraps this portlet.
`List<String>`	`getCustomAttributesDisplayClasses()` Returns the names of the classes that represent custom attribute displays associated with the portlet.
`List<CustomAttributesDisplay>`	`getCustomAttributesDisplayInstances()` Returns the custom attribute display instances of the portlet.
`PluginSetting`	`getDefaultPluginSetting()` Get the default plugin settings of the portlet.
`String`	`getDefaultPreferences()` Returns the default preferences of the portlet.
`String`	`getDisplayName()` Returns the display name of the portlet.
`Integer`	`getExpCache()` Returns expiration cache of the portlet.
`String`	`getFacebookIntegration()` Returns the Facebook integration method of the portlet.
`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.
`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.
`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.
`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.
`String`	`getFriendlyURLMapperClass()` Returns the name of the friendly URL mapper class of the portlet.
`FriendlyURLMapper`	`getFriendlyURLMapperInstance()` Returns the friendly URL mapper instance of the portlet.
`String`	`getFriendlyURLMapping()` Returns the name of the friendly URL mapping of the portlet.
`String`	`getFriendlyURLRoutes()` Returns the class loader resource path to the friendly URL routes of the portlet.
`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.
`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.
`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.
`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.
`String`	`getIcon()` Returns the icon of the portlet.
`boolean`	`getInclude()` Returns `true` to include the portlet and make it available to be made active.
`List<String>`	`getIndexerClasses()` Returns the name of the classes that represent indexers associated with the portlet.
`List<Indexer>`	`getIndexerInstances()` Returns the indexer instances of the portlet.
`Map<String,String>`	`getInitParams()` Returns the init parameters of the portlet.
`boolean`	`getInstanceable()` Returns `true` if the portlet can be added multiple times to a layout.
`String`	`getInstanceId()` Returns the instance ID of the portlet.
`boolean`	`getLayoutCacheable()` Returns `true` to allow the portlet to be cached within the layout.
`boolean`	`getMaximizeEdit()` Returns `true` if the portlet goes into the maximized state when the user goes into the edit mode.
`boolean`	`getMaximizeHelp()` Returns `true` if the portlet goes into the maximized state when the user goes into the help mode.
`String`	`getOpenSearchClass()` Returns the name of the open search class of the portlet.
`OpenSearch`	`getOpenSearchInstance()` Returns the indexer instance of the portlet.
`String`	`getParentStrutsPath()` Returns the parent struts path of the portlet.
`String`	`getPermissionPropagatorClass()` Returns the name of the permission propagator class of the portlet.
`PermissionPropagator`	`getPermissionPropagatorInstance()` Returns the permission propagator instance of the portlet.
`String`	`getPluginId()` Returns the plugin ID of the portlet.
`PluginPackage`	`getPluginPackage()` Returns this portlet's plugin package.
`String`	`getPluginType()` Returns the plugin type of the portlet.
`String`	`getPollerProcessorClass()` Returns the name of the poller processor class of the portlet.
`PollerProcessor`	`getPollerProcessorInstance()` Returns the poller processor instance of the portlet.
`String`	`getPopMessageListenerClass()` Returns the name of the POP message listener class of the portlet.
`MessageListener`	`getPopMessageListenerInstance()` Returns the POP message listener instance of the portlet.
`boolean`	`getPopUpPrint()` Returns `true` if the portlet goes into the pop up state when the user goes into the print mode.
`PortletApp`	`getPortletApp()` Returns this portlet's application.
`String`	`getPortletClass()` Returns the name of the portlet class of the portlet.
`String`	`getPortletDataHandlerClass()` Returns the name of the portlet data handler class of the portlet.
`PortletDataHandler`	`getPortletDataHandlerInstance()` Returns the portlet data handler instance of the portlet.
`Map<String,PortletFilter>`	`getPortletFilters()` Returns the filters of the portlet.
`PortletInfo`	`getPortletInfo()` Returns the portlet info of the portlet.
`String`	`getPortletLayoutListenerClass()` Returns the name of the portlet layout listener class of the portlet.
`PortletLayoutListener`	`getPortletLayoutListenerInstance()` Returns the portlet layout listener instance of the portlet.
`Map<String,Set<String>>`	`getPortletModes()` Returns the portlet modes of the portlet.
`String`	`getPortletName()` Returns the name of the portlet.
`String`	`getPortletURLClass()` Returns the name of the portlet URL class of the portlet.
`boolean`	`getPreferencesCompanyWide()` Returns `true` if preferences are shared across the entire company.
`boolean`	`getPreferencesOwnedByGroup()` Returns `true` if preferences are owned by the group when the portlet is shown in a group layout.
`boolean`	`getPreferencesUniquePerLayout()` Returns `true` if preferences are unique per layout.
`String`	`getPreferencesValidator()` Returns the name of the preferences validator class of the portlet.
`boolean`	`getPrivateRequestAttributes()` Returns `true` if the portlet does not share request attributes with the portal or portlets from another WAR.
`boolean`	`getPrivateSessionAttributes()` Returns `true` if the portlet does not share session attributes with the portal.
`QName`	`getProcessingEvent(String uri, String localPart)` Returns the supported processing event from a namespace URI and a local part.
`Set<QName>`	`getProcessingEvents()` Returns the supported processing events of the portlet.
`PublicRenderParameter`	`getPublicRenderParameter(String identifier)` Returns the supported public render parameter from an identifier.
`PublicRenderParameter`	`getPublicRenderParameter(String uri, String localPart)` Returns the supported public render parameter from a namespace URI and a local part.
`Set<PublicRenderParameter>`	`getPublicRenderParameters()` Returns the supported public render parameters of the portlet.
`Set<QName>`	`getPublishingEvents()` Returns the supported publishing events of the portlet.
`boolean`	`getReady()` Returns `true` if the portlet is ready to be used.
`boolean`	`getRemoteable()` Returns `true` if the portlet supports remoting.
`int`	`getRenderTimeout()` Returns the render timeout of the portlet.
`int`	`getRenderWeight()` Returns the render weight of the portlet.
`String`	`getResourceBundle()` Returns the resource bundle of the portlet.
`boolean`	`getRestoreCurrentView()` Returns `true` if the portlet restores to the current view from the maximized state.
`Map<String,String>`	`getRoleMappers()` Returns the role mappers of the portlet.
`String[]`	`getRolesArray()` Returns an array of required roles of the portlet.
`Portlet`	`getRootPortlet()` Returns the root portlet of this portlet instance.
`String`	`getRootPortletId()` Returns the root portlet ID of the portlet.
`List<SchedulerEntry>`	`getSchedulerEntries()` Returns the scheduler entries of the portlet.
`boolean`	`getScopeable()` Returns `true` if the portlet supports scoping of data.
`boolean`	`getShowPortletAccessDenied()` Returns `true` if users are shown that they do not have access to the portlet.
`boolean`	`getShowPortletInactive()` Returns `true` if users are shown that the portlet is inactive.
`String`	`getSocialActivityInterpreterClass()` Returns the name of the social activity interpreter class of the portlet.
`SocialActivityInterpreter`	`getSocialActivityInterpreterInstance()` Returns the name of the social activity interpreter instance of the portlet.
`String`	`getSocialRequestInterpreterClass()` Returns the name of the social request interpreter class of the portlet.
`SocialRequestInterpreter`	`getSocialRequestInterpreterInstance()` Returns the name of the social request interpreter instance of the portlet.
`boolean`	`getStatic()` Returns `true` if the portlet is a static portlet that is cannot be moved.
`boolean`	`getStaticEnd()` Returns `true` if the portlet is a static portlet at the end of a list of portlets.
`String`	`getStaticResourcePath()` Returns the path for static resources served by this portlet.
`boolean`	`getStaticStart()` Returns `true` if the portlet is a static portlet at the start of a list of portlets.
`String`	`getStrutsPath()` Returns the struts path of the portlet.
`Set<String>`	`getSupportedLocales()` Returns the supported locales of the portlet.
`boolean`	`getSystem()` Returns `true` if the portlet is a system portlet that a user cannot manually add to their page.
`long`	`getTimestamp()` Returns the timestamp of the portlet.
`boolean`	`getUndeployedPortlet()` Returns `true` if the portlet is an undeployed portlet.
`Set<String>`	`getUnlinkedRoles()` Returns the unlinked roles of the portlet.
`String`	`getURLEncoderClass()` Returns the name of the URL encoder class of the portlet.
`URLEncoder`	`getURLEncoderInstance()` Returns the URL encoder instance of the portlet.
`boolean`	`getUseDefaultTemplate()` Returns `true` if the portlet uses the default template.
`String`	`getUserPrincipalStrategy()` Returns the user principal strategy of the portlet.
`String`	`getVirtualPath()` Returns the virtual path of the portlet.
`String`	`getWebDAVStorageClass()` Returns the name of the WebDAV storage class of the portlet.
`WebDAVStorage`	`getWebDAVStorageInstance()` Returns the name of the WebDAV storage instance of the portlet.
`String`	`getWebDAVStorageToken()` Returns the name of the WebDAV storage token of the portlet.
`Map<String,Set<String>>`	`getWindowStates()` Returns the window states of the portlet.
`List<String>`	`getWorkflowHandlerClasses()` Returns the names of the classes that represent workflow handlers associated with the portlet.
`List<WorkflowHandler>`	`getWorkflowHandlerInstances()` Returns the workflow handler instances of the portlet.
`String`	`getXmlRpcMethodClass()` Returns the name of the XML-RPC method class of the portlet.
`Method`	`getXmlRpcMethodInstance()` Returns the name of the XML-RPC method instance of the portlet.
`boolean`	`hasAddPortletPermission(long userId)` Returns `true` if the user has the permission to add the portlet to a layout.
`boolean`	`hasMultipleMimeTypes()` Returns `true` if the portlet supports more than one mime type.
`boolean`	`hasPortletMode(String mimeType, PortletMode portletMode)` Returns `true` if the portlet supports the specified mime type and portlet mode.
`boolean`	`hasRoleWithName(String roleName)` Returns `true` if the portlet has a role with the specified name.
`boolean`	`hasWindowState(String mimeType, WindowState windowState)` Returns `true` if the portlet supports the specified mime type and window state.
`boolean`	`isActionURLRedirect()` Returns `true` if an action URL for this portlet should cause an auto redirect.
`boolean`	`isAddDefaultResource()` Returns `true` if default resources for the portlet are added to a page.
`boolean`	`isAjaxable()` Returns `true` if the portlet can be displayed via Ajax.
`boolean`	`isInclude()` Returns `true` to include the portlet and make it available to be made active.
`boolean`	`isInstanceable()` Returns `true` if the portlet can be added multiple times to a layout.
`boolean`	`isLayoutCacheable()` Returns `true` to allow the portlet to be cached within the layout.
`boolean`	`isMaximizeEdit()` Returns `true` if the portlet goes into the maximized state when the user goes into the edit mode.
`boolean`	`isMaximizeHelp()` Returns `true` if the portlet goes into the maximized state when the user goes into the help mode.
`boolean`	`isPopUpPrint()` Returns `true` if the portlet goes into the pop up state when the user goes into the print mode.
`boolean`	`isPreferencesCompanyWide()` Returns `true` if preferences are shared across the entire company.
`boolean`	`isPreferencesOwnedByGroup()` Returns `true` if preferences are owned by the group when the portlet is shown in a group layout.
`boolean`	`isPreferencesUniquePerLayout()` Returns `true` if preferences are unique per layout.
`boolean`	`isPrivateRequestAttributes()` Returns `true` if the portlet does not share request attributes with the portal or portlets from another WAR.
`boolean`	`isPrivateSessionAttributes()` Returns `true` if the portlet does not share session attributes with the portal.
`boolean`	`isReady()` Returns `true` if the portlet is ready to be used.
`boolean`	`isRemoteable()` Returns `true` if the portlet supports remoting.
`boolean`	`isRestoreCurrentView()` Returns `true` if the portlet restores to the current view from the maximized state.
`boolean`	`isScopeable()` Returns `true` if the portlet supports scoping of data.
`boolean`	`isShowPortletAccessDenied()` Returns `true` if users are shown that they do not have access to the portlet.
`boolean`	`isShowPortletInactive()` Returns `true` if users are shown that the portlet is inactive.
`boolean`	`isStatic()` Returns `true` if the portlet is a static portlet that is cannot be moved.
`boolean`	`isStaticEnd()` Returns `true` if the portlet is a static portlet at the end of a list of portlets.
`boolean`	`isStaticStart()` Returns `true` if the portlet is a static portlet at the start of a list of portlets.
`boolean`	`isSystem()` Returns `true` if the portlet is a system portlet that a user cannot manually add to their page.
`boolean`	`isUndeployedPortlet()` Returns `true` if the portlet is an undeployed portlet.
`boolean`	`isUseDefaultTemplate()` Returns `true` if the portlet uses the default template.
`void`	`linkRoles()` Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml.
`void`	`setActionTimeout(int actionTimeout)` Sets the action timeout of the portlet.
`void`	`setActionURLRedirect(boolean actionURLRedirect)` Set to `true` if an action URL for this portlet should cause an auto redirect.
`void`	`setAddDefaultResource(boolean addDefaultResource)` Set to `true` if default resources for the portlet are added to a page.
`void`	`setAjaxable(boolean ajaxable)` Set to `true` if the portlet can be displayed via Ajax.
`void`	`setAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses)` Sets the name of the classes that represent asset types associated with the portlet.
`void`	`setAtomCollectionAdapterClasses(List<String> atomCollectionAdapterClasses)` Sets the name of the classes that represent atom collection adapters associated with the portlet.
`void`	`setAutopropagatedParameters(Set<String> autopropagatedParameters)` Sets the names of the parameters that will be automatically propagated through the portlet.
`void`	`setConfigurationActionClass(String configurationActionClass)` Sets the configuration action class of the portlet.
`void`	`setControlPanelEntryCategory(String controlPanelEntryCategory)` Set the name of the category of the Control Panel where the portlet will be shown.
`void`	`setControlPanelEntryClass(String controlPanelEntryClass)` Sets the name of the class that will control when the portlet will be shown in the Control Panel.
`void`	`setControlPanelEntryWeight(double controlPanelEntryWeight)` Sets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.
`void`	`setCssClassWrapper(String cssClassWrapper)` Sets the name of the CSS class that will be injected in the DIV that wraps this portlet.
`void`	`setCustomAttributesDisplayClasses(List<String> customAttributesDisplayClasses)` Sets the name of the classes that represent custom attribute displays associated with the portlet.
`void`	`setDefaultPluginSetting(PluginSetting pluginSetting)` Sets the default plugin settings of the portlet.
`void`	`setDefaultPreferences(String defaultPreferences)` Sets the default preferences of the portlet.
`void`	`setDisplayName(String displayName)` Sets the display name of the portlet.
`void`	`setExpCache(Integer expCache)` Sets expiration cache of the portlet.
`void`	`setFacebookIntegration(String facebookIntegration)` Sets the Facebook integration method of the portlet.
`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.
`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.
`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.
`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.
`void`	`setFriendlyURLMapperClass(String friendlyURLMapperClass)` Sets the name of the friendly URL mapper class of the portlet.
`void`	`setFriendlyURLMapping(String friendlyURLMapping)` Sets the name of the friendly URL mapping of the portlet.
`void`	`setFriendlyURLRoutes(String friendlyURLRoutes)` Sets the class loader resource path to the friendly URL routes of the portlet.
`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.
`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.
`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.
`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.
`void`	`setIcon(String icon)` Sets the icon of the portlet.
`void`	`setInclude(boolean include)` Set to `true` to include the portlet and make it available to be made active.
`void`	`setIndexerClasses(List<String> indexerClasses)` Sets the name of the classes that represent indexers associated with the portlet.
`void`	`setInitParams(Map<String,String> initParams)` Sets the init parameters of the portlet.
`void`	`setInstanceable(boolean instanceable)` Set to `true` if the portlet can be added multiple times to a layout.
`void`	`setLayoutCacheable(boolean layoutCacheable)` Set to `true` to allow the portlet to be cached within the layout.
`void`	`setMaximizeEdit(boolean maximizeEdit)` Set to `true` if the portlet goes into the maximized state when the user goes into the edit mode.
`void`	`setMaximizeHelp(boolean maximizeHelp)` Set to `true` if the portlet goes into the maximized state when the user goes into the help mode.
`void`	`setOpenSearchClass(String openSearchClass)` Sets the name of the open search class of the portlet.
`void`	`setParentStrutsPath(String parentStrutsPath)` Sets the parent struts path of the portlet.
`void`	`setPermissionPropagatorClass(String permissionPropagatorClass)` Sets the name of the permission propagator class of the portlet.
`void`	`setPluginPackage(PluginPackage pluginPackage)` Sets this portlet's plugin package.
`void`	`setPollerProcessorClass(String pollerProcessorClass)` Sets the name of the poller processor class of the portlet.
`void`	`setPopMessageListenerClass(String popMessageListenerClass)` Sets the name of the POP message listener class of the portlet.
`void`	`setPopUpPrint(boolean popUpPrint)` Set to `true` if the portlet goes into the pop up state when the user goes into the print mode.
`void`	`setPortletApp(PortletApp portletApp)` Sets this portlet's application.
`void`	`setPortletClass(String portletClass)` Sets the name of the portlet class of the portlet.
`void`	`setPortletDataHandlerClass(String portletDataHandlerClass)` Sets the name of the portlet data handler class of the portlet.
`void`	`setPortletFilters(Map<String,PortletFilter> portletFilters)` Sets the filters of the portlet.
`void`	`setPortletInfo(PortletInfo portletInfo)` Sets the portlet info of the portlet.
`void`	`setPortletLayoutListenerClass(String portletLayoutListenerClass)` Sets the name of the portlet layout listener class of the portlet.
`void`	`setPortletModes(Map<String,Set<String>> portletModes)` Sets the portlet modes of the portlet.
`void`	`setPortletName(String portletName)` Sets the name of the portlet.
`void`	`setPortletURLClass(String portletURLClass)` Sets the name of the portlet URL class of the portlet.
`void`	`setPreferencesCompanyWide(boolean preferencesCompanyWide)` Set to `true` if preferences are shared across the entire company.
`void`	`setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)` Set to `true` if preferences are owned by the group when the portlet is shown in a group layout.
`void`	`setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)` Set to `true` if preferences are unique per layout.
`void`	`setPreferencesValidator(String preferencesValidator)` Sets the name of the preferences validator class of the portlet.
`void`	`setPrivateRequestAttributes(boolean privateRequestAttributes)` Set to `true` if the portlet does not share request attributes with the portal or portlets from another WAR.
`void`	`setPrivateSessionAttributes(boolean privateSessionAttributes)` Set to `true` if the portlet does not share session attributes with the portal.
`void`	`setProcessingEvents(Set<QName> processingEvents)` Sets the supported processing events of the portlet.
`void`	`setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)` Sets the supported public render parameters of the portlet.
`void`	`setPublishingEvents(Set<QName> publishingEvents)` Sets the supported publishing events of the portlet.
`void`	`setReady(boolean ready)` Set to `true` if the portlet is ready to be used.
`void`	`setRemoteable(boolean remoteable)` Set to `true` if the portlet supports remoting
`void`	`setRenderTimeout(int renderTimeout)` Sets the render timeout of the portlet.
`void`	`setRenderWeight(int renderWeight)` Sets the render weight of the portlet.
`void`	`setResourceBundle(String resourceBundle)` Sets the resource bundle of the portlet.
`void`	`setRestoreCurrentView(boolean restoreCurrentView)` Set to `true` if the portlet restores to the current view from the maximized state.
`void`	`setRoleMappers(Map<String,String> roleMappers)` Sets the role mappers of the portlet.
`void`	`setRoles(String roles)` Sets a string of ordered comma delimited portlet IDs.
`void`	`setRolesArray(String[] rolesArray)` Sets an array of required roles of the portlet.
`void`	`setSchedulerEntries(List<SchedulerEntry> schedulerEntries)` Sets the scheduler entries of the portlet.
`void`	`setScopeable(boolean scopeable)` Set to `true` if the portlet supports scoping of data.
`void`	`setShowPortletAccessDenied(boolean showPortletAccessDenied)` Set to `true` if users are shown that they do not have access to the portlet.
`void`	`setShowPortletInactive(boolean showPortletInactive)` Set to `true` if users are shown that the portlet is inactive.
`void`	`setSocialActivityInterpreterClass(String socialActivityInterpreterClass)` Sets the name of the social activity interpreter class of the portlet.
`void`	`setSocialRequestInterpreterClass(String socialRequestInterpreterClass)` Sets the name of the social request interpreter class of the portlet.
`void`	`setStatic(boolean staticPortlet)` Set to `true` if the portlet is a static portlet that is cannot be moved.
`void`	`setStaticStart(boolean staticPortletStart)` Set to `true` if the portlet is a static portlet at the start of a list of portlets.
`void`	`setStrutsPath(String strutsPath)` Sets the struts path of the portlet.
`void`	`setSupportedLocales(Set<String> supportedLocales)` Sets the supported locales of the portlet.
`void`	`setSystem(boolean system)` Set to `true` if the portlet is a system portlet that a user cannot manually add to their page.
`void`	`setTimestamp(long timestamp)` Sets the timestamp of the portlet.
`void`	`setUndeployedPortlet(boolean undeployedPortlet)` Set to `true` if the portlet is an undeployed portlet.
`void`	`setUnlinkedRoles(Set<String> unlinkedRoles)` Sets the unlinked roles of the portlet.
`void`	`setURLEncoderClass(String urlEncoderClass)` Sets the name of the URL encoder class of the portlet.
`void`	`setUseDefaultTemplate(boolean useDefaultTemplate)` Set to `true` if the portlet uses the default template.
`void`	`setUserPrincipalStrategy(String userPrincipalStrategy)` Sets the user principal strategy of the portlet.
`void`	`setVirtualPath(String virtualPath)` Sets the virtual path of the portlet.
`void`	`setWebDAVStorageClass(String webDAVStorageClass)` Sets the name of the WebDAV storage class of the portlet.
`void`	`setWebDAVStorageToken(String webDAVStorageToken)` Sets the name of the WebDAV storage token of the portlet.
`void`	`setWindowStates(Map<String,Set<String>> windowStates)` Sets the window states of the portlet.
`void`	`setWorkflowHandlerClasses(List<String> workflowHandlerClasses)` Sets the name of the classes that represent workflow handlers associated to the portlet.
`void`	`setXmlRpcMethodClass(String xmlRpcMethodClass)` Sets the name of the XML-RPC method class of the portlet.

Methods inherited from class com.liferay.portal.model.impl.PortletBaseImpl
`persist`

Methods inherited from class com.liferay.portal.model.impl.PortletModelImpl
`getActive, getColumnBitmask, getCompanyId, getExpandoBridge, getId, getModelAttributes, getModelClass, getModelClassName, getOriginalCompanyId, getOriginalPortletId, getPortletId, getPrimaryKey, getPrimaryKeyObj, getRoles, hashCode, isActive, resetOriginalValues, setActive, setCompanyId, setExpandoBridgeAttributes, setId, setModelAttributes, setPortletId, setPrimaryKey, setPrimaryKeyObj, toCacheModel, toEscapedModel, toModel, toModels, toString, toUnescapedModel, toXmlString`

Methods inherited from class com.liferay.portal.model.impl.PortletModelImpl

getActive, getColumnBitmask, getCompanyId, getExpandoBridge, getId, getModelAttributes, getModelClass, getModelClassName, getOriginalCompanyId, getOriginalPortletId, getPortletId, getPrimaryKey, getPrimaryKeyObj, getRoles, hashCode, isActive, resetOriginalValues, setActive, setCompanyId, setExpandoBridgeAttributes, setId, setModelAttributes, setPortletId, setPrimaryKey, setPrimaryKeyObj, toCacheModel, toEscapedModel, toModel, toModels, toString, toUnescapedModel, toXmlString

Methods inherited from class com.liferay.portal.model.impl.BaseModelImpl
`getLocale, isCachedModel, isEscapedModel, isNew, setCachedModel, setNew`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface com.liferay.portal.model.PortletModel
`getActive, getCompanyId, getExpandoBridge, getId, getPortletId, getPrimaryKey, getPrimaryKeyObj, getRoles, hashCode, isActive, isCachedModel, isEscapedModel, isNew, setActive, setCachedModel, setCompanyId, setExpandoBridgeAttributes, setId, setNew, setPortletId, setPrimaryKey, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString`

Methods inherited from interface com.liferay.portal.model.BaseModel
`getModelAttributes, resetOriginalValues, setModelAttributes`

Methods inherited from interface com.liferay.portal.model.ClassedModel
`getModelClass, getModelClassName`

Constructor Detail

PortletImpl

public PortletImpl()

Constructs a portlet with no parameters.

PortletImpl

public PortletImpl(long companyId,
                   String portletId)

Constructs a portlet with the specified parameters.

PortletImpl

public PortletImpl(String portletId,
                   Portlet rootPortlet,
                   PluginPackage pluginPackage,
                   PluginSetting pluginSetting,
                   long companyId,
                   long timestamp,
                   String icon,
                   String virtualPath,
                   String strutsPath,
                   String parentStrutsPath,
                   String portletName,
                   String displayName,
                   String portletClass,
                   String configurationActionClass,
                   List<String> indexerClasses,
                   String openSearchClass,
                   List<SchedulerEntry> schedulerEntries,
                   String portletURLClass,
                   String friendlyURLMapperClass,
                   String friendlyURLMapping,
                   String friendlyURLRoutes,
                   String urlEncoderClass,
                   String portletDataHandlerClass,
                   String portletLayoutListenerClass,
                   String pollerProcessorClass,
                   String popMessageListenerClass,
                   String socialActivityInterpreterClass,
                   String socialRequestInterpreterClass,
                   String webDAVStorageToken,
                   String webDAVStorageClass,
                   String xmlRpcMethodClass,
                   String controlPanelEntryCategory,
                   double controlPanelEntryWeight,
                   String controlPanelClass,
                   List<String> assetRendererFactoryClasses,
                   List<String> atomCollectionAdapterClasses,
                   List<String> customAttributesDisplayClasses,
                   String permissionPropagatorClass,
                   List<String> workflowHandlerClasses,
                   String defaultPreferences,
                   String preferencesValidator,
                   boolean preferencesCompanyWide,
                   boolean preferencesUniquePerLayout,
                   boolean preferencesOwnedByGroup,
                   boolean useDefaultTemplate,
                   boolean showPortletAccessDenied,
                   boolean showPortletInactive,
                   boolean actionURLRedirect,
                   boolean restoreCurrentView,
                   boolean maximizeEdit,
                   boolean maximizeHelp,
                   boolean popUpPrint,
                   boolean layoutCacheable,
                   boolean instanceable,
                   boolean remoteable,
                   boolean scopeable,
                   String userPrincipalStrategy,
                   boolean privateRequestAttributes,
                   boolean privateSessionAttributes,
                   Set<String> autopropagatedParameters,
                   int actionTimeout,
                   int renderTimeout,
                   int renderWeight,
                   boolean ajaxable,
                   List<String> headerPortalCss,
                   List<String> headerPortletCss,
                   List<String> headerPortalJavaScript,
                   List<String> headerPortletJavaScript,
                   List<String> footerPortalCss,
                   List<String> footerPortletCss,
                   List<String> footerPortalJavaScript,
                   List<String> footerPortletJavaScript,
                   String cssClassWrapper,
                   String facebookIntegration,
                   boolean addDefaultResource,
                   String roles,
                   Set<String> unlinkedRoles,
                   Map<String,String> roleMappers,
                   boolean system,
                   boolean active,
                   boolean include,
                   Map<String,String> initParams,
                   Integer expCache,
                   Map<String,Set<String>> portletModes,
                   Map<String,Set<String>> windowStates,
                   Set<String> supportedLocales,
                   String resourceBundle,
                   PortletInfo portletInfo,
                   Map<String,PortletFilter> portletFilters,
                   Set<QName> processingEvents,
                   Set<QName> publishingEvents,
                   Set<PublicRenderParameter> publicRenderParameters,
                   PortletApp portletApp)

Constructs a portlet with the specified parameters.

Method Detail

addProcessingEvent

public void addProcessingEvent(QName processingEvent)

Adds a supported processing event.

addPublicRenderParameter

public void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)

Adds a supported public render parameter.

Parameters:: publicRenderParameter - a supported public render parameter

addPublishingEvent

public void addPublishingEvent(QName publishingEvent)

Adds a supported publishing event.

addSchedulerEntry

public void addSchedulerEntry(SchedulerEntry schedulerEntry)

Adds a scheduler entry.

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
Specified by:: clone in interface PortletModel
Overrides:: clone in class PortletModelImpl

Returns:: a copy of this object

compareTo

public int compareTo(Portlet portlet)

Compares this portlet to the specified object.

Specified by:: compareTo in interface Portlet
Specified by:: compareTo in interface PortletModel
Specified by:: compareTo in interface Comparable<Portlet>
Overrides:: compareTo in class PortletModelImpl

Parameters:: portlet - the portlet to compare this portlet against
Returns:: the value 0 if the argument portlet is equal to this portlet; a value less than -1 if this portlet is less than the portlet argument; and 1 if this portlet is greater than the portlet argument

equals

public boolean equals(Object obj)

Checks whether this portlet is equal to the specified object.

Specified by:: equals in interface Portlet
Overrides:: equals in class PortletModelImpl

Parameters:: obj - the object to compare this portlet against
Returns:: true if the portlet is equal to the specified object

getActionTimeout

public int getActionTimeout()

Returns the action timeout of the portlet.

Returns:: the action timeout of the portlet

getActionURLRedirect

public boolean getActionURLRedirect()

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

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

getAddDefaultResource

public boolean getAddDefaultResource()

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

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

getAjaxable

public boolean getAjaxable()

Returns true if the portlet can be displayed via Ajax.

Returns:: true if the portlet can be displayed via Ajax

getAllPortletModes

public Set<String> getAllPortletModes()

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

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

getAllWindowStates

public Set<String> getAllWindowStates()

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

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

getAssetRendererFactoryClasses

public List<String> getAssetRendererFactoryClasses()

Returns the names of the classes that represent asset types associated with the portlet.

Returns:: the names of the classes that represent asset types associated with the portlet

getAssetRendererFactoryInstances

public List<AssetRendererFactory> getAssetRendererFactoryInstances()

Returns the asset type instances of the portlet.

Returns:: the asset type instances of the portlet

getAtomCollectionAdapterClasses

public List<String> getAtomCollectionAdapterClasses()

Returns the names of the classes that represent atom collection adapters associated with the portlet.

Returns:: the names of the classes that represent atom collection adapters associated with the portlet

getAtomCollectionAdapterInstances

public List<AtomCollectionAdapter<?>> getAtomCollectionAdapterInstances()

Returns the atom collection adapter instances of the portlet.

Returns:: the atom collection adapter instances of the portlet

getAutopropagatedParameters

public Set<String> getAutopropagatedParameters()

Returns the names of the parameters that will be automatically propagated through the portlet.

Returns:: the names of the parameters that will be automatically propagated through the portlet

getClonedInstance

public Portlet getClonedInstance(String portletId)

Returns true if the portlet is found in a WAR file.

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

getConfigurationActionClass

public String getConfigurationActionClass()

Returns the configuration action class of the portlet.

Returns:: the configuration action class of the portlet

getConfigurationActionInstance

public ConfigurationAction getConfigurationActionInstance()

Returns the configuration action instance of the portlet.

Returns:: the configuration action instance of the portlet

getContextPath

public String getContextPath()

Returns the servlet context path of the portlet.

Returns:: the servlet context path of the portlet

getControlPanelEntryCategory

public String getControlPanelEntryCategory()

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

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

getControlPanelEntryClass

public String getControlPanelEntryClass()

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

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

getControlPanelEntryInstance

public ControlPanelEntry getControlPanelEntryInstance()

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

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

getControlPanelEntryWeight

public double getControlPanelEntryWeight()

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

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

getCssClassWrapper

public String getCssClassWrapper()

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

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

getCustomAttributesDisplayClasses

public List<String> getCustomAttributesDisplayClasses()

Returns the names of the classes that represent custom attribute displays associated with the portlet.

Returns:: the names of the classes that represent asset types associated with the portlet

getCustomAttributesDisplayInstances

public List<CustomAttributesDisplay> getCustomAttributesDisplayInstances()

Returns the custom attribute display instances of the portlet.

Returns:: the custom attribute display instances of the portlet

getDefaultPluginSetting

public PluginSetting getDefaultPluginSetting()

Get the default plugin settings of the portlet.

Returns:: the plugin settings

getDefaultPreferences

public String getDefaultPreferences()

Returns the default preferences of the portlet.

Returns:: the default preferences of the portlet

getDisplayName

public String getDisplayName()

Returns the display name of the portlet.

Returns:: the display name of the portlet

getExpCache

public Integer getExpCache()

Returns expiration cache of the portlet.

Returns:: expiration cache of the portlet

getFacebookIntegration

public String getFacebookIntegration()

Returns the Facebook integration method of the portlet.

Returns:: the Facebook integration method of the portlet

getFooterPortalCss

public List<String> getFooterPortalCss()

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

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

getFooterPortalJavaScript

public List<String> getFooterPortalJavaScript()

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

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

getFooterPortletCss

public List<String> getFooterPortletCss()

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

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

getFooterPortletJavaScript

public List<String> getFooterPortletJavaScript()

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

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

getFriendlyURLMapperClass

public String getFriendlyURLMapperClass()

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

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

getFriendlyURLMapperInstance

public FriendlyURLMapper getFriendlyURLMapperInstance()

Returns the friendly URL mapper instance of the portlet.

Returns:: the friendly URL mapper instance of the portlet

getFriendlyURLMapping

public String getFriendlyURLMapping()

Returns the name of the friendly URL mapping of the portlet.

Returns:: the name of the friendly URL mapping of the portlet

getFriendlyURLRoutes

public String getFriendlyURLRoutes()

Returns the class loader resource path to the friendly URL routes of the portlet.

Returns:: the class loader resource path to the friendly URL routes of the portlet

getHeaderPortalCss

public List<String> getHeaderPortalCss()

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

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

getHeaderPortalJavaScript

public List<String> getHeaderPortalJavaScript()

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

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

getHeaderPortletCss

public List<String> getHeaderPortletCss()

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

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

getHeaderPortletJavaScript

public List<String> getHeaderPortletJavaScript()

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

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

getIcon

public String getIcon()

Returns the icon of the portlet.

Returns:: the icon of the portlet

getInclude

public boolean getInclude()

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

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

getIndexerClasses

public List<String> getIndexerClasses()

Returns the name of the classes that represent indexers associated with the portlet.

Returns:: the name of the classes that represent indexers associated with the portlet

getIndexerInstances

public List<Indexer> getIndexerInstances()

Returns the indexer instances of the portlet.

Returns:: the indexer instances of the portlet

getInitParams

public Map<String,String> getInitParams()

Returns the init parameters of the portlet.

Returns:: init parameters of the portlet

getInstanceable

public boolean getInstanceable()

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

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

getInstanceId

public String getInstanceId()

Returns the instance ID of the portlet.

Returns:: the instance ID of the portlet

getLayoutCacheable

public boolean getLayoutCacheable()

Returns true to allow the portlet to be cached within the layout.

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

getMaximizeEdit

public boolean getMaximizeEdit()

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

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

getMaximizeHelp

public boolean getMaximizeHelp()

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

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

getOpenSearchClass

public String getOpenSearchClass()

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

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

getOpenSearchInstance

public OpenSearch getOpenSearchInstance()

Returns the indexer instance of the portlet.

Returns:: the indexer instance of the portlet

getParentStrutsPath

public String getParentStrutsPath()

Returns the parent struts path of the portlet.

Returns:: the parent struts path of the portlet.

getPermissionPropagatorClass

public String getPermissionPropagatorClass()

Returns the name of the permission propagator class of the portlet.

Returns:: the name of the permission propagator class of the portlet

getPermissionPropagatorInstance

public PermissionPropagator getPermissionPropagatorInstance()

Returns the permission propagator instance of the portlet.

Returns:: the permission propagator instance of the portlet

getPluginId

public String getPluginId()

Returns the plugin ID of the portlet.

Returns:: the plugin ID of the portlet

getPluginPackage

public PluginPackage getPluginPackage()

Returns this portlet's plugin package.

Returns:: this portlet's plugin package

getPluginType

public String getPluginType()

Returns the plugin type of the portlet.

Returns:: the plugin type of the portlet

getPollerProcessorClass

public String getPollerProcessorClass()

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

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

getPollerProcessorInstance

public PollerProcessor getPollerProcessorInstance()

Returns the poller processor instance of the portlet.

Returns:: the poller processor instance of the portlet

getPopMessageListenerClass

public String getPopMessageListenerClass()

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

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

getPopMessageListenerInstance

public MessageListener getPopMessageListenerInstance()

Returns the POP message listener instance of the portlet.

Returns:: the POP message listener instance of the portlet

getPopUpPrint

public boolean getPopUpPrint()

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

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

getPortletApp

public PortletApp getPortletApp()

Returns this portlet's application.

Returns:: this portlet's application

getPortletClass

public String getPortletClass()

Returns the name of the portlet class of the portlet.

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

getPortletDataHandlerClass

public String getPortletDataHandlerClass()

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

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

getPortletDataHandlerInstance

public PortletDataHandler getPortletDataHandlerInstance()

Returns the portlet data handler instance of the portlet.

Returns:: the portlet data handler instance of the portlet

getPortletFilters

public Map<String,PortletFilter> getPortletFilters()

Returns the filters of the portlet.

Returns:: filters of the portlet

getPortletInfo

public PortletInfo getPortletInfo()

Returns the portlet info of the portlet.

Returns:: portlet info of the portlet

getPortletLayoutListenerClass

public String getPortletLayoutListenerClass()

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

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

getPortletLayoutListenerInstance

public PortletLayoutListener getPortletLayoutListenerInstance()

Returns the portlet layout listener instance of the portlet.

Returns:: the portlet layout listener instance of the portlet

getPortletModes

public Map<String,Set<String>> getPortletModes()

Returns the portlet modes of the portlet.

Returns:: portlet modes of the portlet

getPortletName

public String getPortletName()

Returns the name of the portlet.

Returns:: the display name of the portlet

getPortletURLClass

public String getPortletURLClass()

Returns the name of the portlet URL class of the portlet.

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

getPreferencesCompanyWide

public boolean getPreferencesCompanyWide()

Returns true if preferences are shared across the entire company.

Returns:: true if preferences are shared across the entire company

getPreferencesOwnedByGroup

public boolean getPreferencesOwnedByGroup()

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

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

getPreferencesUniquePerLayout

public boolean getPreferencesUniquePerLayout()

Returns true if preferences are unique per layout.

Returns:: true if preferences are unique per layout

getPreferencesValidator

public String getPreferencesValidator()

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

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

getPrivateRequestAttributes

public boolean getPrivateRequestAttributes()

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

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

getPrivateSessionAttributes

public boolean getPrivateSessionAttributes()

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

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

getProcessingEvent

public QName getProcessingEvent(String uri,
                                String localPart)

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

Parameters:: uri - the namespace URI; localPart - the local part
Returns:: the supported processing event from a namespace URI and a local part

getProcessingEvents

public Set<QName> getProcessingEvents()

Returns the supported processing events of the portlet.

Returns:: supported processing events of the portlet

getPublicRenderParameter

public PublicRenderParameter getPublicRenderParameter(String identifier)

Returns the supported public render parameter from an identifier.

Parameters:: identifier - the identifier
Returns:: the supported public render parameter from an identifier

getPublicRenderParameter

public PublicRenderParameter getPublicRenderParameter(String uri,
                                                      String localPart)

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

Parameters:: uri - the namespace URI; localPart - the local part
Returns:: the supported public render parameter from a namespace URI and a local part

getPublicRenderParameters

public Set<PublicRenderParameter> getPublicRenderParameters()

Returns the supported public render parameters of the portlet.

Returns:: the supported public render parameters of the portlet

getPublishingEvents

public Set<QName> getPublishingEvents()

Returns the supported publishing events of the portlet.

Returns:: supported publishing events of the portlet

getReady

public boolean getReady()

Returns true if the portlet is ready to be used.

Returns:: true if the portlet is ready to be used

getRemoteable

public boolean getRemoteable()

Returns true if the portlet supports remoting.

Returns:: true if the portlet supports remoting

getRenderTimeout

public int getRenderTimeout()

Returns the render timeout of the portlet.

Returns:: the render timeout of the portlet

getRenderWeight

public int getRenderWeight()

Returns the render weight of the portlet.

Returns:: the render weight of the portlet

getResourceBundle

public String getResourceBundle()

Returns the resource bundle of the portlet.

Returns:: resource bundle of the portlet

getRestoreCurrentView

public boolean getRestoreCurrentView()

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

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

getRoleMappers

public Map<String,String> getRoleMappers()

Returns the role mappers of the portlet.

Returns:: role mappers of the portlet

getRolesArray

public String[] getRolesArray()

Returns an array of required roles of the portlet.

Returns:: an array of required roles of the portlet

getRootPortlet

public Portlet getRootPortlet()

Returns the root portlet of this portlet instance.

Returns:: the root portlet of this portlet instance

getRootPortletId

public String getRootPortletId()

Returns the root portlet ID of the portlet.

Returns:: the root portlet ID of the portlet

getSchedulerEntries

public List<SchedulerEntry> getSchedulerEntries()

Returns the scheduler entries of the portlet.

Returns:: the scheduler entries of the portlet

getScopeable

public boolean getScopeable()

Returns true if the portlet supports scoping of data.

Returns:: true if the portlet supports scoping of data

getShowPortletAccessDenied

public boolean getShowPortletAccessDenied()

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

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

getShowPortletInactive

public boolean getShowPortletInactive()

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

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

getSocialActivityInterpreterClass

public String getSocialActivityInterpreterClass()

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

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

getSocialActivityInterpreterInstance

public SocialActivityInterpreter getSocialActivityInterpreterInstance()

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

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

getSocialRequestInterpreterClass

public String getSocialRequestInterpreterClass()

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

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

getSocialRequestInterpreterInstance

public 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

getStatic

public boolean getStatic()

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

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

getStaticEnd

public boolean getStaticEnd()

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

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

getStaticResourcePath

public String getStaticResourcePath()

Returns the path for static resources served by this portlet.

Returns:: the path for static resources served by this portlet

getStaticStart

public boolean getStaticStart()

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

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

getStrutsPath

public String getStrutsPath()

Returns the struts path of the portlet.

Returns:: the struts path of the portlet

getSupportedLocales

public Set<String> getSupportedLocales()

Returns the supported locales of the portlet.

Returns:: supported locales of the portlet

getSystem

public boolean getSystem()

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

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

getTimestamp

public long getTimestamp()

Returns the timestamp of the portlet.

Returns:: the timestamp of the portlet

getUndeployedPortlet

public boolean getUndeployedPortlet()

Returns true if the portlet is an undeployed portlet.

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

getUnlinkedRoles

public Set<String> getUnlinkedRoles()

Returns the unlinked roles of the portlet.

Returns:: unlinked roles of the portlet

getURLEncoderClass

public String getURLEncoderClass()

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

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

getURLEncoderInstance

public URLEncoder getURLEncoderInstance()

Returns the URL encoder instance of the portlet.

Returns:: the URL encoder instance of the portlet

getUseDefaultTemplate

public boolean getUseDefaultTemplate()

Returns true if the portlet uses the default template.

Returns:: true if the portlet uses the default template

getUserPrincipalStrategy

public String getUserPrincipalStrategy()

Returns the user principal strategy of the portlet.

Returns:: the user principal strategy of the portlet

getVirtualPath

public String getVirtualPath()

Returns the virtual path of the portlet.

Returns:: the virtual path of the portlet

getWebDAVStorageClass

public String getWebDAVStorageClass()

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

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

getWebDAVStorageInstance

public WebDAVStorage getWebDAVStorageInstance()

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

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

getWebDAVStorageToken

public String getWebDAVStorageToken()

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

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

getWindowStates

public Map<String,Set<String>> getWindowStates()

Returns the window states of the portlet.

Returns:: window states of the portlet

getWorkflowHandlerClasses

public List<String> getWorkflowHandlerClasses()

Returns the names of the classes that represent workflow handlers associated with the portlet.

Returns:: the names of the classes that represent workflow handlers associated with the portlet

getWorkflowHandlerInstances

public List<WorkflowHandler> getWorkflowHandlerInstances()

Returns the workflow handler instances of the portlet.

Returns:: the workflow handler instances of the portlet

getXmlRpcMethodClass

public String getXmlRpcMethodClass()

Returns the name of the XML-RPC method class of the portlet.

Returns:: the name of the XML-RPC method class of the portlet

getXmlRpcMethodInstance

public Method getXmlRpcMethodInstance()

Returns the name of the XML-RPC method instance of the portlet.

Returns:: the name of the XML-RPC method instance of the portlet

hasAddPortletPermission

public boolean hasAddPortletPermission(long userId)

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

Parameters:: userId - the primary key of the user
Returns:: true if the user has the permission to add the portlet to a layout

hasMultipleMimeTypes

public boolean hasMultipleMimeTypes()

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

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

hasPortletMode

public boolean hasPortletMode(String mimeType,
                              PortletMode portletMode)

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

Parameters:: mimeType - the mime type; portletMode - the portlet mode
Returns:: true if the portlet supports the specified mime type and portlet mode

hasRoleWithName

public boolean hasRoleWithName(String roleName)

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

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

hasWindowState

public boolean hasWindowState(String mimeType,
                              WindowState windowState)

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

Parameters:: mimeType - the mime type; windowState - the window state
Returns:: true if the portlet supports the specified mime type and window state

isActionURLRedirect

public boolean isActionURLRedirect()

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

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

isAddDefaultResource

public boolean isAddDefaultResource()

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

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

isAjaxable

public boolean isAjaxable()

Returns true if the portlet can be displayed via Ajax.

Returns:: true if the portlet can be displayed via Ajax

isInclude

public boolean isInclude()

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

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

isInstanceable

public boolean isInstanceable()

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

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

isLayoutCacheable

public boolean isLayoutCacheable()

Returns true to allow the portlet to be cached within the layout.

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

isMaximizeEdit

public boolean isMaximizeEdit()

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

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

isMaximizeHelp

public boolean isMaximizeHelp()

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

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

isPopUpPrint

public boolean isPopUpPrint()

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

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

isPreferencesCompanyWide

public boolean isPreferencesCompanyWide()

Returns true if preferences are shared across the entire company.

Returns:: true if preferences are shared across the entire company

isPreferencesOwnedByGroup

public boolean isPreferencesOwnedByGroup()

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

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

isPreferencesUniquePerLayout

public boolean isPreferencesUniquePerLayout()

Returns true if preferences are unique per layout.

Returns:: true if preferences are unique per layout

isPrivateRequestAttributes

public boolean isPrivateRequestAttributes()

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

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

isPrivateSessionAttributes

public boolean isPrivateSessionAttributes()

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

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

isReady

public boolean isReady()

Returns true if the portlet is ready to be used.

Returns:: true if the portlet is ready to be used

isRemoteable

public boolean isRemoteable()

Returns true if the portlet supports remoting.

Returns:: true if the portlet supports remoting

isRestoreCurrentView

public boolean isRestoreCurrentView()

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

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

isScopeable

public boolean isScopeable()

Returns true if the portlet supports scoping of data.

Returns:: true if the portlet supports scoping of data

isShowPortletAccessDenied

public boolean isShowPortletAccessDenied()

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

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

isShowPortletInactive

public boolean isShowPortletInactive()

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

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

isStatic

public boolean isStatic()

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

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

isStaticEnd

public boolean isStaticEnd()

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

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

isStaticStart

public boolean isStaticStart()

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

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

isSystem

public boolean isSystem()

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

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

isUndeployedPortlet

public boolean isUndeployedPortlet()

Returns true if the portlet is an undeployed portlet.

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

isUseDefaultTemplate

public boolean isUseDefaultTemplate()

Returns true if the portlet uses the default template.

Returns:: true if the portlet uses the default template

linkRoles

public void linkRoles()

Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml.

setActionTimeout

public void setActionTimeout(int actionTimeout)

Sets the action timeout of the portlet.

Parameters:: actionTimeout - the action timeout of the portlet

setActionURLRedirect

public void setActionURLRedirect(boolean actionURLRedirect)

Set to true if an action URL for this portlet should cause an auto redirect.

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

setAddDefaultResource

public void setAddDefaultResource(boolean addDefaultResource)

Set to true if default resources for the portlet are added to a page.

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

setAjaxable

public void setAjaxable(boolean ajaxable)

Set to true if the portlet can be displayed via Ajax.

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

setAssetRendererFactoryClasses

public void setAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses)

Sets the name 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

setAtomCollectionAdapterClasses

public void setAtomCollectionAdapterClasses(List<String> atomCollectionAdapterClasses)

Sets the name of the classes that represent atom collection adapters associated with the portlet.

Parameters:: atomCollectionAdapterClasses - the names of the classes that represent atom collection adapters associated with the portlet

setAutopropagatedParameters

public void setAutopropagatedParameters(Set<String> autopropagatedParameters)

Sets the names of the parameters that will be automatically propagated through the portlet.

Parameters:: autopropagatedParameters - the names of the parameters that will be automatically propagated through the portlet

setConfigurationActionClass

public void setConfigurationActionClass(String configurationActionClass)

Sets the configuration action class of the portlet.

Parameters:: configurationActionClass - the configuration action class of the portlet

setControlPanelEntryCategory

public void setControlPanelEntryCategory(String controlPanelEntryCategory)

Set the name of the category of the Control Panel where the portlet will be shown.

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

setControlPanelEntryClass

public void setControlPanelEntryClass(String controlPanelEntryClass)

Sets the name of the class that will control when the portlet will be shown in the Control Panel.

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

setControlPanelEntryWeight

public void setControlPanelEntryWeight(double controlPanelEntryWeight)

Sets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.

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

setCssClassWrapper

public void setCssClassWrapper(String cssClassWrapper)

Sets the name of the CSS class that will be injected in the DIV that wraps this portlet.

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

setCustomAttributesDisplayClasses

public void setCustomAttributesDisplayClasses(List<String> customAttributesDisplayClasses)

Sets the name of the classes that represent custom attribute displays associated with the portlet.

Parameters:: customAttributesDisplayClasses - the names of the classes that represent custom attribute displays associated with the portlet

setDefaultPluginSetting

public void setDefaultPluginSetting(PluginSetting pluginSetting)

Sets the default plugin settings of the portlet.

Parameters:: pluginSetting - the plugin setting

setDefaultPreferences

public void setDefaultPreferences(String defaultPreferences)

Sets the default preferences of the portlet.

Parameters:: defaultPreferences - the default preferences of the portlet

setDisplayName

public void setDisplayName(String displayName)

Sets the display name of the portlet.

Parameters:: displayName - the display name of the portlet

setExpCache

public void setExpCache(Integer expCache)

Sets expiration cache of the portlet.

Parameters:: expCache - expiration cache of the portlet

setFacebookIntegration

public void setFacebookIntegration(String facebookIntegration)

Sets the Facebook integration method of the portlet.

Parameters:: facebookIntegration - the Facebook integration method of the portlet

setFooterPortalCss

public void setFooterPortalCss(List<String> footerPortalCss)

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

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

setFooterPortalJavaScript

public void setFooterPortalJavaScript(List<String> footerPortalJavaScript)

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

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

setFooterPortletCss

public void setFooterPortletCss(List<String> footerPortletCss)

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

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

setFooterPortletJavaScript

public void setFooterPortletJavaScript(List<String> footerPortletJavaScript)

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

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

setFriendlyURLMapperClass

public void setFriendlyURLMapperClass(String friendlyURLMapperClass)

Sets the name of the friendly URL mapper class of the portlet.

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

setFriendlyURLMapping

public void setFriendlyURLMapping(String friendlyURLMapping)

Sets the name of the friendly URL mapping of the portlet.

Parameters:: friendlyURLMapping - the name of the friendly URL mapping of the portlet

setFriendlyURLRoutes

public void setFriendlyURLRoutes(String friendlyURLRoutes)

Sets the class loader resource path to the friendly URL routes of the portlet.

Parameters:: friendlyURLRoutes - the class loader resource path to the friendly URL routes of the portlet

setHeaderPortalCss

public void setHeaderPortalCss(List<String> headerPortalCss)

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

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

setHeaderPortalJavaScript

public void setHeaderPortalJavaScript(List<String> headerPortalJavaScript)

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

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

setHeaderPortletCss

public void setHeaderPortletCss(List<String> headerPortletCss)

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

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

setHeaderPortletJavaScript

public void setHeaderPortletJavaScript(List<String> headerPortletJavaScript)

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

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

setIcon

public void setIcon(String icon)

Sets the icon of the portlet.

Parameters:: icon - the icon of the portlet

setInclude

public void setInclude(boolean include)

Set to true to include the portlet and make it available to be made active.

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

setIndexerClasses

public void setIndexerClasses(List<String> indexerClasses)

Sets the name of the classes that represent indexers associated with the portlet.

Parameters:: indexerClasses - the name of the classes that represent indexers associated with the portlet

setInitParams

public void setInitParams(Map<String,String> initParams)

Sets the init parameters of the portlet.

Parameters:: initParams - the init parameters of the portlet

setInstanceable

public void setInstanceable(boolean instanceable)

Set to true if the portlet can be added multiple times to a layout.

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

setLayoutCacheable

public void setLayoutCacheable(boolean layoutCacheable)

Set to true to allow the portlet to be cached within the layout.

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

setMaximizeEdit

public void setMaximizeEdit(boolean maximizeEdit)

Set to true if the portlet goes into the maximized state when the user goes into the edit mode.

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

setMaximizeHelp

public void setMaximizeHelp(boolean maximizeHelp)

Set to true if the portlet goes into the maximized state when the user goes into the help mode.

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

setOpenSearchClass

public void setOpenSearchClass(String openSearchClass)

Sets the name of the open search class of the portlet.

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

setParentStrutsPath

public void setParentStrutsPath(String parentStrutsPath)

Sets the parent struts path of the portlet.

Parameters:: parentStrutsPath - the parent struts path of the portlet

setPermissionPropagatorClass

public void setPermissionPropagatorClass(String permissionPropagatorClass)

Sets the name of the permission propagator class of the portlet.

setPluginPackage

public void setPluginPackage(PluginPackage pluginPackage)

Sets this portlet's plugin package.

Parameters:: pluginPackage - this portlet's plugin package

setPollerProcessorClass

public void setPollerProcessorClass(String pollerProcessorClass)

Sets the name of the poller processor class of the portlet.

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

setPopMessageListenerClass

public void setPopMessageListenerClass(String popMessageListenerClass)

Sets the name of the POP message listener class of the portlet.

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

setPopUpPrint

public void setPopUpPrint(boolean popUpPrint)

Set to true if the portlet goes into the pop up state when the user goes into the print mode.

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

setPortletApp

public void setPortletApp(PortletApp portletApp)

Sets this portlet's application.

Parameters:: portletApp - this portlet's application

setPortletClass

public void setPortletClass(String portletClass)

Sets the name of the portlet class of the portlet.

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

setPortletDataHandlerClass

public void setPortletDataHandlerClass(String portletDataHandlerClass)

Sets the name of the portlet data handler class of the portlet.

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

setPortletFilters

public void setPortletFilters(Map<String,PortletFilter> portletFilters)

Sets the filters of the portlet.

Parameters:: portletFilters - the filters of the portlet

setPortletInfo

public void setPortletInfo(PortletInfo portletInfo)

Sets the portlet info of the portlet.

Parameters:: portletInfo - the portlet info of the portlet

setPortletLayoutListenerClass

public void setPortletLayoutListenerClass(String portletLayoutListenerClass)

Sets the name of the portlet layout listener class of the portlet.

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

setPortletModes

public void setPortletModes(Map<String,Set<String>> portletModes)

Sets the portlet modes of the portlet.

Parameters:: portletModes - the portlet modes of the portlet

setPortletName

public void setPortletName(String portletName)

Sets the name of the portlet.

Parameters:: portletName - the name of the portlet

setPortletURLClass

public void setPortletURLClass(String portletURLClass)

Sets the name of the portlet URL class of the portlet.

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

setPreferencesCompanyWide

public void setPreferencesCompanyWide(boolean preferencesCompanyWide)

Set to true if preferences are shared across the entire company.

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

setPreferencesOwnedByGroup

public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)

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

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

setPreferencesUniquePerLayout

public void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)

Set to true if preferences are unique per layout.

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

setPreferencesValidator

public void setPreferencesValidator(String preferencesValidator)

Sets the name of the preferences validator class of the portlet.

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

setPrivateRequestAttributes

public void setPrivateRequestAttributes(boolean privateRequestAttributes)

Set to true if the portlet does not share request attributes with the portal or portlets from another WAR.

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

setPrivateSessionAttributes

public void setPrivateSessionAttributes(boolean privateSessionAttributes)

Set to true if the portlet does not share session attributes with the portal.

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

setProcessingEvents

public void setProcessingEvents(Set<QName> processingEvents)

Sets the supported processing events of the portlet.

Parameters:: processingEvents - the supported processing events of the portlet

setPublicRenderParameters

public void setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)

Sets the supported public render parameters of the portlet.

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

setPublishingEvents

public void setPublishingEvents(Set<QName> publishingEvents)

Sets the supported publishing events of the portlet.

Parameters:: publishingEvents - the supported publishing events of the portlet

setReady

public void setReady(boolean ready)

Set to true if the portlet is ready to be used.

Parameters:: ready - whether the portlet is ready to be used

setRemoteable

public void setRemoteable(boolean remoteable)

Set to true if the portlet supports remoting

Parameters:: remoteable - boolean value for whether or not the the portlet supports remoting

setRenderTimeout

public void setRenderTimeout(int renderTimeout)

Sets the render timeout of the portlet.

Parameters:: renderTimeout - the render timeout of the portlet

setRenderWeight

public void setRenderWeight(int renderWeight)

Sets the render weight of the portlet.

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

setResourceBundle

public void setResourceBundle(String resourceBundle)

Sets the resource bundle of the portlet.

Parameters:: resourceBundle - the resource bundle of the portlet

setRestoreCurrentView

public void setRestoreCurrentView(boolean restoreCurrentView)

Set to true if the portlet restores to the current view from the maximized state.

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

setRoleMappers

public void setRoleMappers(Map<String,String> roleMappers)

Sets the role mappers of the portlet.

Parameters:: roleMappers - the role mappers of the portlet

setRoles

public void setRoles(String roles)

Sets a string of ordered comma delimited portlet IDs.

Specified by:: setRoles in interface Portlet
Specified by:: setRoles in interface PortletModel
Overrides:: setRoles in class PortletModelImpl

Parameters:: roles - a string of ordered comma delimited portlet IDs

setRolesArray

public void setRolesArray(String[] rolesArray)

Sets an array of required roles of the portlet.

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

setSchedulerEntries

public void setSchedulerEntries(List<SchedulerEntry> schedulerEntries)

Sets the scheduler entries of the portlet.

Parameters:: schedulerEntries - the scheduler entries of the portlet

setScopeable

public void setScopeable(boolean scopeable)

Set to true if the portlet supports scoping of data.

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

setShowPortletAccessDenied

public void setShowPortletAccessDenied(boolean showPortletAccessDenied)

Set to true if users are shown that they do not have access to the portlet.

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

setShowPortletInactive

public void setShowPortletInactive(boolean showPortletInactive)

Set to true if users are shown that the portlet is inactive.

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

setSocialActivityInterpreterClass

public void setSocialActivityInterpreterClass(String socialActivityInterpreterClass)

Sets the name of the social activity interpreter class of the portlet.

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

setSocialRequestInterpreterClass

public void setSocialRequestInterpreterClass(String socialRequestInterpreterClass)

Sets the name of the social request interpreter class of the portlet.

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

setStatic

public void setStatic(boolean staticPortlet)

Set to true if the portlet is a static portlet that is cannot be moved.

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

setStaticStart

public void setStaticStart(boolean staticPortletStart)

Set to true if the portlet is a static portlet at the start of a list of portlets.

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

setStrutsPath

public void setStrutsPath(String strutsPath)

Sets the struts path of the portlet.

Parameters:: strutsPath - the struts path of the portlet

setSupportedLocales

public void setSupportedLocales(Set<String> supportedLocales)

Sets the supported locales of the portlet.

Parameters:: supportedLocales - the supported locales of the portlet

setSystem

public void setSystem(boolean system)

Set to true if the portlet is a system portlet that a user cannot manually add to their page.

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

setTimestamp

public void setTimestamp(long timestamp)

Sets the timestamp of the portlet.

Parameters:: timestamp - the timestamp of the portlet

setUndeployedPortlet

public void setUndeployedPortlet(boolean undeployedPortlet)

Set to true if the portlet is an undeployed portlet.

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

setUnlinkedRoles

public void setUnlinkedRoles(Set<String> unlinkedRoles)

Sets the unlinked roles of the portlet.

Parameters:: unlinkedRoles - the unlinked roles of the portlet

setURLEncoderClass

public void setURLEncoderClass(String urlEncoderClass)

Sets the name of the URL encoder class of the portlet.

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

setUseDefaultTemplate

public void setUseDefaultTemplate(boolean useDefaultTemplate)

Set to true if the portlet uses the default template.

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

setUserPrincipalStrategy

public void setUserPrincipalStrategy(String userPrincipalStrategy)

Sets the user principal strategy of the portlet.

Parameters:: userPrincipalStrategy - the user principal strategy of the portlet

setVirtualPath

public void setVirtualPath(String virtualPath)

Sets the virtual path of the portlet.

Parameters:: virtualPath - the virtual path of the portlet

setWebDAVStorageClass

public void setWebDAVStorageClass(String webDAVStorageClass)

Sets the name of the WebDAV storage class of the portlet.

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

setWebDAVStorageToken

public void setWebDAVStorageToken(String webDAVStorageToken)

Sets the name of the WebDAV storage token of the portlet.

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

setWindowStates

public void setWindowStates(Map<String,Set<String>> windowStates)

Sets the window states of the portlet.

Parameters:: windowStates - the window states of the portlet

setWorkflowHandlerClasses

public void setWorkflowHandlerClasses(List<String> workflowHandlerClasses)

Sets the name of the classes that represent workflow handlers associated to the portlet.

Parameters:: workflowHandlerClasses - the names of the classes that represent workflow handlers associated with the portlet

setXmlRpcMethodClass

public void setXmlRpcMethodClass(String xmlRpcMethodClass)

Sets the name of the XML-RPC method class of the portlet.

Parameters:: xmlRpcMethodClass - the name of the XML-RPC method class of the portlet

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.1.2-ce-ga3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.model.impl Class PortletImpl

PortletImpl

PortletImpl

PortletImpl

addProcessingEvent

addPublicRenderParameter

addPublishingEvent

addSchedulerEntry

clone

compareTo

equals

getActionTimeout

getActionURLRedirect

getAddDefaultResource

getAjaxable

getAllPortletModes

getAllWindowStates

getAssetRendererFactoryClasses

getAssetRendererFactoryInstances

getAtomCollectionAdapterClasses

getAtomCollectionAdapterInstances

getAutopropagatedParameters

getClonedInstance

getConfigurationActionClass

getConfigurationActionInstance

getContextPath

getControlPanelEntryCategory

getControlPanelEntryClass

getControlPanelEntryInstance

getControlPanelEntryWeight

getCssClassWrapper

getCustomAttributesDisplayClasses

getCustomAttributesDisplayInstances

getDefaultPluginSetting

getDefaultPreferences

getDisplayName

getExpCache

getFacebookIntegration

getFooterPortalCss

getFooterPortalJavaScript

getFooterPortletCss

getFooterPortletJavaScript

getFriendlyURLMapperClass

getFriendlyURLMapperInstance

getFriendlyURLMapping

getFriendlyURLRoutes

getHeaderPortalCss

getHeaderPortalJavaScript

getHeaderPortletCss

getHeaderPortletJavaScript

getIcon

getInclude

getIndexerClasses

getIndexerInstances

getInitParams

getInstanceable

getInstanceId

getLayoutCacheable

getMaximizeEdit

getMaximizeHelp

getOpenSearchClass

getOpenSearchInstance

getParentStrutsPath

getPermissionPropagatorClass

getPermissionPropagatorInstance

getPluginId

getPluginPackage

getPluginType

getPollerProcessorClass

getPollerProcessorInstance

getPopMessageListenerClass

getPopMessageListenerInstance

getPopUpPrint

getPortletApp

getPortletClass

getPortletDataHandlerClass

getPortletDataHandlerInstance

getPortletFilters

getPortletInfo

getPortletLayoutListenerClass

com.liferay.portal.model.impl
Class PortletImpl