Portlet (Liferay 6.0.5 API)

Never modify this interface directly. Add methods to PortletImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

Never reference this interface directly. All methods that expect a portlet model instance should use the Portlet interface instead.

See Also:: PortletModel, PortletImpl, PortletModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

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.
`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()` Gets a list of all portlet modes supported by the portlet.
`Set<String>`	`getAllWindowStates()` Gets a list of all window states supported by the portlet.
`List<String>`	`getAssetRendererFactoryClasses()` Gets the names of the classes that represent asset types associated to the portlet.
`List<AssetRendererFactory>`	`getAssetRendererFactoryInstances()` Gets the asset type instances of the portlet.
`Portlet`	`getClonedInstance(String portletId)` Returns `true` if the portlet is found in a WAR file.
`String`	`getConfigurationActionClass()` Gets the configuration action class of the portlet.
`ConfigurationAction`	`getConfigurationActionInstance()` Gets the configuration action instance of the portlet.
`String`	`getContextPath()` Gets the servlet context path of the portlet.
`String`	`getControlPanelEntryCategory()` Gets the name of the category of the Control Panel where the portlet will be shown.
`String`	`getControlPanelEntryClass()` Gets the name of the class that will control when the portlet will be shown in the Control Panel.
`ControlPanelEntry`	`getControlPanelEntryInstance()` Gets an instance of the class that will control when the portlet will be shown in the Control Panel.
`double`	`getControlPanelEntryWeight()` Gets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.
`String`	`getCssClassWrapper()` Gets the name of the CSS class that will be injected in the DIV that wraps this portlet.
`List<String>`	`getCustomAttributesDisplayClasses()` Gets the names of the classes that represent custom attribute displays associated to the portlet.
`List<CustomAttributesDisplay>`	`getCustomAttributesDisplayInstances()` Gets the custom attribute display instances of the portlet.
`PluginSetting`	`getDefaultPluginSetting()` Get the default plugin settings of the portlet.
`String`	`getDefaultPreferences()` Gets the default preferences of the portlet.
`String`	`getDisplayName()` Gets the display name of the portlet.
`Integer`	`getExpCache()` Gets expiration cache of the portlet.
`String`	`getFacebookIntegration()` Gets the Facebook integration method of the portlet.
`List<String>`	`getFooterPortalCss()` Gets a list of CSS files that will be referenced from the page's footer relative to the portal's context path.
`List<String>`	`getFooterPortalJavaScript()` Gets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.
`List<String>`	`getFooterPortletCss()` Gets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.
`List<String>`	`getFooterPortletJavaScript()` Gets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.
`String`	`getFriendlyURLMapperClass()` Gets the name of the friendly URL mapper class of the portlet.
`FriendlyURLMapper`	`getFriendlyURLMapperInstance()` Gets the friendly URL mapper instance of the portlet.
`String`	`getFriendlyURLMapping()` Gets the name of the friendly URL mapping of the portlet.
`String`	`getFriendlyURLRoutes()` Gets the class loader resource path to the friendly URL routes of the portlet.
`List<String>`	`getHeaderPortalCss()` Gets a list of CSS files that will be referenced from the page's header relative to the portal's context path.
`List<String>`	`getHeaderPortalJavaScript()` Gets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.
`List<String>`	`getHeaderPortletCss()` Gets a list of CSS files that will be referenced from the page's header relative to the portlet's context path.
`List<String>`	`getHeaderPortletJavaScript()` Gets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.
`String`	`getIcon()` Gets the icon of the portlet.
`boolean`	`getInclude()` Returns `true` to include the portlet and make it available to be made active.
`String`	`getIndexerClass()` Gets the name of the indexer class of the portlet.
`Indexer`	`getIndexerInstance()` Gets the indexer instance of the portlet.
`Map<String,String>`	`getInitParams()` Gets the init parameters of the portlet.
`boolean`	`getInstanceable()` Returns `true` if the portlet can be added multiple times to a layout.
`String`	`getInstanceId()` Gets the instance id of the portlet.
`boolean`	`getLayoutCacheable()` Returns `true` to allow the portlet to be cached within the layout.
`boolean`	`getMaximizeEdit()` Returns `true` if the portlet goes into the maximized state when the user goes into the edit mode.
`boolean`	`getMaximizeHelp()` Returns `true` if the portlet goes into the maximized state when the user goes into the help mode.
`String`	`getOpenSearchClass()` Gets the name of the open search class of the portlet.
`OpenSearch`	`getOpenSearchInstance()` Gets the indexer instance of the portlet.
`String`	`getPluginId()` Gets the plugin id of the portlet.
`PluginPackage`	`getPluginPackage()` Get the package to which the portlet belongs to.
`String`	`getPluginType()` Gets the plugin type of the portlet.
`String`	`getPollerProcessorClass()` Gets the name of the poller processor class of the portlet.
`PollerProcessor`	`getPollerProcessorInstance()` Gets the poller processor instance of the portlet.
`String`	`getPopMessageListenerClass()` Gets the name of the POP message listener class of the portlet.
`MessageListener`	`getPopMessageListenerInstance()` Gets the POP message listener instance of the portlet.
`boolean`	`getPopUpPrint()` Returns `true` if the portlet goes into the pop up state when the user goes into the print mode.
`PortletApp`	`getPortletApp()` Get the application this portlet belongs to.
`String`	`getPortletClass()` Gets the name of the portlet class of the portlet.
`String`	`getPortletDataHandlerClass()` Gets the name of the portlet data handler class of the portlet.
`PortletDataHandler`	`getPortletDataHandlerInstance()` Gets the portlet data handler instance of the portlet.
`Map<String,PortletFilter>`	`getPortletFilters()` Gets the filters of the portlet.
`PortletInfo`	`getPortletInfo()` Gets the portlet info of the portlet.
`String`	`getPortletLayoutListenerClass()` Gets the name of the portlet layout listener class of the portlet.
`PortletLayoutListener`	`getPortletLayoutListenerInstance()` Gets the portlet layout listener instance of the portlet.
`Map<String,Set<String>>`	`getPortletModes()` Gets the portlet modes of the portlet.
`String`	`getPortletName()` Gets the name of the portlet.
`String`	`getPortletURLClass()` Gets the name of the portlet URL class of the portlet.
`boolean`	`getPreferencesCompanyWide()` Returns `true` if preferences are shared across the entire company.
`boolean`	`getPreferencesOwnedByGroup()` Returns `true` if preferences are owned by the group when the portlet is shown in a group layout.
`boolean`	`getPreferencesUniquePerLayout()` Returns `true` if preferences are unique per layout.
`String`	`getPreferencesValidator()` Gets 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)` Gets the supported processing event from a namespace URI and a local part.
`Set<QName>`	`getProcessingEvents()` Gets the supported processing events of the portlet.
`PublicRenderParameter`	`getPublicRenderParameter(String identifier)` Gets the supported public render parameter from an identifier.
`PublicRenderParameter`	`getPublicRenderParameter(String uri, String localPart)` Gets the supported public render parameter from a namespace URI and a local part.
`Set<PublicRenderParameter>`	`getPublicRenderParameters()` Gets the supported public render parameters of the portlet.
`Set<QName>`	`getPublishingEvents()` Gets the supported publishing events of the portlet.
`boolean`	`getRemoteable()` Returns `true` if the portlet supports remoting.
`int`	`getRenderWeight()` Returns the render weight of the portlet.
`String`	`getResourceBundle()` Gets the resource bundle of the portlet.
`boolean`	`getRestoreCurrentView()` Returns `true` if the portlet restores to the current view from the maximized state.
`Map<String,String>`	`getRoleMappers()` Gets the role mappers of the portlet.
`String[]`	`getRolesArray()` Gets an array of required roles of the portlet.
`String`	`getRootPortletId()` Gets the root portlet id of the portlet.
`List<SchedulerEntry>`	`getSchedulerEntries()` Gets 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()` Gets the name of the social activity interpreter class of the portlet.
`SocialActivityInterpreter`	`getSocialActivityInterpreterInstance()` Gets the name of the social activity interpreter instance of the portlet.
`String`	`getSocialRequestInterpreterClass()` Gets the name of the social request interpreter class of the portlet.
`SocialRequestInterpreter`	`getSocialRequestInterpreterInstance()` Gets the name of the social request interpreter instance of the portlet.
`boolean`	`getStatic()` Returns `true` if the portlet is a static portlet that is cannot be moved.
`boolean`	`getStaticEnd()` Returns `true` if the portlet is a static portlet at the end of a list of portlets.
`boolean`	`getStaticStart()` Returns `true` if the portlet is a static portlet at the start of a list of portlets.
`String`	`getStrutsPath()` Gets the struts path of the portlet.
`Set<String>`	`getSupportedLocales()` Gets the supported locales of the portlet.
`boolean`	`getSystem()` Returns `true` if the portlet is a system portlet that a user cannot manually add to their page.
`long`	`getTimestamp()` Gets the timestamp of the portlet.
`boolean`	`getUndeployedPortlet()` Returns `true` if the portlet is an undeployed portlet.
`Set<String>`	`getUnlinkedRoles()` Gets the unlinked roles of the portlet.
`String`	`getURLEncoderClass()` Gets the name of the URL encoder class of the portlet.
`URLEncoder`	`getURLEncoderInstance()` Gets the URL encoder instance of the portlet.
`boolean`	`getUseDefaultTemplate()` Returns `true` if the portlet uses the default template.
`String`	`getUserPrincipalStrategy()` Gets the user principal strategy of the portlet.
`String`	`getVirtualPath()` Gets the virtual path of the portlet.
`String`	`getWebDAVStorageClass()` Gets the name of the WebDAV storage class of the portlet.
`WebDAVStorage`	`getWebDAVStorageInstance()` Gets the name of the WebDAV storage instance of the portlet.
`String`	`getWebDAVStorageToken()` Gets the name of the WebDAV storage token of the portlet.
`Map<String,Set<String>>`	`getWindowStates()` Gets the window states of the portlet.
`List<String>`	`getWorkflowHandlerClasses()` Gets the names of the classes that represent workflow handlers associated to the portlet.
`List<WorkflowHandler>`	`getWorkflowHandlerInstances()` Gets the workflow handler instances of the portlet.
`String`	`getXmlRpcMethodClass()` Gets the name of the XML-RPC method class of the portlet.
`Method`	`getXmlRpcMethodInstance()` Gets 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`	`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`	`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 to 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 to 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`	`setIndexerClass(String indexerClass)` Sets the name of the indexer class of 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`	`setPluginPackage(PluginPackage pluginPackage)` Sets the plugin package this portlet belongs to.
`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 the application this portlet belongs to.
`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`	`setRemoteable(boolean remoteable)` Set to `true` if the portlet supports remoting
`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 interface com.liferay.portal.model.PortletModel
`getActive, getCompanyId, getExpandoBridge, getId, getPortletId, getPrimaryKey, getPrimaryKeyObj, getRoles, hashCode, isActive, isCachedModel, isEscapedModel, isNew, setActive, setCachedModel, setCompanyId, setEscapedModel, setExpandoBridgeAttributes, setId, setNew, setPortletId, setPrimaryKey, toEscapedModel, toString, toXmlString`

