com.liferay.portal.model.impl
Class PortletImpl

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

All Implemented Interfaces:

com.liferay.portal.model.BaseModel<com.liferay.portal.model.Portlet>, com.liferay.portal.model.ClassedModel, com.liferay.portal.model.PersistedModel, com.liferay.portal.model.Portlet, com.liferay.portal.model.PortletModel, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<com.liferay.portal.model.Portlet>

public class PortletImpl
extends PortletBaseImpl

Author:

Brian Wing Shun Chan

See Also:

Serialized Form

Field Summary

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

COLUMN_BITMASK_ENABLED, COMPANYID_COLUMN_BITMASK, DATA_SOURCE, ENTITY_CACHE_ENABLED, FINDER_CACHE_ENABLED, LOCK_EXPIRATION_TIME, PORTLETID_COLUMN_BITMASK, SESSION_FACTORY, TABLE_COLUMNS, TABLE_NAME, TABLE_SQL_CREATE, TABLE_SQL_DROP, TX_MANAGER

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

PORTLET_ID_ACCESSOR

Constructor Summary

PortletImpl()
Constructs a portlet with no parameters.

PortletImpl(long companyId, java.lang.String portletId)
Constructs a portlet with the specified parameters.

PortletImpl(java.lang.String portletId, com.liferay.portal.model.Portlet rootPortlet, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage, com.liferay.portal.model.PluginSetting pluginSetting, long companyId, long timestamp, java.lang.String icon, java.lang.String virtualPath, java.lang.String strutsPath, java.lang.String parentStrutsPath, java.lang.String portletName, java.lang.String displayName, java.lang.String portletClass, java.lang.String configurationActionClass, java.util.List<java.lang.String> indexerClasses, java.lang.String openSearchClass, java.util.List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries, java.lang.String portletURLClass, java.lang.String friendlyURLMapperClass, java.lang.String friendlyURLMapping, java.lang.String friendlyURLRoutes, java.lang.String urlEncoderClass, java.lang.String portletDataHandlerClass, java.lang.String portletLayoutListenerClass, java.lang.String pollerProcessorClass, java.lang.String popMessageListenerClass, java.lang.String socialActivityInterpreterClass, java.lang.String socialRequestInterpreterClass, java.lang.String webDAVStorageToken, java.lang.String webDAVStorageClass, java.lang.String xmlRpcMethodClass, java.lang.String controlPanelEntryCategory, double controlPanelEntryWeight, java.lang.String controlPanelClass, java.util.List<java.lang.String> assetRendererFactoryClasses, java.util.List<java.lang.String> atomCollectionAdapterClasses, java.util.List<java.lang.String> customAttributesDisplayClasses, java.lang.String permissionPropagatorClass, java.util.List<java.lang.String> workflowHandlerClasses, java.lang.String defaultPreferences, java.lang.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, java.lang.String userPrincipalStrategy, boolean privateRequestAttributes, boolean privateSessionAttributes, java.util.Set<java.lang.String> autopropagatedParameters, int actionTimeout, int renderTimeout, int renderWeight, boolean ajaxable, java.util.List<java.lang.String> headerPortalCss, java.util.List<java.lang.String> headerPortletCss, java.util.List<java.lang.String> headerPortalJavaScript, java.util.List<java.lang.String> headerPortletJavaScript, java.util.List<java.lang.String> footerPortalCss, java.util.List<java.lang.String> footerPortletCss, java.util.List<java.lang.String> footerPortalJavaScript, java.util.List<java.lang.String> footerPortletJavaScript, java.lang.String cssClassWrapper, java.lang.String facebookIntegration, boolean addDefaultResource, java.lang.String roles, java.util.Set<java.lang.String> unlinkedRoles, java.util.Map<java.lang.String,java.lang.String> roleMappers, boolean system, boolean active, boolean include, java.util.Map<java.lang.String,java.lang.String> initParams, java.lang.Integer expCache, java.util.Map<java.lang.String,java.util.Set<java.lang.String>> portletModes, java.util.Map<java.lang.String,java.util.Set<java.lang.String>> windowStates, java.util.Set<java.lang.String> supportedLocales, java.lang.String resourceBundle, com.liferay.portal.model.PortletInfo portletInfo, java.util.Map<java.lang.String,com.liferay.portal.model.PortletFilter> portletFilters, java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents, java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents, java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters, com.liferay.portal.model.PortletApp portletApp)
Constructs a portlet with the specified parameters.

Method Summary

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

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

persist

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

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

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

getLocale, isCachedModel, isEscapedModel, isNew, setCachedModel, setNew

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.liferay.portal.model.PortletModel

getActive, getCompanyId, getExpandoBridge, getId, getPortletId, getPrimaryKey, getPrimaryKeyObj, getRoles, hashCode, isActive, isCachedModel, isEscapedModel, isNew, setActive, setCachedModel, setCompanyId, setExpandoBridgeAttributes, setId, setNew, setPortletId, setPrimaryKey, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString, toXmlString

Methods inherited from interface com.liferay.portal.model.BaseModel

resetOriginalValues

Methods inherited from interface com.liferay.portal.model.ClassedModel

