PortletImpl (Liferay 6.0.5 API)

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.impl
Class PortletImpl

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

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

public class PortletImpl
extends PortletModelImpl
implements Portlet
extends PortletModelImpl
implements Portlet

See Also:: Serialized Form

Field Summary

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

Constructor Summary
`PortletImpl()` Constructs a portlet with no parameters.
`PortletImpl(long companyId, String portletId)` Constructs a portlet with the specified parameters.
PortletImpl(String portletId, PluginPackage pluginPackage, PluginSetting pluginSetting, long companyId, long timestamp, String icon, String virtualPath, String strutsPath, String portletName, String displayName, String portletClass, String configurationActionClass, String indexerClass, 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> customAttributesDisplayClasses, 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, 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.
`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 class com.liferay.portal.model.impl.PortletModelImpl
`getActive, getCompanyId, getExpandoBridge, getId, getOriginalCompanyId, getOriginalPortletId, getPortletId, getPrimaryKey, getPrimaryKeyObj, getRoles, hashCode, isActive, setActive, setCompanyId, setExpandoBridgeAttributes, setId, setPortletId, setPrimaryKey, toEscapedModel, toModel, toModels, toString, toXmlString`

Methods inherited from class com.liferay.portal.model.impl.BaseModelImpl
`isCachedModel, isEscapedModel, isNew, setCachedModel, setEscapedModel, 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, setEscapedModel, setExpandoBridgeAttributes, setId, setNew, setPortletId, setPrimaryKey, toEscapedModel, toString, toXmlString`

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,
                   PluginPackage pluginPackage,
                   PluginSetting pluginSetting,
                   long companyId,
                   long timestamp,
                   String icon,
                   String virtualPath,
                   String strutsPath,
                   String portletName,
                   String displayName,
                   String portletClass,
                   String configurationActionClass,
                   String indexerClass,
                   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> customAttributesDisplayClasses,
                   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,
                   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

getRootPortletId

public String getRootPortletId()

Gets the root portlet id of the portlet.

Specified by:: getRootPortletId in interface Portlet

Returns:: the root portlet id of the portlet

getInstanceId

public String getInstanceId()

Gets the instance id of the portlet.

Specified by:: getInstanceId in interface Portlet

Returns:: the instance id of the portlet

getPluginId

public String getPluginId()

Gets the plugin id of the portlet.

Specified by:: getPluginId in interface Portlet

Returns:: the plugin id of the portlet

getPluginType

public String getPluginType()

Gets the plugin type of the portlet.

Specified by:: getPluginType in interface Portlet

Returns:: the plugin type of the portlet

getPluginPackage

public PluginPackage getPluginPackage()

Get the package to which the portlet belongs to.

Specified by:: getPluginPackage in interface Portlet

Returns:: the plugin package of the portlet

setPluginPackage

public void setPluginPackage(PluginPackage pluginPackage)

Sets the plugin package this portlet belongs to.

Specified by:: setPluginPackage in interface Portlet

Parameters:: pluginPackage - the plugin package

getDefaultPluginSetting

public PluginSetting getDefaultPluginSetting()

Get the default plugin settings of the portlet.

Specified by:: getDefaultPluginSetting in interface Portlet

Returns:: the plugin settings

setDefaultPluginSetting

public void setDefaultPluginSetting(PluginSetting pluginSetting)

Sets the default plugin settings of the portlet.

Specified by:: setDefaultPluginSetting in interface Portlet

Parameters:: pluginSetting - the plugin setting

getTimestamp

public long getTimestamp()

Gets the timestamp of the portlet.

Specified by:: getTimestamp in interface Portlet

Returns:: the timestamp of the portlet

setTimestamp

public void setTimestamp(long timestamp)

Sets the timestamp of the portlet.

Specified by:: setTimestamp in interface Portlet

Parameters:: timestamp - the timestamp of the portlet

getIcon

public String getIcon()

Gets the icon of the portlet.

Specified by:: getIcon in interface Portlet

Returns:: the icon of the portlet

setIcon

public void setIcon(String icon)

Sets the icon of the portlet.

Specified by:: setIcon in interface Portlet

Parameters:: icon - the icon of the portlet

getVirtualPath

public String getVirtualPath()

Gets the virtual path of the portlet.

Specified by:: getVirtualPath in interface Portlet

Returns:: the virtual path of the portlet

setVirtualPath

public void setVirtualPath(String virtualPath)

Sets the virtual path of the portlet.

Specified by:: setVirtualPath in interface Portlet

Parameters:: virtualPath - the virtual path of the portlet

getStrutsPath

public String getStrutsPath()

Gets the struts path of the portlet.

Specified by:: getStrutsPath in interface Portlet

Returns:: the struts path of the portlet

setStrutsPath

public void setStrutsPath(String strutsPath)

Sets the struts path of the portlet.

Specified by:: setStrutsPath in interface Portlet

Parameters:: strutsPath - the struts path of the portlet

getPortletName

public String getPortletName()

Gets the name of the portlet.

Specified by:: getPortletName in interface Portlet

Returns:: the display name of the portlet

setPortletName

public void setPortletName(String portletName)

Sets the name of the portlet.

Specified by:: setPortletName in interface Portlet

Parameters:: portletName - the name of the portlet

getDisplayName

public String getDisplayName()

Gets the display name of the portlet.

Specified by:: getDisplayName in interface Portlet

Returns:: the display name of the portlet

setDisplayName

public void setDisplayName(String displayName)

Sets the display name of the portlet.

Specified by:: setDisplayName in interface Portlet

Parameters:: displayName - the display name of the portlet

getPortletClass

public String getPortletClass()

Gets the name of the portlet class of the portlet.

Specified by:: getPortletClass in interface Portlet

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

setPortletClass

public void setPortletClass(String portletClass)

Sets the name of the portlet class of the portlet.

Specified by:: setPortletClass in interface Portlet

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

getConfigurationActionClass

public String getConfigurationActionClass()

Gets the configuration action class of the portlet.

Specified by:: getConfigurationActionClass in interface Portlet

Returns:: the configuration action class of the portlet

setConfigurationActionClass

public void setConfigurationActionClass(String configurationActionClass)

Sets the configuration action class of the portlet.

Specified by:: setConfigurationActionClass in interface Portlet

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

getConfigurationActionInstance

public ConfigurationAction getConfigurationActionInstance()

Gets the configuration action instance of the portlet.

Specified by:: getConfigurationActionInstance in interface Portlet

Returns:: the configuration action instance of the portlet

getIndexerClass

public String getIndexerClass()

Gets the name of the indexer class of the portlet.

Specified by:: getIndexerClass in interface Portlet

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

setIndexerClass

public void setIndexerClass(String indexerClass)

Sets the name of the indexer class of the portlet.

Specified by:: setIndexerClass in interface Portlet

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

getIndexerInstance

public Indexer getIndexerInstance()

Gets the indexer instance of the portlet.

Specified by:: getIndexerInstance in interface Portlet

Returns:: the indexer instance of the portlet

getOpenSearchClass

public String getOpenSearchClass()

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

Specified by:: getOpenSearchClass in interface Portlet

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

setOpenSearchClass

public void setOpenSearchClass(String openSearchClass)

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

Specified by:: setOpenSearchClass in interface Portlet

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

getOpenSearchInstance

public OpenSearch getOpenSearchInstance()

Gets the indexer instance of the portlet.

Specified by:: getOpenSearchInstance in interface Portlet

Returns:: the indexer instance of the portlet

addSchedulerEntry

public void addSchedulerEntry(SchedulerEntry schedulerEntry)

Adds a scheduler entry.

Specified by:: addSchedulerEntry in interface Portlet

getSchedulerEntries

public List<SchedulerEntry> getSchedulerEntries()

Gets the scheduler entries of the portlet.

Specified by:: getSchedulerEntries in interface Portlet

Returns:: the scheduler entries of the portlet

setSchedulerEntries

public void setSchedulerEntries(List<SchedulerEntry> schedulerEntries)

Sets the scheduler entries of the portlet.

Specified by:: setSchedulerEntries in interface Portlet

Parameters:: schedulerEntries - the scheduler entries of the portlet

getPortletURLClass

public String getPortletURLClass()

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

Specified by:: getPortletURLClass in interface Portlet

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

setPortletURLClass

public void setPortletURLClass(String portletURLClass)

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

Specified by:: setPortletURLClass in interface Portlet

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

getFriendlyURLMapperClass

public String getFriendlyURLMapperClass()

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

Specified by:: getFriendlyURLMapperClass in interface Portlet

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

setFriendlyURLMapperClass

public void setFriendlyURLMapperClass(String friendlyURLMapperClass)

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

Specified by:: setFriendlyURLMapperClass in interface Portlet

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

getFriendlyURLMapperInstance

public FriendlyURLMapper getFriendlyURLMapperInstance()

Gets the friendly URL mapper instance of the portlet.

Specified by:: getFriendlyURLMapperInstance in interface Portlet

Returns:: the friendly URL mapper instance of the portlet

getFriendlyURLMapping

public String getFriendlyURLMapping()

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

Specified by:: getFriendlyURLMapping in interface Portlet

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

setFriendlyURLMapping

public void setFriendlyURLMapping(String friendlyURLMapping)

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

Specified by:: setFriendlyURLMapping in interface Portlet

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

getFriendlyURLRoutes

public String getFriendlyURLRoutes()

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

Specified by:: getFriendlyURLRoutes in interface Portlet

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

setFriendlyURLRoutes

public void setFriendlyURLRoutes(String friendlyURLRoutes)

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

Specified by:: setFriendlyURLRoutes in interface Portlet

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

getURLEncoderClass

public String getURLEncoderClass()

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

Specified by:: getURLEncoderClass in interface Portlet

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

setURLEncoderClass

public void setURLEncoderClass(String urlEncoderClass)

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

Specified by:: setURLEncoderClass in interface Portlet

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

getURLEncoderInstance

public URLEncoder getURLEncoderInstance()

Gets the URL encoder instance of the portlet.

Specified by:: getURLEncoderInstance in interface Portlet

Returns:: the URL encoder instance of the portlet

getPortletDataHandlerClass

public String getPortletDataHandlerClass()

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

Specified by:: getPortletDataHandlerClass in interface Portlet

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

setPortletDataHandlerClass

public void setPortletDataHandlerClass(String portletDataHandlerClass)

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

Specified by:: setPortletDataHandlerClass in interface Portlet

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

getPortletDataHandlerInstance

public PortletDataHandler getPortletDataHandlerInstance()

Gets the portlet data handler instance of the portlet.

Specified by:: getPortletDataHandlerInstance in interface Portlet

Returns:: the portlet data handler instance of the portlet

getPortletLayoutListenerClass

public String getPortletLayoutListenerClass()

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

Specified by:: getPortletLayoutListenerClass in interface Portlet

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

setPortletLayoutListenerClass

public void setPortletLayoutListenerClass(String portletLayoutListenerClass)

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

Specified by:: setPortletLayoutListenerClass in interface Portlet

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

getPortletLayoutListenerInstance

public PortletLayoutListener getPortletLayoutListenerInstance()

Gets the portlet layout listener instance of the portlet.

Specified by:: getPortletLayoutListenerInstance in interface Portlet

Returns:: the portlet layout listener instance of the portlet

getPollerProcessorClass

public String getPollerProcessorClass()

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

Specified by:: getPollerProcessorClass in interface Portlet

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

setPollerProcessorClass

public void setPollerProcessorClass(String pollerProcessorClass)

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

Specified by:: setPollerProcessorClass in interface Portlet

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

getPollerProcessorInstance

public PollerProcessor getPollerProcessorInstance()

Gets the poller processor instance of the portlet.

Specified by:: getPollerProcessorInstance in interface Portlet

Returns:: the poller processor instance of the portlet

getPopMessageListenerClass

public String getPopMessageListenerClass()

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

Specified by:: getPopMessageListenerClass in interface Portlet

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

setPopMessageListenerClass

public void setPopMessageListenerClass(String popMessageListenerClass)

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

Specified by:: setPopMessageListenerClass in interface Portlet

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

getPopMessageListenerInstance

public MessageListener getPopMessageListenerInstance()

Gets the POP message listener instance of the portlet.

Specified by:: getPopMessageListenerInstance in interface Portlet

Returns:: the POP message listener instance of the portlet

getSocialActivityInterpreterClass

public String getSocialActivityInterpreterClass()

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

Specified by:: getSocialActivityInterpreterClass in interface Portlet

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

setSocialActivityInterpreterClass

public void setSocialActivityInterpreterClass(String socialActivityInterpreterClass)

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

Specified by:: setSocialActivityInterpreterClass in interface Portlet

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

getSocialActivityInterpreterInstance

public SocialActivityInterpreter getSocialActivityInterpreterInstance()

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

Specified by:: getSocialActivityInterpreterInstance in interface Portlet

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

getSocialRequestInterpreterClass

public String getSocialRequestInterpreterClass()

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

Specified by:: getSocialRequestInterpreterClass in interface Portlet

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

setSocialRequestInterpreterClass

public void setSocialRequestInterpreterClass(String socialRequestInterpreterClass)

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

Specified by:: setSocialRequestInterpreterClass in interface Portlet

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

getSocialRequestInterpreterInstance

public SocialRequestInterpreter getSocialRequestInterpreterInstance()

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

Specified by:: getSocialRequestInterpreterInstance in interface Portlet

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

getWebDAVStorageToken

public String getWebDAVStorageToken()

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

Specified by:: getWebDAVStorageToken in interface Portlet

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

setWebDAVStorageToken

public void setWebDAVStorageToken(String webDAVStorageToken)

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

Specified by:: setWebDAVStorageToken in interface Portlet

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

getWebDAVStorageClass

public String getWebDAVStorageClass()

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

Specified by:: getWebDAVStorageClass in interface Portlet

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

setWebDAVStorageClass

public void setWebDAVStorageClass(String webDAVStorageClass)

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

Specified by:: setWebDAVStorageClass in interface Portlet

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

getWebDAVStorageInstance

public WebDAVStorage getWebDAVStorageInstance()

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

Specified by:: getWebDAVStorageInstance in interface Portlet

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

getXmlRpcMethodClass

public String getXmlRpcMethodClass()

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

Specified by:: getXmlRpcMethodClass in interface Portlet

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

setXmlRpcMethodClass

public void setXmlRpcMethodClass(String xmlRpcMethodClass)

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

Specified by:: setXmlRpcMethodClass in interface Portlet

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

getXmlRpcMethodInstance

public Method getXmlRpcMethodInstance()

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

Specified by:: getXmlRpcMethodInstance in interface Portlet

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

getControlPanelEntryCategory

public String getControlPanelEntryCategory()

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

Specified by:: getControlPanelEntryCategory in interface Portlet

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

setControlPanelEntryCategory

public void setControlPanelEntryCategory(String controlPanelEntryCategory)

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

Specified by:: setControlPanelEntryCategory in interface Portlet

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

getControlPanelEntryWeight

public double getControlPanelEntryWeight()

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

Specified by:: getControlPanelEntryWeight in interface Portlet

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

setControlPanelEntryWeight

public void setControlPanelEntryWeight(double controlPanelEntryWeight)

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

Specified by:: setControlPanelEntryWeight in interface Portlet

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

getControlPanelEntryClass

public String getControlPanelEntryClass()

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

Specified by:: getControlPanelEntryClass in interface Portlet

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

setControlPanelEntryClass

public void setControlPanelEntryClass(String controlPanelEntryClass)

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

Specified by:: setControlPanelEntryClass in interface Portlet

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

getControlPanelEntryInstance

public ControlPanelEntry getControlPanelEntryInstance()

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

Specified by:: getControlPanelEntryInstance in interface Portlet

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

getAssetRendererFactoryClasses

public List<String> getAssetRendererFactoryClasses()

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

Specified by:: getAssetRendererFactoryClasses in interface Portlet

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

setAssetRendererFactoryClasses

public void setAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses)

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

Specified by:: setAssetRendererFactoryClasses in interface Portlet

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

getAssetRendererFactoryInstances

public List<AssetRendererFactory> getAssetRendererFactoryInstances()

Gets the asset type instances of the portlet.

Specified by:: getAssetRendererFactoryInstances in interface Portlet

Returns:: the asset type instances of the portlet

getCustomAttributesDisplayClasses

public List<String> getCustomAttributesDisplayClasses()

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

Specified by:: getCustomAttributesDisplayClasses in interface Portlet

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

setCustomAttributesDisplayClasses

public void setCustomAttributesDisplayClasses(List<String> customAttributesDisplayClasses)

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

Specified by:: setCustomAttributesDisplayClasses in interface Portlet

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

getCustomAttributesDisplayInstances

public List<CustomAttributesDisplay> getCustomAttributesDisplayInstances()

Gets the custom attribute display instances of the portlet.

Specified by:: getCustomAttributesDisplayInstances in interface Portlet

Returns:: the custom attribute display instances of the portlet

getWorkflowHandlerClasses

public List<String> getWorkflowHandlerClasses()

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

Specified by:: getWorkflowHandlerClasses in interface Portlet

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

setWorkflowHandlerClasses

public void setWorkflowHandlerClasses(List<String> workflowHandlerClasses)

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

Specified by:: setWorkflowHandlerClasses in interface Portlet

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

getWorkflowHandlerInstances

public List<WorkflowHandler> getWorkflowHandlerInstances()

Gets the workflow handler instances of the portlet.

Specified by:: getWorkflowHandlerInstances in interface Portlet

Returns:: the workflow handler instances of the portlet

getDefaultPreferences

public String getDefaultPreferences()

Gets the default preferences of the portlet.

Specified by:: getDefaultPreferences in interface Portlet

Returns:: the default preferences of the portlet

setDefaultPreferences

public void setDefaultPreferences(String defaultPreferences)

Sets the default preferences of the portlet.

Specified by:: setDefaultPreferences in interface Portlet

Parameters:: defaultPreferences - the default preferences of the portlet

getPreferencesValidator

public String getPreferencesValidator()

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

Specified by:: getPreferencesValidator in interface Portlet

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

setPreferencesValidator

public void setPreferencesValidator(String preferencesValidator)

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

Specified by:: setPreferencesValidator in interface Portlet

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

getPreferencesCompanyWide

public boolean getPreferencesCompanyWide()

Returns true if preferences are shared across the entire company.

Specified by:: getPreferencesCompanyWide in interface Portlet

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

isPreferencesCompanyWide

public boolean isPreferencesCompanyWide()

Returns true if preferences are shared across the entire company.

Specified by:: isPreferencesCompanyWide in interface Portlet

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

setPreferencesCompanyWide

public void setPreferencesCompanyWide(boolean preferencesCompanyWide)

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

Specified by:: setPreferencesCompanyWide in interface Portlet

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

getPreferencesUniquePerLayout

public boolean getPreferencesUniquePerLayout()

Returns true if preferences are unique per layout.

Specified by:: getPreferencesUniquePerLayout in interface Portlet

Returns:: true if preferences are unique per layout

isPreferencesUniquePerLayout

public boolean isPreferencesUniquePerLayout()

Returns true if preferences are unique per layout.

Specified by:: isPreferencesUniquePerLayout in interface Portlet

Returns:: true if preferences are unique per layout

setPreferencesUniquePerLayout

public void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)

Set to true if preferences are unique per layout.

Specified by:: setPreferencesUniquePerLayout in interface Portlet

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

getPreferencesOwnedByGroup

public boolean getPreferencesOwnedByGroup()

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

Specified by:: getPreferencesOwnedByGroup in interface Portlet

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

isPreferencesOwnedByGroup

public boolean isPreferencesOwnedByGroup()

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

Specified by:: isPreferencesOwnedByGroup in interface Portlet

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

setPreferencesOwnedByGroup

public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)

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

Specified by:: setPreferencesOwnedByGroup in interface Portlet

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

getUseDefaultTemplate

public boolean getUseDefaultTemplate()

Returns true if the portlet uses the default template.

Specified by:: getUseDefaultTemplate in interface Portlet

Returns:: true if the portlet uses the default template

isUseDefaultTemplate

public boolean isUseDefaultTemplate()

Returns true if the portlet uses the default template.

Specified by:: isUseDefaultTemplate in interface Portlet

Returns:: true if the portlet uses the default template

setUseDefaultTemplate

public void setUseDefaultTemplate(boolean useDefaultTemplate)

Set to true if the portlet uses the default template.

Specified by:: setUseDefaultTemplate in interface Portlet

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

getShowPortletAccessDenied

public boolean getShowPortletAccessDenied()

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

Specified by:: getShowPortletAccessDenied in interface Portlet

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

isShowPortletAccessDenied

public boolean isShowPortletAccessDenied()

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

Specified by:: isShowPortletAccessDenied in interface Portlet

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

setShowPortletAccessDenied

public void setShowPortletAccessDenied(boolean showPortletAccessDenied)

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

Specified by:: setShowPortletAccessDenied in interface Portlet

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

getShowPortletInactive

public boolean getShowPortletInactive()

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

Specified by:: getShowPortletInactive in interface Portlet

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

isShowPortletInactive

public boolean isShowPortletInactive()

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

Specified by:: isShowPortletInactive in interface Portlet

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

setShowPortletInactive

public void setShowPortletInactive(boolean showPortletInactive)

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

Specified by:: setShowPortletInactive in interface Portlet

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

getActionURLRedirect

public boolean getActionURLRedirect()

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

Specified by:: getActionURLRedirect in interface Portlet

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

isActionURLRedirect

public boolean isActionURLRedirect()

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

Specified by:: isActionURLRedirect in interface Portlet

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

setActionURLRedirect

public void setActionURLRedirect(boolean actionURLRedirect)

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

Specified by:: setActionURLRedirect in interface Portlet

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

getRestoreCurrentView

public boolean getRestoreCurrentView()

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

Specified by:: getRestoreCurrentView in interface Portlet

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

isRestoreCurrentView

public boolean isRestoreCurrentView()

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

Specified by:: isRestoreCurrentView in interface Portlet

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

setRestoreCurrentView

public void setRestoreCurrentView(boolean restoreCurrentView)

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

Specified by:: setRestoreCurrentView in interface Portlet

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

getMaximizeEdit

public boolean getMaximizeEdit()

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

Specified by:: getMaximizeEdit in interface Portlet

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

isMaximizeEdit

public boolean isMaximizeEdit()

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

Specified by:: isMaximizeEdit in interface Portlet

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

setMaximizeEdit

public void setMaximizeEdit(boolean maximizeEdit)

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

Specified by:: setMaximizeEdit in interface Portlet

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

getMaximizeHelp

public boolean getMaximizeHelp()

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

Specified by:: getMaximizeHelp in interface Portlet

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

isMaximizeHelp

public boolean isMaximizeHelp()

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

Specified by:: isMaximizeHelp in interface Portlet

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

setMaximizeHelp

public void setMaximizeHelp(boolean maximizeHelp)

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

Specified by:: setMaximizeHelp in interface Portlet

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

getPopUpPrint

public boolean getPopUpPrint()

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

Specified by:: getPopUpPrint in interface Portlet

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

isPopUpPrint

public boolean isPopUpPrint()

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

Specified by:: isPopUpPrint in interface Portlet

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

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.

Specified by:: setPopUpPrint in interface Portlet

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

getLayoutCacheable

public boolean getLayoutCacheable()

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

Specified by:: getLayoutCacheable in interface Portlet

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

isLayoutCacheable

public boolean isLayoutCacheable()

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

Specified by:: isLayoutCacheable in interface Portlet

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

setLayoutCacheable

public void setLayoutCacheable(boolean layoutCacheable)

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

Specified by:: setLayoutCacheable in interface Portlet

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

getInstanceable

public boolean getInstanceable()

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

Specified by:: getInstanceable in interface Portlet

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

isInstanceable

public boolean isInstanceable()

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

Specified by:: isInstanceable in interface Portlet

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

setInstanceable

public void setInstanceable(boolean instanceable)

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

Specified by:: setInstanceable in interface Portlet

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

getRemoteable

public boolean getRemoteable()

Returns true if the portlet supports remoting.

Specified by:: getRemoteable in interface Portlet

Returns:: true if the portlet supports remoting

isRemoteable

public boolean isRemoteable()

Returns true if the portlet supports remoting.

Specified by:: isRemoteable in interface Portlet

Returns:: true if the portlet supports remoting

setRemoteable

public void setRemoteable(boolean remoteable)

Set to true if the portlet supports remoting

Specified by:: setRemoteable in interface Portlet

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

getScopeable

public boolean getScopeable()

Returns true if the portlet supports scoping of data.

Specified by:: getScopeable in interface Portlet

Returns:: true if the portlet supports scoping of data

isScopeable

public boolean isScopeable()

Returns true if the portlet supports scoping of data.

Specified by:: isScopeable in interface Portlet

Returns:: true if the portlet supports scoping of data

setScopeable

public void setScopeable(boolean scopeable)

Set to true if the portlet supports scoping of data.

Specified by:: setScopeable in interface Portlet

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

getUserPrincipalStrategy

public String getUserPrincipalStrategy()

Gets the user principal strategy of the portlet.

Specified by:: getUserPrincipalStrategy in interface Portlet

Returns:: the user principal strategy of the portlet

setUserPrincipalStrategy

public void setUserPrincipalStrategy(String userPrincipalStrategy)

Sets the user principal strategy of the portlet.

Specified by:: setUserPrincipalStrategy in interface Portlet

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

getPrivateRequestAttributes

public boolean getPrivateRequestAttributes()

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

Specified by:: getPrivateRequestAttributes in interface Portlet

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

isPrivateRequestAttributes

public boolean isPrivateRequestAttributes()

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

Specified by:: isPrivateRequestAttributes in interface Portlet

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

setPrivateRequestAttributes

public void setPrivateRequestAttributes(boolean privateRequestAttributes)

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

Specified by:: setPrivateRequestAttributes in interface Portlet

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

getPrivateSessionAttributes

public boolean getPrivateSessionAttributes()

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

Specified by:: getPrivateSessionAttributes in interface Portlet

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

isPrivateSessionAttributes

public boolean isPrivateSessionAttributes()

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

Specified by:: isPrivateSessionAttributes in interface Portlet

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

setPrivateSessionAttributes

public void setPrivateSessionAttributes(boolean privateSessionAttributes)

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

Specified by:: setPrivateSessionAttributes in interface Portlet

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

getRenderWeight

public int getRenderWeight()

Returns the render weight of the portlet.

Specified by:: getRenderWeight in interface Portlet

Returns:: the render weight of the portlet

setRenderWeight

public void setRenderWeight(int renderWeight)

Sets the render weight of the portlet.

Specified by:: setRenderWeight in interface Portlet

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

getAjaxable

public boolean getAjaxable()

Returns true if the portlet can be displayed via Ajax.

Specified by:: getAjaxable in interface Portlet

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

isAjaxable

public boolean isAjaxable()

Returns true if the portlet can be displayed via Ajax.

Specified by:: isAjaxable in interface Portlet

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

setAjaxable

public void setAjaxable(boolean ajaxable)

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

Specified by:: setAjaxable in interface Portlet

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

getHeaderPortalCss

public 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.

Specified by:: getHeaderPortalCss in interface Portlet

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

setHeaderPortalCss

public void setHeaderPortalCss(List<String> headerPortalCss)

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

Specified by:: setHeaderPortalCss in interface Portlet

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

getHeaderPortletCss

public 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.

Specified by:: getHeaderPortletCss in interface Portlet

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

setHeaderPortletCss

public void setHeaderPortletCss(List<String> headerPortletCss)

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

Specified by:: setHeaderPortletCss in interface Portlet

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

getHeaderPortalJavaScript

public 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.

Specified by:: getHeaderPortalJavaScript in interface Portlet

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

setHeaderPortalJavaScript

public void setHeaderPortalJavaScript(List<String> headerPortalJavaScript)

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

Specified by:: setHeaderPortalJavaScript in interface Portlet

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

getHeaderPortletJavaScript

public 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.

Specified by:: getHeaderPortletJavaScript in interface Portlet

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

setHeaderPortletJavaScript

public void setHeaderPortletJavaScript(List<String> headerPortletJavaScript)

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

Specified by:: setHeaderPortletJavaScript in interface Portlet

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

getFooterPortalCss

public 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.

Specified by:: getFooterPortalCss in interface Portlet

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

setFooterPortalCss

public void setFooterPortalCss(List<String> footerPortalCss)

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

Specified by:: setFooterPortalCss in interface Portlet

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

getFooterPortletCss

public 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.

Specified by:: getFooterPortletCss in interface Portlet

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

setFooterPortletCss

public void setFooterPortletCss(List<String> footerPortletCss)

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

Specified by:: setFooterPortletCss in interface Portlet

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

getFooterPortalJavaScript

public 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.

Specified by:: getFooterPortalJavaScript in interface Portlet

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

setFooterPortalJavaScript

public void setFooterPortalJavaScript(List<String> footerPortalJavaScript)

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

Specified by:: setFooterPortalJavaScript in interface Portlet

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

getFooterPortletJavaScript

public 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.

Specified by:: getFooterPortletJavaScript in interface Portlet

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

setFooterPortletJavaScript

public void setFooterPortletJavaScript(List<String> footerPortletJavaScript)

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

Specified by:: setFooterPortletJavaScript in interface Portlet

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

getCssClassWrapper

public String getCssClassWrapper()

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

Specified by:: getCssClassWrapper in interface Portlet

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

setCssClassWrapper

public void setCssClassWrapper(String cssClassWrapper)

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

Specified by:: setCssClassWrapper in interface Portlet

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

getFacebookIntegration

public String getFacebookIntegration()

Gets the Facebook integration method of the portlet.

Specified by:: getFacebookIntegration in interface Portlet

Returns:: the Facebook integration method of the portlet

setFacebookIntegration

public void setFacebookIntegration(String facebookIntegration)

Sets the Facebook integration method of the portlet.

Specified by:: setFacebookIntegration in interface Portlet

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

getAddDefaultResource

public boolean getAddDefaultResource()

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

Specified by:: getAddDefaultResource in interface Portlet

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

isAddDefaultResource

public boolean isAddDefaultResource()

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

Specified by:: isAddDefaultResource in interface Portlet

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

setAddDefaultResource

public void setAddDefaultResource(boolean addDefaultResource)

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

Specified by:: setAddDefaultResource in interface Portlet

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

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

getRolesArray

public String[] getRolesArray()

Gets an array of required roles of the portlet.

Specified by:: getRolesArray in interface Portlet

Returns:: an array of required roles of the portlet

setRolesArray

public void setRolesArray(String[] rolesArray)

Sets an array of required roles of the portlet.

Specified by:: setRolesArray in interface Portlet

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

getUnlinkedRoles

public Set<String> getUnlinkedRoles()

Gets the unlinked roles of the portlet.

Specified by:: getUnlinkedRoles in interface Portlet

Returns:: unlinked roles of the portlet

setUnlinkedRoles

public void setUnlinkedRoles(Set<String> unlinkedRoles)

Sets the unlinked roles of the portlet.

Specified by:: setUnlinkedRoles in interface Portlet

Parameters:: unlinkedRoles - the unlinked roles of the portlet

getRoleMappers

public Map<String,String> getRoleMappers()

Gets the role mappers of the portlet.

Specified by:: getRoleMappers in interface Portlet

Returns:: role mappers of the portlet

setRoleMappers

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

Sets the role mappers of the portlet.

Specified by:: setRoleMappers in interface Portlet

Parameters:: roleMappers - the role mappers of the portlet

linkRoles

public void linkRoles()

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

Specified by:: linkRoles in interface Portlet

hasRoleWithName

public boolean hasRoleWithName(String roleName)

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

Specified by:: hasRoleWithName in interface Portlet

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

hasAddPortletPermission

public boolean hasAddPortletPermission(long userId)

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

Specified by:: hasAddPortletPermission in interface Portlet

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

getSystem

public boolean getSystem()

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

Specified by:: getSystem in interface Portlet

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

isSystem

public boolean isSystem()

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

Specified by:: isSystem in interface Portlet

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

setSystem

public void setSystem(boolean system)

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

Specified by:: setSystem in interface Portlet

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

getInclude

public boolean getInclude()

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

Specified by:: getInclude in interface Portlet

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

isInclude

public boolean isInclude()

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

Specified by:: isInclude in interface Portlet

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

setInclude

public void setInclude(boolean include)

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

Specified by:: setInclude in interface Portlet

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

getInitParams

public Map<String,String> getInitParams()

Gets the init parameters of the portlet.

Specified by:: getInitParams in interface Portlet

Returns:: init parameters of the portlet

setInitParams

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

Sets the init parameters of the portlet.

Specified by:: setInitParams in interface Portlet

Parameters:: initParams - the init parameters of the portlet

getExpCache

public Integer getExpCache()

Gets expiration cache of the portlet.

Specified by:: getExpCache in interface Portlet

Returns:: expiration cache of the portlet

setExpCache

public void setExpCache(Integer expCache)

Sets expiration cache of the portlet.

Specified by:: setExpCache in interface Portlet

Parameters:: expCache - expiration cache of the portlet

getPortletModes

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

Gets the portlet modes of the portlet.

Specified by:: getPortletModes in interface Portlet

Returns:: portlet modes of the portlet

setPortletModes

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

Sets the portlet modes of the portlet.

Specified by:: setPortletModes in interface Portlet

Parameters:: portletModes - the portlet modes of the portlet

hasPortletMode

public boolean hasPortletMode(String mimeType,
                              PortletMode portletMode)

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

Specified by:: hasPortletMode in interface Portlet

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

getAllPortletModes

public Set<String> getAllPortletModes()

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

Specified by:: getAllPortletModes in interface Portlet

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

hasMultipleMimeTypes

public boolean hasMultipleMimeTypes()

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

Specified by:: hasMultipleMimeTypes in interface Portlet

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

getWindowStates

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

Gets the window states of the portlet.

Specified by:: getWindowStates in interface Portlet

Returns:: window states of the portlet

setWindowStates

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

Sets the window states of the portlet.

Specified by:: setWindowStates in interface Portlet

Parameters:: windowStates - the window states of the portlet

hasWindowState

public boolean hasWindowState(String mimeType,
                              WindowState windowState)

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

Specified by:: hasWindowState in interface Portlet

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

getAllWindowStates

public Set<String> getAllWindowStates()

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

Specified by:: getAllWindowStates in interface Portlet

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

getSupportedLocales

public Set<String> getSupportedLocales()

Gets the supported locales of the portlet.

Specified by:: getSupportedLocales in interface Portlet

Returns:: supported locales of the portlet

setSupportedLocales

public void setSupportedLocales(Set<String> supportedLocales)

Sets the supported locales of the portlet.

Specified by:: setSupportedLocales in interface Portlet

Parameters:: supportedLocales - the supported locales of the portlet

getResourceBundle

public String getResourceBundle()

Gets the resource bundle of the portlet.

Specified by:: getResourceBundle in interface Portlet

Returns:: resource bundle of the portlet

setResourceBundle

public void setResourceBundle(String resourceBundle)

Sets the resource bundle of the portlet.

Specified by:: setResourceBundle in interface Portlet

Parameters:: resourceBundle - the resource bundle of the portlet

getPortletInfo

public PortletInfo getPortletInfo()

Gets the portlet info of the portlet.

Specified by:: getPortletInfo in interface Portlet

Returns:: portlet info of the portlet

setPortletInfo

public void setPortletInfo(PortletInfo portletInfo)

Sets the portlet info of the portlet.

Specified by:: setPortletInfo in interface Portlet

Parameters:: portletInfo - the portlet info of the portlet

getPortletFilters

public Map<String,PortletFilter> getPortletFilters()

Gets the filters of the portlet.

Specified by:: getPortletFilters in interface Portlet

Returns:: filters of the portlet

setPortletFilters

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

Sets the filters of the portlet.

Specified by:: setPortletFilters in interface Portlet

Parameters:: portletFilters - the filters of the portlet

addProcessingEvent

public void addProcessingEvent(QName processingEvent)

Adds a supported processing event.

Specified by:: addProcessingEvent in interface Portlet

getProcessingEvent

public QName getProcessingEvent(String uri,
                                String localPart)

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

Specified by:: getProcessingEvent in interface Portlet

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

getProcessingEvents

public Set<QName> getProcessingEvents()

Gets the supported processing events of the portlet.

Specified by:: getProcessingEvents in interface Portlet

Returns:: supported processing events of the portlet

setProcessingEvents

public void setProcessingEvents(Set<QName> processingEvents)

Sets the supported processing events of the portlet.

Specified by:: setProcessingEvents in interface Portlet

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

addPublishingEvent

public void addPublishingEvent(QName publishingEvent)

Adds a supported publishing event.

Specified by:: addPublishingEvent in interface Portlet

getPublishingEvents

public Set<QName> getPublishingEvents()

Gets the supported publishing events of the portlet.

Specified by:: getPublishingEvents in interface Portlet

Returns:: supported publishing events of the portlet

setPublishingEvents

public void setPublishingEvents(Set<QName> publishingEvents)

Sets the supported publishing events of the portlet.

Specified by:: setPublishingEvents in interface Portlet

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

addPublicRenderParameter

public void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)

Adds a supported public render parameter.

Specified by:: addPublicRenderParameter in interface Portlet

Parameters:: publicRenderParameter - a supported public render parameter

getPublicRenderParameter

public PublicRenderParameter getPublicRenderParameter(String identifier)

Gets the supported public render parameter from an identifier.

Specified by:: getPublicRenderParameter in interface Portlet

Returns:: the supported public render parameter from an identifier

getPublicRenderParameter

public PublicRenderParameter getPublicRenderParameter(String uri,
                                                      String localPart)

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

Specified by:: getPublicRenderParameter in interface Portlet

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

getPublicRenderParameters

public Set<PublicRenderParameter> getPublicRenderParameters()

Gets the supported public render parameters of the portlet.

Specified by:: getPublicRenderParameters in interface Portlet

Returns:: the supported public render parameters of the portlet

setPublicRenderParameters

public void setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)

Sets the supported public render parameters of the portlet.

Specified by:: setPublicRenderParameters in interface Portlet

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

getContextPath

public String getContextPath()

Gets the servlet context path of the portlet.

Specified by:: getContextPath in interface Portlet

Returns:: the servlet context path of the portlet

getPortletApp

public PortletApp getPortletApp()

Get the application this portlet belongs to.

Specified by:: getPortletApp in interface Portlet

Returns:: the application this portlet belongs to

setPortletApp

public void setPortletApp(PortletApp portletApp)

Sets the application this portlet belongs to.

Specified by:: setPortletApp in interface Portlet

Parameters:: portletApp - the application this portlet belongs to

getClonedInstance

public Portlet getClonedInstance(String portletId)

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

Specified by:: getClonedInstance in interface Portlet

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

getStatic

public boolean getStatic()

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

Specified by:: getStatic in interface Portlet

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

isStatic

public boolean isStatic()

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

Specified by:: isStatic in interface Portlet

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

setStatic

public void setStatic(boolean staticPortlet)

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

Specified by:: setStatic in interface Portlet

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

getStaticStart

public boolean getStaticStart()

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

Specified by:: getStaticStart in interface Portlet

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

isStaticStart

public boolean isStaticStart()

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

Specified by:: isStaticStart in interface Portlet

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

setStaticStart

public void setStaticStart(boolean staticPortletStart)

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

Specified by:: setStaticStart in interface Portlet

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

getStaticEnd

public boolean getStaticEnd()

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

Specified by:: getStaticEnd in interface Portlet

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

isStaticEnd

public boolean isStaticEnd()

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

Specified by:: isStaticEnd in interface Portlet

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

getUndeployedPortlet

public boolean getUndeployedPortlet()

Returns true if the portlet is an undeployed portlet.

Specified by:: getUndeployedPortlet in interface Portlet

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

isUndeployedPortlet

public boolean isUndeployedPortlet()

Returns true if the portlet is an undeployed portlet.

Specified by:: isUndeployedPortlet in interface Portlet

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

setUndeployedPortlet

public void setUndeployedPortlet(boolean undeployedPortlet)

Set to true if the portlet is an undeployed portlet.

Specified by:: setUndeployedPortlet in interface Portlet

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

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

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.impl Class PortletImpl

PortletImpl

PortletImpl

PortletImpl

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

com.liferay.portal.model.impl
Class PortletImpl