Method Detail

getRootPortletId

String getRootPortletId()

Gets the root portlet id of the portlet.

Returns:: the root portlet id of the portlet

getInstanceId

String getInstanceId()

Gets the instance id of the portlet.

Returns:: the instance id of the portlet

getPluginId

String getPluginId()

Gets the plugin id of the portlet.

Returns:: the plugin id of the portlet

getPluginType

String getPluginType()

Gets the plugin type of the portlet.

Returns:: the plugin type of the portlet

getPluginPackage

PluginPackage getPluginPackage()

Get the package to which the portlet belongs to.

Returns:: the plugin package of the portlet

setPluginPackage

void setPluginPackage(PluginPackage pluginPackage)

Sets the plugin package this portlet belongs to.

Parameters:: pluginPackage - the plugin package

getDefaultPluginSetting

PluginSetting getDefaultPluginSetting()

Get the default plugin settings of the portlet.

Returns:: the plugin settings

setDefaultPluginSetting

void setDefaultPluginSetting(PluginSetting pluginSetting)

Sets the default plugin settings of the portlet.

Parameters:: pluginSetting - the plugin setting

getTimestamp

long getTimestamp()

Gets the timestamp of the portlet.

Returns:: the timestamp of the portlet

setTimestamp

void setTimestamp(long timestamp)