getModelClass, getModelClassName

Constructor Detail

PortletImpl

public PortletImpl()

Constructs a portlet with no parameters.

PortletImpl

public PortletImpl(long companyId,
                   java.lang.String portletId)

Constructs a portlet with the specified parameters.

PortletImpl

public PortletImpl(java.lang.String portletId,
                   com.liferay.portal.model.Portlet rootPortlet,
                   com.liferay.portal.kernel.plugin.PluginPackage pluginPackage,
                   com.liferay.portal.model.PluginSetting pluginSetting,
                   long companyId,
                   long timestamp,
                   java.lang.String icon,
                   java.lang.String virtualPath,
                   java.lang.String strutsPath,
                   java.lang.String parentStrutsPath,
                   java.lang.String portletName,
                   java.lang.String displayName,
                   java.lang.String portletClass,
                   java.lang.String configurationActionClass,
                   java.util.List<java.lang.String> indexerClasses,
                   java.lang.String openSearchClass,
                   java.util.List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries,
                   java.lang.String portletURLClass,
                   java.lang.String friendlyURLMapperClass,
                   java.lang.String friendlyURLMapping,
                   java.lang.String friendlyURLRoutes,
                   java.lang.String urlEncoderClass,
                   java.lang.String portletDataHandlerClass,
                   java.lang.String portletLayoutListenerClass,
                   java.lang.String pollerProcessorClass,
                   java.lang.String popMessageListenerClass,
                   java.lang.String socialActivityInterpreterClass,
                   java.lang.String socialRequestInterpreterClass,
                   java.lang.String webDAVStorageToken,
                   java.lang.String webDAVStorageClass,
                   java.lang.String xmlRpcMethodClass,
                   java.lang.String controlPanelEntryCategory,
                   double controlPanelEntryWeight,
                   java.lang.String controlPanelClass,
                   java.util.List<java.lang.String> assetRendererFactoryClasses,
                   java.util.List<java.lang.String> atomCollectionAdapterClasses,
                   java.util.List<java.lang.String> customAttributesDisplayClasses,
                   java.lang.String permissionPropagatorClass,
                   java.util.List<java.lang.String> workflowHandlerClasses,
                   java.lang.String defaultPreferences,
                   java.lang.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,
                   java.lang.String userPrincipalStrategy,
                   boolean privateRequestAttributes,
                   boolean privateSessionAttributes,
                   java.util.Set<java.lang.String> autopropagatedParameters,
                   int actionTimeout,
                   int renderTimeout,
                   int renderWeight,
                   boolean ajaxable,
                   java.util.List<java.lang.String> headerPortalCss,
                   java.util.List<java.lang.String> headerPortletCss,
                   java.util.List<java.lang.String> headerPortalJavaScript,
                   java.util.List<java.lang.String> headerPortletJavaScript,
                   java.util.List<java.lang.String> footerPortalCss,
                   java.util.List<java.lang.String> footerPortletCss,
                   java.util.List<java.lang.String> footerPortalJavaScript,
                   java.util.List<java.lang.String> footerPortletJavaScript,
                   java.lang.String cssClassWrapper,
                   java.lang.String facebookIntegration,
                   boolean addDefaultResource,
                   java.lang.String roles,
                   java.util.Set<java.lang.String> unlinkedRoles,
                   java.util.Map<java.lang.String,java.lang.String> roleMappers,
                   boolean system,
                   boolean active,
                   boolean include,
                   java.util.Map<java.lang.String,java.lang.String> initParams,
                   java.lang.Integer expCache,
                   java.util.Map<java.lang.String,java.util.Set<java.lang.String>> portletModes,
                   java.util.Map<java.lang.String,java.util.Set<java.lang.String>> windowStates,
                   java.util.Set<java.lang.String> supportedLocales,
                   java.lang.String resourceBundle,
                   com.liferay.portal.model.PortletInfo portletInfo,
                   java.util.Map<java.lang.String,com.liferay.portal.model.PortletFilter> portletFilters,
                   java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents,
                   java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents,
                   java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters,
                   com.liferay.portal.model.PortletApp portletApp)

Constructs a portlet with the specified parameters.

Method Detail

getRootPortlet

public com.liferay.portal.model.Portlet getRootPortlet()

Returns the root portlet of this portlet instance.

Returns:

the root portlet of this portlet instance

getRootPortletId

public java.lang.String getRootPortletId()

Returns the root portlet ID of the portlet.

Returns:

the root portlet ID of the portlet

getInstanceId

public java.lang.String getInstanceId()

Returns the instance ID of the portlet.

Returns:

the instance ID of the portlet

getPluginId

public java.lang.String getPluginId()

Returns the plugin ID of the portlet.

Returns:

the plugin ID of the portlet

getPluginType

public java.lang.String getPluginType()

Returns the plugin type of the portlet.

Returns:

the plugin type of the portlet

getPluginPackage

public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage()

Returns this portlet's plugin package.

Returns:

this portlet's plugin package

setPluginPackage

public void setPluginPackage(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)

Sets this portlet's plugin package.

Parameters:

pluginPackage - this portlet's plugin package

getDefaultPluginSetting