Sets the timestamp of the portlet.

Parameters:: timestamp - the timestamp of the portlet

getIcon

String getIcon()

Gets the icon of the portlet.

Returns:: the icon of the portlet

setIcon

void setIcon(String icon)

Sets the icon of the portlet.

Parameters:: icon - the icon of the portlet

getVirtualPath

String getVirtualPath()

Gets the virtual path of the portlet.

Returns:: the virtual path of the portlet

setVirtualPath

void setVirtualPath(String virtualPath)

Sets the virtual path of the portlet.

Parameters:: virtualPath - the virtual path of the portlet

getStrutsPath

String getStrutsPath()

Gets the struts path of the portlet.

Returns:: the struts path of the portlet

setStrutsPath

void setStrutsPath(String strutsPath)

Sets the struts path of the portlet.

Parameters:: strutsPath - the struts path of the portlet

getPortletName

String getPortletName()

Gets the name of the portlet.

Returns:: the display name of the portlet

setPortletName

void setPortletName(String portletName)

Sets the name of the portlet.

Parameters:: portletName - the name of the portlet

getDisplayName

String getDisplayName()

Gets the display name of the portlet.

Returns:: the display name of the portlet

setDisplayName

void setDisplayName(String displayName)

Sets the display name of the portlet.

Parameters:: displayName - the display name of the portlet

getPortletClass

String getPortletClass()

Gets the name of the portlet class of the portlet.

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

setPortletClass

void setPortletClass(String portletClass)

Sets the name of the portlet class of the portlet.

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

getConfigurationActionClass

String getConfigurationActionClass()

Gets the configuration action class of the portlet.

Returns:: the configuration action class of the portlet

setConfigurationActionClass

void setConfigurationActionClass(String configurationActionClass)

Sets the configuration action class of the portlet.

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

getConfigurationActionInstance

ConfigurationAction getConfigurationActionInstance()

Gets the configuration action instance of the portlet.

Returns:: the configuration action instance of the portlet

getIndexerClass

String getIndexerClass()

Gets the name of the indexer class of the portlet.

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

setIndexerClass

void setIndexerClass(String indexerClass)

Sets the name of the indexer class of the portlet.

Parameters:: indexerClass - the name of the indexer class of the portlet

getIndexerInstance

Indexer getIndexerInstance()

Gets the indexer instance of the portlet.

Returns:: the indexer instance of the portlet

getOpenSearchClass

String getOpenSearchClass()

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

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

setOpenSearchClass

void setOpenSearchClass(String openSearchClass)

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

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

getOpenSearchInstance

OpenSearch getOpenSearchInstance()

Gets the indexer instance of the portlet.

Returns:: the indexer instance of the portlet

addSchedulerEntry

void addSchedulerEntry(SchedulerEntry schedulerEntry)

Adds a scheduler entry.

getSchedulerEntries

List<SchedulerEntry> getSchedulerEntries()

Gets the scheduler entries of the portlet.

Returns:: the scheduler entries of the portlet

setSchedulerEntries

void setSchedulerEntries(List<SchedulerEntry> schedulerEntries)

Sets the scheduler entries of the portlet.

Parameters:: schedulerEntries - the scheduler entries of the portlet

getPortletURLClass

String getPortletURLClass()

Gets the name of the portlet URL class of the portlet.

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

setPortletURLClass

void setPortletURLClass(String portletURLClass)

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

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

getFriendlyURLMapperClass

String getFriendlyURLMapperClass()

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

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

setFriendlyURLMapperClass

void setFriendlyURLMapperClass(String friendlyURLMapperClass)

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

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

getFriendlyURLMapperInstance

FriendlyURLMapper getFriendlyURLMapperInstance()

Gets the friendly URL mapper instance of the portlet.

Returns:: the friendly URL mapper instance of the portlet

getFriendlyURLMapping

String getFriendlyURLMapping()

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

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

setFriendlyURLMapping

void setFriendlyURLMapping(String friendlyURLMapping)

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

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

getFriendlyURLRoutes

String getFriendlyURLRoutes()

Gets 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

setFriendlyURLRoutes

void setFriendlyURLRoutes(String friendlyURLRoutes)

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

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

getURLEncoderClass

String getURLEncoderClass()

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

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

setURLEncoderClass

void setURLEncoderClass(String urlEncoderClass)

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

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

getURLEncoderInstance

URLEncoder getURLEncoderInstance()

Gets the URL encoder instance of the portlet.

Returns:: the URL encoder instance of the portlet

getPortletDataHandlerClass

String getPortletDataHandlerClass()

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

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

setPortletDataHandlerClass

void setPortletDataHandlerClass(String portletDataHandlerClass)

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

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

getPortletDataHandlerInstance

PortletDataHandler getPortletDataHandlerInstance()

Gets the portlet data handler instance of the portlet.

Returns:: the portlet data handler instance of the portlet

getPortletLayoutListenerClass

String getPortletLayoutListenerClass()

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

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

setPortletLayoutListenerClass

void setPortletLayoutListenerClass(String portletLayoutListenerClass)

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

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

getPortletLayoutListenerInstance

PortletLayoutListener getPortletLayoutListenerInstance()

Gets the portlet layout listener instance of the portlet.

Returns:: the portlet layout listener instance of the portlet

getPollerProcessorClass

String getPollerProcessorClass()

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

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

setPollerProcessorClass

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

getPollerProcessorInstance

PollerProcessor getPollerProcessorInstance()

Gets the poller processor instance of the portlet.

Returns:: the poller processor instance of the portlet

getPopMessageListenerClass

String getPopMessageListenerClass()

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

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

setPopMessageListenerClass

void setPopMessageListenerClass(String popMessageListenerClass)

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

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

getPopMessageListenerInstance

MessageListener getPopMessageListenerInstance()

Gets the POP message listener instance of the portlet.

Returns:: the POP message listener instance of the portlet

getSocialActivityInterpreterClass

String getSocialActivityInterpreterClass()

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

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

setSocialActivityInterpreterClass

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

getSocialActivityInterpreterInstance

SocialActivityInterpreter getSocialActivityInterpreterInstance()

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

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

getSocialRequestInterpreterClass

String getSocialRequestInterpreterClass()

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

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

setSocialRequestInterpreterClass

void setSocialRequestInterpreterClass(String socialRequestInterpreterClass)

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

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

getSocialRequestInterpreterInstance

SocialRequestInterpreter getSocialRequestInterpreterInstance()

Gets the name of the social request interpreter instance of the portlet.

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

getWebDAVStorageToken

String getWebDAVStorageToken()

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

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

setWebDAVStorageToken

void setWebDAVStorageToken(String webDAVStorageToken)

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

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

getWebDAVStorageClass

String getWebDAVStorageClass()

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

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

setWebDAVStorageClass

void setWebDAVStorageClass(String webDAVStorageClass)

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

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

getWebDAVStorageInstance

WebDAVStorage getWebDAVStorageInstance()

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

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

getXmlRpcMethodClass

String getXmlRpcMethodClass()

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

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

setXmlRpcMethodClass

void setXmlRpcMethodClass(String xmlRpcMethodClass)

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

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

getXmlRpcMethodInstance

Method getXmlRpcMethodInstance()

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

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

getControlPanelEntryCategory

String getControlPanelEntryCategory()

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

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

setControlPanelEntryCategory