public com.liferay.portal.model.PluginSetting getDefaultPluginSetting()

Get the default plugin settings of the portlet.

Returns:

the plugin settings

setDefaultPluginSetting

public void setDefaultPluginSetting(com.liferay.portal.model.PluginSetting pluginSetting)

Sets the default plugin settings of the portlet.

Parameters:

pluginSetting - the plugin setting

getTimestamp

public long getTimestamp()

Returns the timestamp of the portlet.

Returns:

the timestamp of the portlet

setTimestamp

public void setTimestamp(long timestamp)

Sets the timestamp of the portlet.

Parameters:

timestamp - the timestamp of the portlet

getIcon

public java.lang.String getIcon()

Returns the icon of the portlet.

Returns:

the icon of the portlet

setIcon

public void setIcon(java.lang.String icon)

Sets the icon of the portlet.

Parameters:

icon - the icon of the portlet

getVirtualPath

public java.lang.String getVirtualPath()

Returns the virtual path of the portlet.

Returns:

the virtual path of the portlet

setVirtualPath

public void setVirtualPath(java.lang.String virtualPath)

Sets the virtual path of the portlet.

Parameters:

virtualPath - the virtual path of the portlet

getStrutsPath

public java.lang.String getStrutsPath()

Returns the struts path of the portlet.

Returns:

the struts path of the portlet

setStrutsPath

public void setStrutsPath(java.lang.String strutsPath)

Sets the struts path of the portlet.

Parameters:

strutsPath - the struts path of the portlet

getParentStrutsPath

public java.lang.String getParentStrutsPath()

Returns the parent struts path of the portlet.

Returns:

the parent struts path of the portlet.

setParentStrutsPath

public void setParentStrutsPath(java.lang.String parentStrutsPath)

Sets the parent struts path of the portlet.

Parameters:

parentStrutsPath - the parent struts path of the portlet

getPortletName

public java.lang.String getPortletName()

Returns the name of the portlet.

Returns:

the display name of the portlet

setPortletName

public void setPortletName(java.lang.String portletName)

Sets the name of the portlet.

Parameters:

portletName - the name of the portlet

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of the portlet.

Returns:

the display name of the portlet

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the display name of the portlet.

Parameters:

displayName - the display name of the portlet

getPortletClass

public java.lang.String getPortletClass()

Returns the name of the portlet class of the portlet.

Returns:

the name of the portlet class of the portlet

setPortletClass

public void setPortletClass(java.lang.String portletClass)

Sets the name of the portlet class of the portlet.

Parameters:

portletClass - the name of the portlet class of the portlet

getConfigurationActionClass

public java.lang.String getConfigurationActionClass()

Returns the configuration action class of the portlet.

Returns:

the configuration action class of the portlet

setConfigurationActionClass

public void setConfigurationActionClass(java.lang.String configurationActionClass)

Sets the configuration action class of the portlet.

Parameters:

configurationActionClass - the configuration action class of the portlet

getConfigurationActionInstance

public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance()

Returns the configuration action instance of the portlet.

Returns:

the configuration action instance of the portlet

getIndexerClasses

public java.util.List<java.lang.String> getIndexerClasses()

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

Returns:

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

setIndexerClasses

public void setIndexerClasses(java.util.List<java.lang.String> indexerClasses)

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

Parameters:

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

getIndexerInstances

public java.util.List<com.liferay.portal.kernel.search.Indexer> getIndexerInstances()

Returns the indexer instances of the portlet.

Returns:

the indexer instances of the portlet

getOpenSearchClass

public java.lang.String getOpenSearchClass()

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

Returns:

the name of the open search class of the portlet

setOpenSearchClass

public void setOpenSearchClass(java.lang.String openSearchClass)

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

Parameters:

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

getOpenSearchInstance

public com.liferay.portal.kernel.search.OpenSearch getOpenSearchInstance()

Returns the indexer instance of the portlet.

Returns:

the indexer instance of the portlet

addSchedulerEntry

public void addSchedulerEntry(com.liferay.portal.kernel.scheduler.SchedulerEntry schedulerEntry)

Adds a scheduler entry.

getSchedulerEntries

public java.util.List<com.liferay.portal.kernel.scheduler.SchedulerEntry> getSchedulerEntries()

Returns the scheduler entries of the portlet.

Returns:

the scheduler entries of the portlet

setSchedulerEntries

public void setSchedulerEntries(java.util.List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries)

Sets the scheduler entries of the portlet.

Parameters:

schedulerEntries - the scheduler entries of the portlet

getPortletURLClass

public java.lang.String getPortletURLClass()

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

Returns:

the name of the portlet URL class of the portlet

setPortletURLClass

public void setPortletURLClass(java.lang.String portletURLClass)

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

Parameters:

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

getFriendlyURLMapperClass

public java.lang.String getFriendlyURLMapperClass()

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

Returns:

the name of the friendly URL mapper class of the portlet

setFriendlyURLMapperClass

public void setFriendlyURLMapperClass(java.lang.String friendlyURLMapperClass)

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

Parameters:

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

getFriendlyURLMapperInstance

public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance()

Returns the friendly URL mapper instance of the portlet.

Returns:

the friendly URL mapper instance of the portlet

getFriendlyURLMapping

public java.lang.String getFriendlyURLMapping()

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

Returns:

the name of the friendly URL mapping of the portlet

setFriendlyURLMapping

public void setFriendlyURLMapping(java.lang.String friendlyURLMapping)

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

Parameters:

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

getFriendlyURLRoutes

public java.lang.String getFriendlyURLRoutes()

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

Returns:

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

setFriendlyURLRoutes

public void setFriendlyURLRoutes(java.lang.String friendlyURLRoutes)

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

Parameters:

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

getURLEncoderClass

public java.lang.String getURLEncoderClass()

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

Returns:

the name of the URL encoder class of the portlet

setURLEncoderClass

public void setURLEncoderClass(java.lang.String urlEncoderClass)

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

Parameters:

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

getURLEncoderInstance

public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance()

Returns the URL encoder instance of the portlet.

Returns:

the URL encoder instance of the portlet

getPortletDataHandlerClass

public java.lang.String getPortletDataHandlerClass()

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

Returns:

the name of the portlet data handler class of the portlet

setPortletDataHandlerClass

public void setPortletDataHandlerClass(java.lang.String portletDataHandlerClass)

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

Parameters:

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

getPortletDataHandlerInstance

public com.liferay.portal.kernel.lar.PortletDataHandler getPortletDataHandlerInstance()

Returns the portlet data handler instance of the portlet.

Returns:

the portlet data handler instance of the portlet

getPortletLayoutListenerClass

public java.lang.String getPortletLayoutListenerClass()

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

Returns:

the name of the portlet layout listener class of the portlet

setPortletLayoutListenerClass

public void setPortletLayoutListenerClass(java.lang.String portletLayoutListenerClass)

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

Parameters:

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

getPortletLayoutListenerInstance

public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance()

Returns the portlet layout listener instance of the portlet.

Returns:

the portlet layout listener instance of the portlet

getPollerProcessorClass

public java.lang.String getPollerProcessorClass()

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

Returns:

the name of the poller processor class of the portlet

setPollerProcessorClass

public void setPollerProcessorClass(java.lang.String pollerProcessorClass)

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

Parameters:

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

getPollerProcessorInstance

public com.liferay.portal.kernel.poller.PollerProcessor getPollerProcessorInstance()

Returns the poller processor instance of the portlet.

Returns:

the poller processor instance of the portlet

getPopMessageListenerClass

public java.lang.String getPopMessageListenerClass()

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

Returns:

the name of the POP message listener class of the portlet

setPopMessageListenerClass

public void setPopMessageListenerClass(java.lang.String popMessageListenerClass)

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

Parameters:

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

getPopMessageListenerInstance

public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance()

Returns the POP message listener instance of the portlet.

Returns:

the POP message listener instance of the portlet

getSocialActivityInterpreterClass

public java.lang.String getSocialActivityInterpreterClass()

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

Returns:

the name of the social activity interpreter class of the portlet

setSocialActivityInterpreterClass

public void setSocialActivityInterpreterClass(java.lang.String socialActivityInterpreterClass)

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

Parameters:

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

getSocialActivityInterpreterInstance

public com.liferay.portlet.social.model.SocialActivityInterpreter getSocialActivityInterpreterInstance()

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

Returns:

the name of the social activity interpreter instance of the portlet

getSocialRequestInterpreterClass

public java.lang.String getSocialRequestInterpreterClass()

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

Returns:

the name of the social request interpreter class of the portlet

setSocialRequestInterpreterClass

public void setSocialRequestInterpreterClass(java.lang.String socialRequestInterpreterClass)

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

Parameters:

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

getSocialRequestInterpreterInstance

public com.liferay.portlet.social.model.SocialRequestInterpreter getSocialRequestInterpreterInstance()

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

Returns:

the name of the social request interpreter instance of the portlet

getWebDAVStorageToken

public java.lang.String getWebDAVStorageToken()

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

Returns:

the name of the WebDAV storage token of the portlet

setWebDAVStorageToken

public void setWebDAVStorageToken(java.lang.String webDAVStorageToken)

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

Parameters:

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

getWebDAVStorageClass

public java.lang.String getWebDAVStorageClass()

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

Returns:

the name of the WebDAV storage class of the portlet

setWebDAVStorageClass

public void setWebDAVStorageClass(java.lang.String webDAVStorageClass)

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

Parameters:

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

getWebDAVStorageInstance

public com.liferay.portal.kernel.webdav.WebDAVStorage getWebDAVStorageInstance()

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

Returns:

the name of the WebDAV storage instance of the portlet

getXmlRpcMethodClass

public java.lang.String getXmlRpcMethodClass()

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

Returns:

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

setXmlRpcMethodClass

public void setXmlRpcMethodClass(java.lang.String xmlRpcMethodClass)

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

Parameters:

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

getXmlRpcMethodInstance

public com.liferay.portal.kernel.xmlrpc.Method getXmlRpcMethodInstance()

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

Returns:

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

getControlPanelEntryCategory

public java.lang.String getControlPanelEntryCategory()

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

Returns:

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