void setControlPanelEntryCategory(String controlPanelEntryCategory)

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

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

getControlPanelEntryWeight

double getControlPanelEntryWeight()

Gets 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

setControlPanelEntryWeight

void setControlPanelEntryWeight(double controlPanelEntryWeight)

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

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

getControlPanelEntryClass

String getControlPanelEntryClass()

Gets 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

setControlPanelEntryClass

void setControlPanelEntryClass(String controlPanelEntryClass)

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

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

getControlPanelEntryInstance

ControlPanelEntry getControlPanelEntryInstance()

Gets 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

getAssetRendererFactoryClasses

List<String> getAssetRendererFactoryClasses()

Gets the names of the classes that represent asset types associated to the portlet.

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

setAssetRendererFactoryClasses

void setAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses)

Sets the name of the classes that represent asset types associated to the portlet.

Parameters:: assetRendererFactoryClasses - the names of the classes that represent asset types associated to the portlet

getAssetRendererFactoryInstances

List<AssetRendererFactory> getAssetRendererFactoryInstances()

Gets the asset type instances of the portlet.

Returns:: the asset type instances of the portlet

getCustomAttributesDisplayClasses

List<String> getCustomAttributesDisplayClasses()

Gets the names of the classes that represent custom attribute displays associated to the portlet.

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

setCustomAttributesDisplayClasses

void setCustomAttributesDisplayClasses(List<String> customAttributesDisplayClasses)

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

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

getCustomAttributesDisplayInstances

List<CustomAttributesDisplay> getCustomAttributesDisplayInstances()

Gets the custom attribute display instances of the portlet.

Returns:: the custom attribute display instances of the portlet

getWorkflowHandlerClasses

List<String> getWorkflowHandlerClasses()

Gets the names of the classes that represent workflow handlers associated to the portlet.

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

setWorkflowHandlerClasses

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 to the portlet

getWorkflowHandlerInstances

List<WorkflowHandler> getWorkflowHandlerInstances()

Gets the workflow handler instances of the portlet.

Returns:: the workflow handler instances of the portlet

getDefaultPreferences

String getDefaultPreferences()

Gets the default preferences of the portlet.

Returns:: the default preferences of the portlet

setDefaultPreferences

void setDefaultPreferences(String defaultPreferences)

Sets the default preferences of the portlet.

Parameters:: defaultPreferences - the default preferences of the portlet

getPreferencesValidator

String getPreferencesValidator()

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

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

setPreferencesValidator

void setPreferencesValidator(String preferencesValidator)

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

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

getPreferencesCompanyWide

boolean getPreferencesCompanyWide()

Returns true if preferences are shared across the entire company.

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

isPreferencesCompanyWide

boolean isPreferencesCompanyWide()

Returns true if preferences are shared across the entire company.

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

setPreferencesCompanyWide

void setPreferencesCompanyWide(boolean preferencesCompanyWide)

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

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

getPreferencesUniquePerLayout

boolean getPreferencesUniquePerLayout()

Returns true if preferences are unique per layout.

Returns:: true if preferences are unique per layout

isPreferencesUniquePerLayout

boolean isPreferencesUniquePerLayout()

Returns true if preferences are unique per layout.

Returns:: true if preferences are unique per layout

setPreferencesUniquePerLayout

void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)

Set to true if preferences are unique per layout.

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

getPreferencesOwnedByGroup

boolean getPreferencesOwnedByGroup()

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

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

isPreferencesOwnedByGroup

boolean isPreferencesOwnedByGroup()

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

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

setPreferencesOwnedByGroup

void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)

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

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

getUseDefaultTemplate

boolean getUseDefaultTemplate()

Returns true if the portlet uses the default template.

Returns:: true if the portlet uses the default template

isUseDefaultTemplate

boolean isUseDefaultTemplate()

Returns true if the portlet uses the default template.

Returns:: true if the portlet uses the default template

setUseDefaultTemplate

void setUseDefaultTemplate(boolean useDefaultTemplate)

Set to true if the portlet uses the default template.

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

getShowPortletAccessDenied

boolean getShowPortletAccessDenied()

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

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

isShowPortletAccessDenied

boolean isShowPortletAccessDenied()

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

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

setShowPortletAccessDenied

void setShowPortletAccessDenied(boolean showPortletAccessDenied)

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

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

getShowPortletInactive

boolean getShowPortletInactive()

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

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

isShowPortletInactive

boolean isShowPortletInactive()

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

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

setShowPortletInactive

void setShowPortletInactive(boolean showPortletInactive)

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

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

getActionURLRedirect

boolean getActionURLRedirect()

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

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

isActionURLRedirect

boolean isActionURLRedirect()

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

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

setActionURLRedirect

void setActionURLRedirect(boolean actionURLRedirect)

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

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

getRestoreCurrentView

boolean getRestoreCurrentView()

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

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

isRestoreCurrentView

boolean isRestoreCurrentView()

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

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

setRestoreCurrentView

void setRestoreCurrentView(boolean restoreCurrentView)

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

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

getMaximizeEdit