setControlPanelEntryCategory

public void setControlPanelEntryCategory(java.lang.String controlPanelEntryCategory)

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

Parameters:

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

getControlPanelEntryWeight

public double getControlPanelEntryWeight()

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

Returns:

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

setControlPanelEntryWeight

public void setControlPanelEntryWeight(double controlPanelEntryWeight)

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

Parameters:

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

getControlPanelEntryClass

public java.lang.String getControlPanelEntryClass()

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

Returns:

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

setControlPanelEntryClass

public void setControlPanelEntryClass(java.lang.String controlPanelEntryClass)

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

Parameters:

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

getControlPanelEntryInstance

public com.liferay.portlet.ControlPanelEntry getControlPanelEntryInstance()

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

Returns:

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

getAssetRendererFactoryClasses

public java.util.List<java.lang.String> getAssetRendererFactoryClasses()

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

Returns:

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

setAssetRendererFactoryClasses

public void setAssetRendererFactoryClasses(java.util.List<java.lang.String> assetRendererFactoryClasses)

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

Parameters:

assetRendererFactoryClasses - the names of the classes that represent asset types associated with the portlet

getAssetRendererFactoryInstances

public java.util.List<com.liferay.portlet.asset.model.AssetRendererFactory> getAssetRendererFactoryInstances()

Returns the asset type instances of the portlet.

Returns:

the asset type instances of the portlet

getAtomCollectionAdapterClasses

public java.util.List<java.lang.String> getAtomCollectionAdapterClasses()

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

Returns:

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

setAtomCollectionAdapterClasses

public void setAtomCollectionAdapterClasses(java.util.List<java.lang.String> atomCollectionAdapterClasses)

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

Parameters:

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

getAtomCollectionAdapterInstances

public java.util.List<com.liferay.portal.kernel.atom.AtomCollectionAdapter<?>> getAtomCollectionAdapterInstances()

Returns the atom collection adapter instances of the portlet.

Returns:

the atom collection adapter instances of the portlet

getCustomAttributesDisplayClasses

public java.util.List<java.lang.String> getCustomAttributesDisplayClasses()

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

Returns:

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

setCustomAttributesDisplayClasses

public void setCustomAttributesDisplayClasses(java.util.List<java.lang.String> customAttributesDisplayClasses)

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

Parameters:

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

getCustomAttributesDisplayInstances

public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplayInstances()

Returns the custom attribute display instances of the portlet.

Returns:

the custom attribute display instances of the portlet

getPermissionPropagatorClass

public java.lang.String getPermissionPropagatorClass()

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

Returns:

the name of the permission propagator class of the portlet

setPermissionPropagatorClass

public void setPermissionPropagatorClass(java.lang.String permissionPropagatorClass)

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

getPermissionPropagatorInstance

public com.liferay.portal.security.permission.PermissionPropagator getPermissionPropagatorInstance()

Returns the permission propagator instance of the portlet.

Returns:

the permission propagator instance of the portlet

getWorkflowHandlerClasses

public java.util.List<java.lang.String> getWorkflowHandlerClasses()

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

Returns:

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

setWorkflowHandlerClasses

public void setWorkflowHandlerClasses(java.util.List<java.lang.String> workflowHandlerClasses)

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

Parameters:

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

getWorkflowHandlerInstances

public java.util.List<com.liferay.portal.kernel.workflow.WorkflowHandler> getWorkflowHandlerInstances()

Returns the workflow handler instances of the portlet.

Returns:

the workflow handler instances of the portlet

getDefaultPreferences

public java.lang.String getDefaultPreferences()

Returns the default preferences of the portlet.

Returns:

the default preferences of the portlet

setDefaultPreferences

public void setDefaultPreferences(java.lang.String defaultPreferences)

Sets the default preferences of the portlet.

Parameters:

defaultPreferences - the default preferences of the portlet

getPreferencesValidator

public java.lang.String getPreferencesValidator()

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

Returns:

the name of the preferences validator class of the portlet

setPreferencesValidator

public void setPreferencesValidator(java.lang.String preferencesValidator)

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

Parameters:

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

getPreferencesCompanyWide

public boolean getPreferencesCompanyWide()

Returns true if preferences are shared across the entire company.

Returns:

true if preferences are shared across the entire company

isPreferencesCompanyWide

public boolean isPreferencesCompanyWide()

Returns true if preferences are shared across the entire company.

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.

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.

Returns:

true if preferences are unique per layout

isPreferencesUniquePerLayout

public boolean isPreferencesUniquePerLayout()

Returns true if preferences are unique per layout.

Returns:

true if preferences are unique per layout

setPreferencesUniquePerLayout

public void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)

Set to true if preferences are unique per layout.

Parameters:

preferencesUniquePerLayout - boolean value for whether preferences are unique per layout

getPreferencesOwnedByGroup

public boolean getPreferencesOwnedByGroup()

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

Returns:

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

isPreferencesOwnedByGroup

public boolean isPreferencesOwnedByGroup()

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

Returns:

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

setPreferencesOwnedByGroup

public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)

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

Parameters:

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

getUseDefaultTemplate

public boolean getUseDefaultTemplate()