boolean getMaximizeEdit()

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

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

isMaximizeEdit

boolean isMaximizeEdit()

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

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

setMaximizeEdit

void setMaximizeEdit(boolean maximizeEdit)

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

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

getMaximizeHelp

boolean getMaximizeHelp()

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

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

isMaximizeHelp

boolean isMaximizeHelp()

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

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

setMaximizeHelp

void setMaximizeHelp(boolean maximizeHelp)

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

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

getPopUpPrint

boolean getPopUpPrint()

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

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

isPopUpPrint

boolean isPopUpPrint()

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

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

setPopUpPrint

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

getLayoutCacheable

boolean getLayoutCacheable()

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

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

isLayoutCacheable

boolean isLayoutCacheable()

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

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

setLayoutCacheable

void setLayoutCacheable(boolean layoutCacheable)

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

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

getInstanceable

boolean getInstanceable()

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

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

isInstanceable

boolean isInstanceable()

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

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

setInstanceable

void setInstanceable(boolean instanceable)

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

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

getRemoteable

boolean getRemoteable()

Returns true if the portlet supports remoting.

Returns:: true if the portlet supports remoting

isRemoteable

boolean isRemoteable()

Returns true if the portlet supports remoting.

Returns:: true if the portlet supports remoting

setRemoteable

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

getScopeable

boolean getScopeable()

Returns true if the portlet supports scoping of data.

Returns:: true if the portlet supports scoping of data

isScopeable

boolean isScopeable()

Returns true if the portlet supports scoping of data.

Returns:: true if the portlet supports scoping of data

setScopeable

void setScopeable(boolean scopeable)

Set to true if the portlet supports scoping of data.

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

getUserPrincipalStrategy

String getUserPrincipalStrategy()

Gets the user principal strategy of the portlet.

Returns:: the user principal strategy of the portlet

setUserPrincipalStrategy

void setUserPrincipalStrategy(String userPrincipalStrategy)

Sets the user principal strategy of the portlet.

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

getPrivateRequestAttributes

boolean getPrivateRequestAttributes()

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

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

isPrivateRequestAttributes

boolean isPrivateRequestAttributes()

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

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

setPrivateRequestAttributes

void setPrivateRequestAttributes(boolean privateRequestAttributes)

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

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

getPrivateSessionAttributes

boolean getPrivateSessionAttributes()

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

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

isPrivateSessionAttributes

boolean isPrivateSessionAttributes()

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

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

setPrivateSessionAttributes

void setPrivateSessionAttributes(boolean privateSessionAttributes)

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

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

getRenderWeight

int getRenderWeight()

Returns the render weight of the portlet.

Returns:: the render weight of the portlet

setRenderWeight

void setRenderWeight(int renderWeight)

Sets the render weight of the portlet.

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

getAjaxable

boolean getAjaxable()

Returns true if the portlet can be displayed via Ajax.

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

isAjaxable

boolean isAjaxable()

Returns true if the portlet can be displayed via Ajax.

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

setAjaxable

void setAjaxable(boolean ajaxable)

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

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

getHeaderPortalCss

List<String> getHeaderPortalCss()

Gets 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

setHeaderPortalCss

void setHeaderPortalCss(List<String> headerPortalCss)

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

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

getHeaderPortletCss

List<String> getHeaderPortletCss()

Gets 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

setHeaderPortletCss

void setHeaderPortletCss(List<String> headerPortletCss)

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

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

getHeaderPortalJavaScript

List<String> getHeaderPortalJavaScript()

Gets 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

setHeaderPortalJavaScript

void setHeaderPortalJavaScript(List<String> headerPortalJavaScript)

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

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

getHeaderPortletJavaScript

List<String> getHeaderPortletJavaScript()

Gets 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

setHeaderPortletJavaScript

void setHeaderPortletJavaScript(List<String> headerPortletJavaScript)

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

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

getFooterPortalCss

List<String> getFooterPortalCss()

Gets 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

setFooterPortalCss

void setFooterPortalCss(List<String> footerPortalCss)

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

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

getFooterPortletCss

List<String> getFooterPortletCss()

Gets 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

setFooterPortletCss

void setFooterPortletCss(List<String> footerPortletCss)

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

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

getFooterPortalJavaScript

List<String> getFooterPortalJavaScript()

Gets 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

setFooterPortalJavaScript

void setFooterPortalJavaScript(List<String> footerPortalJavaScript)

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

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

getFooterPortletJavaScript

List<String> getFooterPortletJavaScript()

Gets 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

setFooterPortletJavaScript

void setFooterPortletJavaScript(List<String> footerPortletJavaScript)

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

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

getCssClassWrapper

String getCssClassWrapper()

Gets 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

setCssClassWrapper

void setCssClassWrapper(String cssClassWrapper)

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

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

getFacebookIntegration

String getFacebookIntegration()

Gets the Facebook integration method of the portlet.

Returns:: the Facebook integration method of the portlet

setFacebookIntegration

void setFacebookIntegration(String facebookIntegration)

Sets the Facebook integration method of the portlet.

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