Returns true if the portlet uses the default template.

Returns:

true if the portlet uses the default template

isUseDefaultTemplate

public boolean isUseDefaultTemplate()

Returns true if the portlet uses the default template.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Returns:

true if the portlet supports remoting

isRemoteable

public boolean isRemoteable()

Returns true if the portlet supports remoting.

Returns:

true if the portlet supports remoting

setRemoteable

public void setRemoteable(boolean remoteable)

Set to true if the portlet supports remoting

Parameters:

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

getScopeable

public boolean getScopeable()

Returns true if the portlet supports scoping of data.

Returns:

true if the portlet supports scoping of data

isScopeable

public boolean isScopeable()

Returns true if the portlet supports scoping of data.

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.

Parameters:

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

getUserPrincipalStrategy

public java.lang.String getUserPrincipalStrategy()

Returns the user principal strategy of the portlet.

Returns:

the user principal strategy of the portlet

setUserPrincipalStrategy

public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy)

Sets the user principal strategy of the 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.

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.

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.

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.

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.

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.

Parameters:

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

getAutopropagatedParameters

public java.util.Set<java.lang.String> getAutopropagatedParameters()

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

Returns:

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

setAutopropagatedParameters

public void setAutopropagatedParameters(java.util.Set<java.lang.String> autopropagatedParameters)

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

Parameters:

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

getActionTimeout

public int getActionTimeout()

Returns the action timeout of the portlet.

Returns:

the action timeout of the portlet

setActionTimeout

public void setActionTimeout(int actionTimeout)

Sets the action timeout of the portlet.

Parameters:

actionTimeout - the action timeout of the portlet

getRenderTimeout

public int getRenderTimeout()

Returns the render timeout of the portlet.

Returns:

the render timeout of the portlet

setRenderTimeout

public void setRenderTimeout(int renderTimeout)

Sets the render timeout of the portlet.

Parameters:

renderTimeout - the render timeout of the portlet

getRenderWeight

public int getRenderWeight()

Returns the render weight of the portlet.

Returns:

the render weight of the portlet

setRenderWeight

public void setRenderWeight(int renderWeight)

Sets the render weight of the portlet.

Parameters:

renderWeight - int value for the render weight of the portlet

getAjaxable

public boolean getAjaxable()

Returns true if the portlet can be displayed via Ajax.

Returns:

true if the portlet can be displayed via Ajax

isAjaxable

public boolean isAjaxable()

Returns true if the portlet can be displayed via Ajax.

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.

Parameters:

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

getHeaderPortalCss

public java.util.List<java.lang.String> getHeaderPortalCss()

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

Returns:

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

setHeaderPortalCss

public void setHeaderPortalCss(java.util.List<java.lang.String> headerPortalCss)

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

Parameters:

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

getHeaderPortletCss

public java.util.List<java.lang.String> getHeaderPortletCss()

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

Returns:

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

setHeaderPortletCss

public void setHeaderPortletCss(java.util.List<java.lang.String> headerPortletCss)

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

Parameters:

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

getHeaderPortalJavaScript

public java.util.List<java.lang.String> getHeaderPortalJavaScript()

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

Returns:

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

setHeaderPortalJavaScript

public void setHeaderPortalJavaScript(java.util.List<java.lang.String> headerPortalJavaScript)

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

Parameters:

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

getHeaderPortletJavaScript

public java.util.List<java.lang.String> getHeaderPortletJavaScript()

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

Returns:

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

setHeaderPortletJavaScript

public void setHeaderPortletJavaScript(java.util.List<java.lang.String> headerPortletJavaScript)

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

Parameters:

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

getFooterPortalCss

public java.util.List<java.lang.String> getFooterPortalCss()

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

Returns:

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

setFooterPortalCss

public void setFooterPortalCss(java.util.List<java.lang.String> footerPortalCss)

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

Parameters:

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

getFooterPortletCss

public java.util.List<java.lang.String> getFooterPortletCss()

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

Returns:

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

setFooterPortletCss

public void setFooterPortletCss(java.util.List<java.lang.String> footerPortletCss)

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

Parameters:

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

getFooterPortalJavaScript

public java.util.List<java.lang.String> getFooterPortalJavaScript()

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

Returns:

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

setFooterPortalJavaScript

public void setFooterPortalJavaScript(java.util.List<java.lang.String> footerPortalJavaScript)

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

Parameters:

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

getFooterPortletJavaScript

public java.util.List<java.lang.String> getFooterPortletJavaScript()

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

Returns:

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

setFooterPortletJavaScript

public void setFooterPortletJavaScript(java.util.List<java.lang.String> footerPortletJavaScript)

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

Parameters:

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

getCssClassWrapper

public java.lang.String getCssClassWrapper()

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

Returns:

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

setCssClassWrapper

public void setCssClassWrapper(java.lang.String cssClassWrapper)

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

Parameters:

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

getFacebookIntegration

public java.lang.String getFacebookIntegration()

Returns the Facebook integration method of the portlet.

Returns:

the Facebook integration method of the portlet

setFacebookIntegration

public void setFacebookIntegration(java.lang.String facebookIntegration)

Sets the Facebook integration method of the 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.

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.

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.