getAddDefaultResource

boolean getAddDefaultResource()

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

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

isAddDefaultResource

boolean isAddDefaultResource()

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

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

setAddDefaultResource

void setAddDefaultResource(boolean addDefaultResource)

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

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

setRoles

void setRoles(String roles)

Sets a string of ordered comma delimited portlet ids.

Specified by:: setRoles in interface PortletModel

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

getRolesArray

String[] getRolesArray()

Gets an array of required roles of the portlet.

Returns:: an array of required roles of the portlet

setRolesArray

void setRolesArray(String[] rolesArray)

Sets an array of required roles of the portlet.

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

getUnlinkedRoles

Set<String> getUnlinkedRoles()

Gets the unlinked roles of the portlet.

Returns:: unlinked roles of the portlet

setUnlinkedRoles

void setUnlinkedRoles(Set<String> unlinkedRoles)

Sets the unlinked roles of the portlet.

Parameters:: unlinkedRoles - the unlinked roles of the portlet

getRoleMappers

Map<String,String> getRoleMappers()

Gets the role mappers of the portlet.

Returns:: role mappers of the portlet

setRoleMappers

void setRoleMappers(Map<String,String> roleMappers)

Sets the role mappers of the portlet.

Parameters:: roleMappers - the role mappers of the portlet

linkRoles

void linkRoles()

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

hasRoleWithName

boolean hasRoleWithName(String roleName)

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

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

hasAddPortletPermission

boolean hasAddPortletPermission(long userId)

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

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

getSystem

boolean getSystem()

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

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

isSystem

boolean isSystem()

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

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

setSystem

void setSystem(boolean system)

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

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

getInclude

boolean getInclude()

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

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

isInclude

boolean isInclude()

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

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

setInclude

void setInclude(boolean include)

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

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

getInitParams

Map<String,String> getInitParams()

Gets the init parameters of the portlet.

Returns:: init parameters of the portlet

setInitParams

void setInitParams(Map<String,String> initParams)

Sets the init parameters of the portlet.

Parameters:: initParams - the init parameters of the portlet

getExpCache

Integer getExpCache()

Gets expiration cache of the portlet.

Returns:: expiration cache of the portlet

setExpCache

void setExpCache(Integer expCache)

Sets expiration cache of the portlet.

Parameters:: expCache - expiration cache of the portlet

getPortletModes

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

Gets the portlet modes of the portlet.

Returns:: portlet modes of the portlet

setPortletModes

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

Sets the portlet modes of the portlet.

Parameters:: portletModes - the portlet modes of the portlet

hasPortletMode

boolean hasPortletMode(String mimeType,
                       PortletMode portletMode)

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

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

getAllPortletModes

Set<String> getAllPortletModes()

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

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

hasMultipleMimeTypes

boolean hasMultipleMimeTypes()

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

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

getWindowStates

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

Gets the window states of the portlet.

Returns:: window states of the portlet

setWindowStates

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

Sets the window states of the portlet.

Parameters:: windowStates - the window states of the portlet

hasWindowState

boolean hasWindowState(String mimeType,
                       WindowState windowState)

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

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

getAllWindowStates

Set<String> getAllWindowStates()

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

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

getSupportedLocales

Set<String> getSupportedLocales()

Gets the supported locales of the portlet.

Returns:: supported locales of the portlet

setSupportedLocales

void setSupportedLocales(Set<String> supportedLocales)

Sets the supported locales of the portlet.

Parameters:: supportedLocales - the supported locales of the portlet

getResourceBundle

String getResourceBundle()

Gets the resource bundle of the portlet.

Returns:: resource bundle of the portlet

setResourceBundle

void setResourceBundle(String resourceBundle)

Sets the resource bundle of the portlet.

Parameters:: resourceBundle - the resource bundle of the portlet

getPortletInfo

PortletInfo getPortletInfo()

Gets the portlet info of the portlet.

Returns:: portlet info of the portlet

setPortletInfo

void setPortletInfo(PortletInfo portletInfo)

Sets the portlet info of the portlet.

Parameters:: portletInfo - the portlet info of the portlet

getPortletFilters

Map<String,PortletFilter> getPortletFilters()

Gets the filters of the portlet.

Returns:: filters of the portlet

setPortletFilters

void setPortletFilters(Map<String,PortletFilter> portletFilters)

Sets the filters of the portlet.

Parameters:: portletFilters - the filters of the portlet

addProcessingEvent

void addProcessingEvent(QName processingEvent)

Adds a supported processing event.

getProcessingEvent

QName getProcessingEvent(String uri,
                         String localPart)

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

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

getProcessingEvents

Set<QName> getProcessingEvents()

Gets the supported processing events of the portlet.

Returns:: supported processing events of the portlet

setProcessingEvents

void setProcessingEvents(Set<QName> processingEvents)

Sets the supported processing events of the portlet.

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

addPublishingEvent

void addPublishingEvent(QName publishingEvent)

Adds a supported publishing event.

getPublishingEvents

Set<QName> getPublishingEvents()

Gets the supported publishing events of the portlet.

Returns:: supported publishing events of the portlet

setPublishingEvents

void setPublishingEvents(Set<QName> publishingEvents)

Sets the supported publishing events of the portlet.

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

addPublicRenderParameter

void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)

Adds a supported public render parameter.

Parameters:: publicRenderParameter - a supported public render parameter

getPublicRenderParameter

PublicRenderParameter getPublicRenderParameter(String identifier)

Gets the supported public render parameter from an identifier.

Returns:: the supported public render parameter from an identifier

getPublicRenderParameter

PublicRenderParameter getPublicRenderParameter(String uri,
                                               String localPart)

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

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

getPublicRenderParameters

Set<PublicRenderParameter> getPublicRenderParameters()

Gets the supported public render parameters of the portlet.

Returns:: the supported public render parameters of the portlet

setPublicRenderParameters

void setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)

Sets the supported public render parameters of the portlet.

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

getContextPath

String getContextPath()

Gets the servlet context path of the portlet.

Returns:: the servlet context path of the portlet

getPortletApp

PortletApp getPortletApp()

Get the application this portlet belongs to.

Returns:: the application this portlet belongs to

setPortletApp

void setPortletApp(PortletApp portletApp)

Sets the application this portlet belongs to.

Parameters:: portletApp - the application this portlet belongs to

getClonedInstance

Portlet getClonedInstance(String portletId)

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

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

getStatic

boolean getStatic()

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

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

isStatic

boolean isStatic()

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

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

setStatic

void setStatic(boolean staticPortlet)

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

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

getStaticStart

boolean getStaticStart()

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

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

isStaticStart

boolean isStaticStart()

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

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

setStaticStart

void setStaticStart(boolean staticPortletStart)

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

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

getStaticEnd

boolean getStaticEnd()

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

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

isStaticEnd

boolean isStaticEnd()

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

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

getUndeployedPortlet

boolean getUndeployedPortlet()

Returns true if the portlet is an undeployed portlet.

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

isUndeployedPortlet

boolean isUndeployedPortlet()

Returns true if the portlet is an undeployed portlet.

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

setUndeployedPortlet

void setUndeployedPortlet(boolean undeployedPortlet)

Set to true if the portlet is an undeployed portlet.

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

clone

Object clone()

Creates and returns a copy of this object.

Specified by:: clone in interface BaseModel<Portlet>
Specified by:: clone in interface PortletModel

Returns:: a copy of this object

compareTo

int compareTo(Portlet portlet)

Compares this portlet to the specified object.

Specified by:: compareTo in interface Comparable<Portlet>
Specified by:: compareTo in interface PortletModel

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

equals

boolean equals(Object obj)

Checks whether this portlet is equal to the specified object.

Overrides:: equals in class Object

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

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.0.5

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.model Interface Portlet

getRootPortletId

getInstanceId

getPluginId

getPluginType

getPluginPackage

setPluginPackage

getDefaultPluginSetting

setDefaultPluginSetting

getTimestamp

setTimestamp

getIcon

setIcon

getVirtualPath

setVirtualPath

getStrutsPath

setStrutsPath

getPortletName

setPortletName

getDisplayName

setDisplayName

getPortletClass

setPortletClass

getConfigurationActionClass

setConfigurationActionClass

getConfigurationActionInstance

getIndexerClass

setIndexerClass

getIndexerInstance

getOpenSearchClass

setOpenSearchClass

getOpenSearchInstance

addSchedulerEntry

getSchedulerEntries

setSchedulerEntries

getPortletURLClass

setPortletURLClass

getFriendlyURLMapperClass

setFriendlyURLMapperClass

getFriendlyURLMapperInstance

getFriendlyURLMapping

setFriendlyURLMapping

getFriendlyURLRoutes

setFriendlyURLRoutes

getURLEncoderClass

setURLEncoderClass

getURLEncoderInstance

getPortletDataHandlerClass

setPortletDataHandlerClass

getPortletDataHandlerInstance

getPortletLayoutListenerClass

setPortletLayoutListenerClass

getPortletLayoutListenerInstance

getPollerProcessorClass

setPollerProcessorClass

getPollerProcessorInstance

getPopMessageListenerClass

setPopMessageListenerClass

getPopMessageListenerInstance

getSocialActivityInterpreterClass

setSocialActivityInterpreterClass

getSocialActivityInterpreterInstance

getSocialRequestInterpreterClass

setSocialRequestInterpreterClass

getSocialRequestInterpreterInstance

getWebDAVStorageToken

setWebDAVStorageToken

getWebDAVStorageClass

setWebDAVStorageClass

getWebDAVStorageInstance

getXmlRpcMethodClass

setXmlRpcMethodClass

getXmlRpcMethodInstance

getControlPanelEntryCategory

setControlPanelEntryCategory

getControlPanelEntryWeight

setControlPanelEntryWeight

getControlPanelEntryClass

setControlPanelEntryClass

getControlPanelEntryInstance

com.liferay.portal.model
Interface Portlet