Parameters:

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

setRoles

public void setRoles(java.lang.String roles)

Sets a string of ordered comma delimited portlet IDs.

Specified by:

setRoles in interface com.liferay.portal.model.Portlet

Specified by:

setRoles in interface com.liferay.portal.model.PortletModel

Overrides:

setRoles in class PortletModelImpl

Parameters:

roles - a string of ordered comma delimited portlet IDs

getRolesArray

public java.lang.String[] getRolesArray()

Returns an array of required roles of the portlet.

Returns:

an array of required roles of the portlet

setRolesArray

public void setRolesArray(java.lang.String[] rolesArray)

Sets an array of required roles of the portlet.

Parameters:

rolesArray - an array of required roles of the portlet

getUnlinkedRoles

public java.util.Set<java.lang.String> getUnlinkedRoles()

Returns the unlinked roles of the portlet.

Returns:

unlinked roles of the portlet

setUnlinkedRoles

public void setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles)

Sets the unlinked roles of the portlet.

Parameters:

unlinkedRoles - the unlinked roles of the portlet

getRoleMappers

public java.util.Map<java.lang.String,java.lang.String> getRoleMappers()

Returns the role mappers of the portlet.

Returns:

role mappers of the portlet

setRoleMappers

public void setRoleMappers(java.util.Map<java.lang.String,java.lang.String> roleMappers)

Sets the role mappers of the 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.

hasRoleWithName

public boolean hasRoleWithName(java.lang.String roleName)

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

Returns:

true if the portlet has a role with the specified name

hasAddPortletPermission

public boolean hasAddPortletPermission(long userId)

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

Returns:

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

getSystem

public boolean getSystem()

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

Returns:

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

isSystem

public boolean isSystem()

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

Returns:

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

setSystem

public void setSystem(boolean system)

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

Parameters:

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

getInclude

public boolean getInclude()

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

Returns:

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

isInclude

public boolean isInclude()

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

Returns:

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

setInclude

public void setInclude(boolean include)

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

Parameters:

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

getReady

public boolean getReady()

Returns true if the portlet is ready to be used.

Returns:

true if the portlet is ready to be used

isReady

public boolean isReady()

Returns true if the portlet is ready to be used.

Returns:

true if the portlet is ready to be used

setReady

public void setReady(boolean ready)

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

Parameters:

ready - whether the portlet is ready to be used

getInitParams

public java.util.Map<java.lang.String,java.lang.String> getInitParams()

Returns the init parameters of the portlet.

Returns:

init parameters of the portlet

setInitParams

public void setInitParams(java.util.Map<java.lang.String,java.lang.String> initParams)

Sets the init parameters of the portlet.

Parameters:

initParams - the init parameters of the portlet

getExpCache

public java.lang.Integer getExpCache()

Returns expiration cache of the portlet.

Returns:

expiration cache of the portlet

setExpCache

public void setExpCache(java.lang.Integer expCache)

Sets expiration cache of the portlet.

Parameters:

expCache - expiration cache of the portlet

getPortletModes

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getPortletModes()

Returns the portlet modes of the portlet.

Returns:

portlet modes of the portlet

setPortletModes

public void setPortletModes(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> portletModes)

Sets the portlet modes of the portlet.

Parameters:

portletModes - the portlet modes of the portlet

hasPortletMode

public boolean hasPortletMode(java.lang.String mimeType,
                              javax.portlet.PortletMode portletMode)

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

Returns:

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

getAllPortletModes

public java.util.Set<java.lang.String> getAllPortletModes()

Returns a list of all portlet modes supported by the 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.

Returns:

true if the portlet supports more than one mime type

getWindowStates

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getWindowStates()

Returns the window states of the portlet.

Returns:

window states of the portlet

setWindowStates

public void setWindowStates(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> windowStates)

Sets the window states of the portlet.

Parameters:

windowStates - the window states of the portlet

hasWindowState

public boolean hasWindowState(java.lang.String mimeType,
                              javax.portlet.WindowState windowState)

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

Returns:

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

getAllWindowStates

public java.util.Set<java.lang.String> getAllWindowStates()

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

Returns:

a list of all window states supported by the portlet

getSupportedLocales

public java.util.Set<java.lang.String> getSupportedLocales()

Returns the supported locales of the portlet.

Returns:

supported locales of the portlet

setSupportedLocales

public void setSupportedLocales(java.util.Set<java.lang.String> supportedLocales)

Sets the supported locales of the portlet.

Parameters:

supportedLocales - the supported locales of the portlet

getResourceBundle

public java.lang.String getResourceBundle()

Returns the resource bundle of the portlet.

Returns:

resource bundle of the portlet

setResourceBundle

public void setResourceBundle(java.lang.String resourceBundle)

Sets the resource bundle of the portlet.

Parameters:

resourceBundle - the resource bundle of the portlet

getPortletInfo

public com.liferay.portal.model.PortletInfo getPortletInfo()

Returns the portlet info of the portlet.

Returns:

portlet info of the portlet

setPortletInfo

public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo)

Sets the portlet info of the portlet.

Parameters:

portletInfo - the portlet info of the portlet

getPortletFilters

public java.util.Map<java.lang.String,com.liferay.portal.model.PortletFilter> getPortletFilters()

Returns the filters of the portlet.

Returns:

filters of the portlet

setPortletFilters

public void setPortletFilters(java.util.Map<java.lang.String,com.liferay.portal.model.PortletFilter> portletFilters)

Sets the filters of the portlet.

Parameters:

portletFilters - the filters of the portlet

addProcessingEvent

public void addProcessingEvent(com.liferay.portal.kernel.xml.QName processingEvent)

Adds a supported processing event.

getProcessingEvent

public com.liferay.portal.kernel.xml.QName getProcessingEvent(java.lang.String uri,
                                                              java.lang.String localPart)

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

Returns:

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

getProcessingEvents

public java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents()

Returns the supported processing events of the portlet.

Returns:

supported processing events of the portlet

setProcessingEvents

public void setProcessingEvents(java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents)

Sets the supported processing events of the portlet.

Parameters:

processingEvents - the supported processing events of the portlet

addPublishingEvent

public void addPublishingEvent(com.liferay.portal.kernel.xml.QName publishingEvent)

Adds a supported publishing event.

getPublishingEvents

public java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents()

Returns the supported publishing events of the portlet.

Returns:

supported publishing events of the portlet

setPublishingEvents

public void setPublishingEvents(java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents)

Sets the supported publishing events of the portlet.

Parameters:

publishingEvents - the supported publishing events of the portlet

addPublicRenderParameter

public void addPublicRenderParameter(com.liferay.portal.model.PublicRenderParameter publicRenderParameter)

Adds a supported public render parameter.

Parameters:

publicRenderParameter - a supported public render parameter

getPublicRenderParameter

public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(java.lang.String identifier)

Returns the supported public render parameter from an identifier.

Returns:

the supported public render parameter from an identifier

getPublicRenderParameter

public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(java.lang.String uri,
                                                                               java.lang.String localPart)

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

Returns:

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

getPublicRenderParameters

public java.util.Set<com.liferay.portal.model.PublicRenderParameter> getPublicRenderParameters()

Returns the supported public render parameters of the portlet.

Returns:

the supported public render parameters of the portlet

setPublicRenderParameters

public void setPublicRenderParameters(java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters)

Sets the supported public render parameters of the portlet.

Parameters:

publicRenderParameters - the supported public render parameters of the portlet

getContextPath

public java.lang.String getContextPath()

Returns the servlet context path of the portlet.

Returns:

the servlet context path of the portlet

getStaticResourcePath

public java.lang.String getStaticResourcePath()

Returns the path for static resources served by this portlet.

Returns:

the path for static resources served by this portlet

getPortletApp

public com.liferay.portal.model.PortletApp getPortletApp()

Returns this portlet's application.

Returns:

this portlet's application

setPortletApp

public void setPortletApp(com.liferay.portal.model.PortletApp portletApp)

Sets this portlet's application.

Parameters:

portletApp - this portlet's application

getClonedInstance

public com.liferay.portal.model.Portlet getClonedInstance(java.lang.String portletId)

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

Parameters:

portletId - the cloned instance portlet ID

Returns:

a cloned instance of the portlet

getStatic

public boolean getStatic()

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

Returns:

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

isStatic

public boolean isStatic()

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

Returns:

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

setStatic

public void setStatic(boolean staticPortlet)

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

Parameters:

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

getStaticStart

public boolean getStaticStart()

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

Returns:

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

isStaticStart

public boolean isStaticStart()

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

Returns:

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

setStaticStart

public void setStaticStart(boolean staticPortletStart)

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

Parameters:

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

getStaticEnd

public boolean getStaticEnd()

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

Returns:

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

isStaticEnd

public boolean isStaticEnd()

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

Returns:

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

getUndeployedPortlet

public boolean getUndeployedPortlet()

Returns true if the portlet is an undeployed portlet.

Returns:

true if the portlet is a placeholder of an undeployed portlet

isUndeployedPortlet

public boolean isUndeployedPortlet()

Returns true if the portlet is an undeployed portlet.

Returns:

true if the portlet is a placeholder of an undeployed portlet

setUndeployedPortlet

public void setUndeployedPortlet(boolean undeployedPortlet)

Set to true if the portlet is an undeployed portlet.

Parameters:

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

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

Specified by:

clone in interface com.liferay.portal.model.BaseModel<com.liferay.portal.model.Portlet>

Specified by:

clone in interface com.liferay.portal.model.Portlet

Specified by:

clone in interface com.liferay.portal.model.PortletModel

Overrides:

clone in class PortletModelImpl

Returns:

a copy of this object

compareTo

public int compareTo(com.liferay.portal.model.Portlet portlet)

Compares this portlet to the specified object.

Specified by:

compareTo in interface com.liferay.portal.model.Portlet

Specified by:

compareTo in interface com.liferay.portal.model.PortletModel

Specified by:

compareTo in interface java.lang.Comparable<com.liferay.portal.model.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(java.lang.Object obj)

Checks whether this portlet is equal to the specified object.

Specified by:

equals in interface com.liferay.portal.model.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