com.liferay.portal.model.impl
Class PortletImpl

java.lang.Object
  extended bycom.liferay.portal.model.impl.BaseModelImpl
      extended bycom.liferay.portal.model.impl.PortletModelImpl
          extended bycom.liferay.portal.model.impl.PortletImpl
All Implemented Interfaces:
com.liferay.portal.model.BaseModel, java.lang.Cloneable, java.lang.Comparable, com.liferay.portal.model.Portlet, com.liferay.portal.model.PortletModel, java.io.Serializable

public class PortletImpl
extends PortletModelImpl
implements com.liferay.portal.model.Portlet

View Source

Author:
Brian Wing Shun Chan
See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_PREFERENCES
          Default preferences.
static java.lang.String INSTANCE_SEPARATOR
          Instance separator.
static java.lang.String LAYOUT_SEPARATOR
          Layout separator.
static java.lang.String PLUGIN_TYPE
          Plugin type
static java.lang.String USER_PRINCIPAL_STRATEGY_SCREEN_NAME
          User principal strategy for screen name.
static java.lang.String USER_PRINCIPAL_STRATEGY_USER_ID
          User principal strategy for screen name.
static java.lang.String WAR_SEPARATOR
          War file separator.
 
Fields inherited from class com.liferay.portal.model.impl.PortletModelImpl
LOCK_EXPIRATION_TIME, TABLE_COLUMNS, TABLE_NAME, TABLE_SQL_CREATE, TABLE_SQL_DROP, XSS_ALLOW_BY_MODEL, XSS_ALLOW_PORTLETID, XSS_ALLOW_ROLES
 
Fields inherited from class com.liferay.portal.model.impl.BaseModelImpl
XSS_ALLOW
 
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.kernel.plugin.PluginPackage pluginPackage, com.liferay.portal.model.PluginSetting pluginSetting, long companyId, java.lang.String icon, java.lang.String virtualPath, java.lang.String strutsPath, java.lang.String displayName, java.lang.String portletClass, java.lang.String configurationActionClass, java.lang.String indexerClass, java.lang.String openSearchClass, java.lang.String schedulerClass, java.lang.String portletURLClass, java.lang.String friendlyURLMapperClass, java.lang.String urlEncoderClass, java.lang.String portletDataHandlerClass, java.lang.String portletLayoutListenerClass, java.lang.String smtpMessageListenerClass, java.lang.String defaultPreferences, java.lang.String prefsValidator, boolean prefsCompanyWide, boolean prefsUniquePerLayout, boolean prefsOwnedByGroup, boolean useDefaultTemplate, boolean showPortletAccessDenied, boolean showPortletInactive, boolean actionURLRedirect, boolean restoreCurrentView, boolean maximizeEdit, boolean maximizeHelp, boolean popUpPrint, boolean layoutCacheable, boolean instanceable, java.lang.String userPrincipalStrategy, boolean privateRequestAttributes, boolean privateSessionAttributes, int renderWeight, boolean ajaxable, java.util.List headerPortalCss, java.util.List headerPortletCss, java.util.List headerPortalJavaScript, java.util.List headerPortletJavaScript, java.util.List footerPortalCss, java.util.List footerPortletCss, java.util.List footerPortalJavaScript, java.util.List footerPortletJavaScript, boolean addDefaultResource, java.lang.String roles, java.util.Set unlinkedRoles, java.util.Map roleMappers, boolean system, boolean active, boolean include, java.util.Map initParams, java.lang.Integer expCache, java.util.Map portletModes, java.util.Set supportedLocales, java.lang.String resourceBundle, com.liferay.portal.model.PortletInfo portletInfo, java.util.Set userAttributes, java.util.Map customUserAttributes, java.lang.String servletContextName, java.util.List servletURLPatterns)
          Constructs a portlet with the specified parameters.
 
Method Summary
 java.lang.Object clone()
          Creates and returns a copy of this object.
 int compareTo(java.lang.Object obj)
          Compares this portlet to the specified object.
 boolean equals(java.lang.Object obj)
          Checks whether this portlet is equal to the specified object.
 boolean getActionURLRedirect()
          Returns true if an action URL for this portlet should cause an auto redirect.
 boolean getAddDefaultResource()
          Returns true if default resources for the portlet are added to a page.
 boolean getAjaxable()
          Returns true if the portlet can be displayed via Ajax.
 java.util.Set getAllPortletModes()
          Gets a list of all portlet modes supported by 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()
          Gets the configuration action class of the portlet.
 com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance()
          Gets the configuration action instance of the portlet.
 java.lang.String getContextPath()
          Gets the servlet context path of the portlet.
 java.util.Map getCustomUserAttributes()
          Gets the custom user attributes of the portlet.
 com.liferay.portal.model.PluginSetting getDefaultPluginSetting()
          Get the default plugin settings of the portlet.
 java.lang.String getDefaultPreferences()
          Gets the default preferences of the portlet.
 java.lang.String getDisplayName()
          Gets the display name of the portlet.
 java.lang.Integer getExpCache()
          Gets expiration cache of the portlet.
 java.util.List getFooterPortalCss()
          Gets a list of CSS files that will be referenced from the page's footer relative to the portal's context path.
 java.util.List getFooterPortalJavaScript()
          Gets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.
 java.util.List getFooterPortletCss()
          Gets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.
 java.util.List getFooterPortletJavaScript()
          Gets 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()
          Gets the name of the friendly URL mapper class of the portlet.
 com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance()
          Gets the friendly URL mapper instance of the portlet.
 java.util.List getHeaderPortalCss()
          Gets a list of CSS files that will be referenced from the page's header relative to the portal's context path.
 java.util.List getHeaderPortalJavaScript()
          Gets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.
 java.util.List getHeaderPortletCss()
          Gets a list of CSS files that will be referenced from the page's header relative to the portlet's context path.
 java.util.List getHeaderPortletJavaScript()
          Gets 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()
          Gets the icon of the portlet.
 boolean getInclude()
          Returns true to include the portlet and make it available to be made active.
 java.lang.String getIndexerClass()
          Gets the name of the indexer class of the portlet.
 java.util.Map getInitParams()
          Gets 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()
          Gets the instance id of the portlet.
static java.lang.String getInstanceId(java.lang.String portletId)
          Gets the instance id of the portlet.
 boolean getLayoutCacheable()
          Returns true to allow the portlet to be cached within the layout.
 boolean getMaximizeEdit()
          Returns true if the portlet goes into the maximized state when the user goes into the edit mode.
 boolean getMaximizeHelp()
          Returns true if the portlet goes into the maximized state when the user goes into the help mode.
 java.lang.String getOpenSearchClass()
          Gets the name of the open search class of the portlet.
 java.lang.String getPluginId()
          Gets the plugin id of the portlet.
 com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage()
          Get the package to which the portlet belongs to.
 java.lang.String getPluginType()
          Gets the plugin type of the portlet.
 boolean getPopUpPrint()
          Returns true if the portlet goes into the pop up state when the user goes into the print mode.
 java.lang.String getPortletClass()
          Gets the name of the portlet class of the portlet.
 java.lang.String getPortletDataHandlerClass()
          Gets the name of the portlet data handler class of the portlet.
 com.liferay.portal.kernel.lar.PortletDataHandler getPortletDataHandlerInstance()
          Gets the portlet data handler instance of the portlet.
 com.liferay.portal.model.PortletInfo getPortletInfo()
          Gets the portlet info of the portlet.
 com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListener()
          Gets the portlet layout listener of the portlet.
 java.lang.String getPortletLayoutListenerClass()
          Gets the name of the portlet layout listener class of the portlet.
 java.util.Map getPortletModes()
          Gets the portlet modes of the portlet.
 java.lang.String getPortletURLClass()
          Gets the name of the portlet URL class of the portlet.
 boolean getPreferencesCompanyWide()
          Returns true if preferences are shared across the entire company.
 boolean getPreferencesOwnedByGroup()
          Returns true if preferences are owned by the group when the portlet is shown in a group layout.
 boolean getPreferencesUniquePerLayout()
          Returns true if preferences are unique per layout.
 java.lang.String getPreferencesValidator()
          Gets the name of the preferences validator class of the portlet.
 boolean getPrivateRequestAttributes()
          Returns true if the portlet does not share request attributes with the portal or portlets from another WAR.
 boolean getPrivateSessionAttributes()
          Returns true if the portlet does not share session attributes with the portal.
 int getRenderWeight()
          Returns the render weight of the portlet.
 java.lang.String getResourceBundle()
          Gets the resource bundle of the portlet.
 boolean getRestoreCurrentView()
          Returns true if the portlet restores to the current view from the maximized state.
 java.util.Map getRoleMappers()
          Gets the role mappers of the portlet.
 java.lang.String[] getRolesArray()
          Gets an array of required roles of the portlet.
 java.lang.String getRootPortletId()
          Gets the root portlet id of the portlet.
static java.lang.String getRootPortletId(java.lang.String portletId)
          Gets the root portlet id of the portlet.
 java.lang.String getSchedulerClass()
          Gets the name of the scheduler class of the portlet.
 java.lang.String getServletContextName()
          Gets the servlet context name of the portlet.
 java.util.List getServletURLPatterns()
          The servlet url patterns that are part of this application.
 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 getSmtpMessageListenerClass()
          Gets the name of the SMTP message listener class of the portlet.
 com.liferay.portal.kernel.smtp.MessageListener getSmtpMessageListenerInstance()
          Gets the SMTP message listener instance of the portlet.
 boolean getStatic()
          Returns true if the portlet is a static portlet that is cannot be moved.
 boolean getStaticEnd()
          Returns true if the portlet is a static portlet at the end of a list of portlets.
 boolean getStaticStart()
          Returns true if the portlet is a static portlet at the start of a list of portlets.
 java.lang.String getStrutsPath()
          Gets the struts path of the portlet.
 java.util.Set getSupportedLocales()
          Gets the supported locales of the portlet.
 boolean getSystem()
          Returns true if the portlet is a system portlet that a user cannot manually add to their page.
 java.util.Set getUnlinkedRoles()
          Gets the unlinked roles of the portlet.
 java.lang.String getURLEncoderClass()
          Gets the name of the URL encoder class of the portlet.
 com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance()
          Gets the URL encoder instance of the portlet.
 boolean getUseDefaultTemplate()
          Returns true if the portlet uses the default template.
 java.util.Set getUserAttributes()
          Gets the user attributes of the portlet.
 java.lang.String getUserPrincipalStrategy()
          Gets the user principal strategy of the portlet.
 java.lang.String getVirtualPath()
          Gets the virtual path of the portlet.
 boolean getWARFile()
          Returns true if the portlet is found in a WAR file.
 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 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 isRestoreCurrentView()
          Returns true if the portlet restores to the current view from the maximized state.
 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 isUseDefaultTemplate()
          Returns true if the portlet uses the default template.
 boolean isWARFile()
          Returns true if the portlet is found in a WAR file.
 void linkRoles()
          Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml.
 void setActionURLRedirect(boolean actionURLRedirect)
          Sets to true if an action URL for this portlet should cause an auto redirect.
 void setAddDefaultResource(boolean addDefaultResource)
          Sets to true if default resources for the portlet are added to a page.
 void setAjaxable(boolean ajaxable)
          Sets to true if the portlet can be displayed via Ajax.
 void setConfigurationActionClass(java.lang.String configurationActionClass)
          Sets the configuration action class of the portlet.
 void setCustomUserAttributes(java.util.Map customUserAttributes)
          Sets the custom user attributes of 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 setFooterPortalCss(java.util.List 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 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 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 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 setHeaderPortalCss(java.util.List 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 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 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 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)
          Sets to true to include the portlet and make it available to be made active.
 void setIndexerClass(java.lang.String indexerClass)
          Sets the name of the indexer class of the portlet.
 void setInitParams(java.util.Map initParams)
          Sets the init parameters of the portlet.
 void setInstanceable(boolean instanceable)
          Sets to true if the portlet can be added multiple times to a layout.
 void setLayoutCacheable(boolean layoutCacheable)
          Sets to true to allow the portlet to be cached within the layout.
 void setMaximizeEdit(boolean maximizeEdit)
          Sets to true if the portlet goes into the maximized state when the user goes into the edit mode.
 void setMaximizeHelp(boolean maximizeHelp)
          Sets 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 setPluginPackage(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
          Sets the plugin package to which this portlet belongs to.
 void setPopUpPrint(boolean popUpPrint)
          Sets to true if the portlet goes into the pop up state when the user goes into the print mode.
 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 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 portletModes)
          Sets the portlet modes of the portlet.
 void setPortletURLClass(java.lang.String portletURLClass)
          Sets the name of the portlet URL class of the portlet.
 void setPreferencesCompanyWide(boolean prefsCompanyWide)
          Sets to true if preferences are shared across the entire company.
 void setPreferencesOwnedByGroup(boolean prefsOwnedByGroup)
          Sets to true if preferences are owned by the group when the portlet is shown in a group layout.
 void setPreferencesUniquePerLayout(boolean prefsUniquePerLayout)
          Sets to true if preferences are unique per layout.
 void setPreferencesValidator(java.lang.String prefsValidator)
          Sets the name of the preferences validator class of the portlet.
 void setPrivateRequestAttributes(boolean privateRequestAttributes)
          Sets to true if the portlet does not share request attributes with the portal or portlets from another WAR.
 void setPrivateSessionAttributes(boolean privateSessionAttributes)
          Sets to true if the portlet does not share session attributes with the portal.
 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)
          Sets to true if the portlet restores to the current view from the maximized state.
 void setRoleMappers(java.util.Map 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 setSchedulerClass(java.lang.String schedulerClass)
          Sets the name of the scheduler class of the portlet.
 void setServletContextName(java.lang.String servletContextName)
          Sets the servlet context name of the portlet.
 void setServletURLPatterns(java.util.List servletURLPatterns)
          The servlet url patterns that are part of this application.
 void setShowPortletAccessDenied(boolean showPortletAccessDenied)
          Sets to true if users are shown that they do not have access to the portlet.
 void setShowPortletInactive(boolean showPortletInactive)
          Sets to true if users are shown that the portlet is inactive.
 void setSmtpMessageListenerClass(java.lang.String smtpMessageListenerClass)
          Sets the name of the SMTP message listener class of the portlet.
 void setStatic(boolean staticPortlet)
          Sets to true if the portlet is a static portlet that is cannot be moved.
 void setStaticStart(boolean staticPortletStart)
          Sets 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 supportedLocales)
          Sets the supported locales of the portlet.
 void setSystem(boolean system)
          Sets to true if the portlet is a system portlet that a user cannot manually add to their page.
 void setUnlinkedRoles(java.util.Set 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)
          Sets to true if the portlet uses the default template.
 void setUserAttributes(java.util.Set userAttributes)
          Sets the user attributes of the portlet.
 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 setWARFile(boolean warFile)
          Sets to true if the portlet is found in a WAR file.
 
Methods inherited from class com.liferay.portal.model.impl.PortletModelImpl
getActive, getCompanyId, getId, getPortletId, getPrimaryKey, getPrimaryKeyObj, getRoles, hashCode, isActive, setActive, setCompanyId, setId, setPortletId, setPrimaryKey
 
Methods inherited from class com.liferay.portal.model.impl.BaseModelImpl
isNew, setNew
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.liferay.portal.model.PortletModel
getActive, getCompanyId, getId, getPortletId, getPrimaryKey, getRoles, isActive, setActive, setCompanyId, setId, setPortletId, setPrimaryKey
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getPrimaryKeyObj, isNew, setNew
 

Field Detail

PLUGIN_TYPE

public static final java.lang.String PLUGIN_TYPE
Plugin type

See Also:
Constant Field Values

WAR_SEPARATOR

public static final java.lang.String WAR_SEPARATOR
War file separator.

See Also:
Constant Field Values

INSTANCE_SEPARATOR

public static final java.lang.String INSTANCE_SEPARATOR
Instance separator.

See Also:
Constant Field Values

LAYOUT_SEPARATOR

public static final java.lang.String LAYOUT_SEPARATOR
Layout separator.

See Also:
Constant Field Values

DEFAULT_PREFERENCES

public static final java.lang.String DEFAULT_PREFERENCES
Default preferences.

See Also:
Constant Field Values

USER_PRINCIPAL_STRATEGY_SCREEN_NAME

public static final java.lang.String USER_PRINCIPAL_STRATEGY_SCREEN_NAME
User principal strategy for screen name.

See Also:
Constant Field Values

USER_PRINCIPAL_STRATEGY_USER_ID

public static final java.lang.String USER_PRINCIPAL_STRATEGY_USER_ID
User principal strategy for screen name.

See Also:
Constant Field Values
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.kernel.plugin.PluginPackage pluginPackage,
                   com.liferay.portal.model.PluginSetting pluginSetting,
                   long companyId,
                   java.lang.String icon,
                   java.lang.String virtualPath,
                   java.lang.String strutsPath,
                   java.lang.String displayName,
                   java.lang.String portletClass,
                   java.lang.String configurationActionClass,
                   java.lang.String indexerClass,
                   java.lang.String openSearchClass,
                   java.lang.String schedulerClass,
                   java.lang.String portletURLClass,
                   java.lang.String friendlyURLMapperClass,
                   java.lang.String urlEncoderClass,
                   java.lang.String portletDataHandlerClass,
                   java.lang.String portletLayoutListenerClass,
                   java.lang.String smtpMessageListenerClass,
                   java.lang.String defaultPreferences,
                   java.lang.String prefsValidator,
                   boolean prefsCompanyWide,
                   boolean prefsUniquePerLayout,
                   boolean prefsOwnedByGroup,
                   boolean useDefaultTemplate,
                   boolean showPortletAccessDenied,
                   boolean showPortletInactive,
                   boolean actionURLRedirect,
                   boolean restoreCurrentView,
                   boolean maximizeEdit,
                   boolean maximizeHelp,
                   boolean popUpPrint,
                   boolean layoutCacheable,
                   boolean instanceable,
                   java.lang.String userPrincipalStrategy,
                   boolean privateRequestAttributes,
                   boolean privateSessionAttributes,
                   int renderWeight,
                   boolean ajaxable,
                   java.util.List headerPortalCss,
                   java.util.List headerPortletCss,
                   java.util.List headerPortalJavaScript,
                   java.util.List headerPortletJavaScript,
                   java.util.List footerPortalCss,
                   java.util.List footerPortletCss,
                   java.util.List footerPortalJavaScript,
                   java.util.List footerPortletJavaScript,
                   boolean addDefaultResource,
                   java.lang.String roles,
                   java.util.Set unlinkedRoles,
                   java.util.Map roleMappers,
                   boolean system,
                   boolean active,
                   boolean include,
                   java.util.Map initParams,
                   java.lang.Integer expCache,
                   java.util.Map portletModes,
                   java.util.Set supportedLocales,
                   java.lang.String resourceBundle,
                   com.liferay.portal.model.PortletInfo portletInfo,
                   java.util.Set userAttributes,
                   java.util.Map customUserAttributes,
                   java.lang.String servletContextName,
                   java.util.List servletURLPatterns)
Constructs a portlet with the specified parameters.

Method Detail

getRootPortletId

public static java.lang.String getRootPortletId(java.lang.String portletId)
Gets the root portlet id of the portlet.

Parameters:
portletId - the portlet id of the portlet
Returns:
the root portlet id of the portlet

getInstanceId

public static java.lang.String getInstanceId(java.lang.String portletId)
Gets the instance id of the portlet.

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

getRootPortletId

public java.lang.String getRootPortletId()
Gets the root portlet id of the portlet.

Specified by:
getRootPortletId in interface com.liferay.portal.model.Portlet
Returns:
the root portlet id of the portlet

getInstanceId

public java.lang.String getInstanceId()
Gets the instance id of the portlet.

Specified by:
getInstanceId in interface com.liferay.portal.model.Portlet
Returns:
the instance id of the portlet

getPluginId

public java.lang.String getPluginId()
Gets the plugin id of the portlet.

Specified by:
getPluginId in interface com.liferay.portal.model.Portlet
Returns:
the plugin id of the portlet

getPluginType

public java.lang.String getPluginType()
Gets the plugin type of the portlet.

Specified by:
getPluginType in interface com.liferay.portal.model.Portlet
Returns:
the plugin type of the portlet

getPluginPackage

public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage()
Get the package to which the portlet belongs to.

Specified by:
getPluginPackage in interface com.liferay.portal.model.Portlet
Returns:
the plugin package of the portlet

setPluginPackage

public void setPluginPackage(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
Sets the plugin package to which this portlet belongs to.

Specified by:
setPluginPackage in interface com.liferay.portal.model.Portlet
Parameters:
pluginPackage - the plugin package

getDefaultPluginSetting

public com.liferay.portal.model.PluginSetting getDefaultPluginSetting()
Get the default plugin settings of the portlet.

Specified by:
getDefaultPluginSetting in interface com.liferay.portal.model.Portlet
Returns:
the plugin settings

setDefaultPluginSetting

public void setDefaultPluginSetting(com.liferay.portal.model.PluginSetting pluginSetting)
Sets the default plugin settings of the portlet.

Specified by:
setDefaultPluginSetting in interface com.liferay.portal.model.Portlet
Parameters:
pluginSetting - the plugin setting

getIcon

public java.lang.String getIcon()
Gets the icon of the portlet.

Specified by:
getIcon in interface com.liferay.portal.model.Portlet
Returns:
the icon of the portlet

setIcon

public void setIcon(java.lang.String icon)
Sets the icon of the portlet.

Specified by:
setIcon in interface com.liferay.portal.model.Portlet
Parameters:
icon - the icon of the portlet

getVirtualPath

public java.lang.String getVirtualPath()
Gets the virtual path of the portlet.

Specified by:
getVirtualPath in interface com.liferay.portal.model.Portlet
Returns:
the virtual path of the portlet

setVirtualPath

public void setVirtualPath(java.lang.String virtualPath)
Sets the virtual path of the portlet.

Specified by:
setVirtualPath in interface com.liferay.portal.model.Portlet
Parameters:
virtualPath - the virtual path of the portlet

getStrutsPath

public java.lang.String getStrutsPath()
Gets the struts path of the portlet.

Specified by:
getStrutsPath in interface com.liferay.portal.model.Portlet
Returns:
the struts path of the portlet

setStrutsPath

public void setStrutsPath(java.lang.String strutsPath)
Sets the struts path of the portlet.

Specified by:
setStrutsPath in interface com.liferay.portal.model.Portlet
Parameters:
strutsPath - the struts path of the portlet

getDisplayName

public java.lang.String getDisplayName()
Gets the display name of the portlet.

Specified by:
getDisplayName in interface com.liferay.portal.model.Portlet
Returns:
the display name of the portlet

setDisplayName

public void setDisplayName(java.lang.String displayName)
Sets the display name of the portlet.

Specified by:
setDisplayName in interface com.liferay.portal.model.Portlet
Parameters:
displayName - the display name of the portlet

getPortletClass

public java.lang.String getPortletClass()
Gets the name of the portlet class of the portlet.

Specified by:
getPortletClass in interface com.liferay.portal.model.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.

Specified by:
setPortletClass in interface com.liferay.portal.model.Portlet
Parameters:
portletClass - the name of the portlet class of the portlet

getConfigurationActionClass

public java.lang.String getConfigurationActionClass()
Gets the configuration action class of the portlet.

Specified by:
getConfigurationActionClass in interface com.liferay.portal.model.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.

Specified by:
setConfigurationActionClass in interface com.liferay.portal.model.Portlet
Parameters:
configurationActionClass - the configuration action class of the portlet

getConfigurationActionInstance

public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance()
Gets the configuration action instance of the portlet.

Specified by:
getConfigurationActionInstance in interface com.liferay.portal.model.Portlet
Returns:
the configuration action instance of the portlet

getIndexerClass

public java.lang.String getIndexerClass()
Gets the name of the indexer class of the portlet.

Specified by:
getIndexerClass in interface com.liferay.portal.model.Portlet
Returns:
the name of the indexer class of the portlet

setIndexerClass

public void setIndexerClass(java.lang.String indexerClass)
Sets the name of the indexer class of the portlet.

Specified by:
setIndexerClass in interface com.liferay.portal.model.Portlet
Parameters:
indexerClass - the name of the indexer class of the portlet

getOpenSearchClass

public java.lang.String getOpenSearchClass()
Gets the name of the open search class of the portlet.

Specified by:
getOpenSearchClass in interface com.liferay.portal.model.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.

Specified by:
setOpenSearchClass in interface com.liferay.portal.model.Portlet
Parameters:
openSearchClass - the name of the open search class of the portlet

getSchedulerClass

public java.lang.String getSchedulerClass()
Gets the name of the scheduler class of the portlet.

Specified by:
getSchedulerClass in interface com.liferay.portal.model.Portlet
Returns:
the name of the scheduler class of the portlet

setSchedulerClass

public void setSchedulerClass(java.lang.String schedulerClass)
Sets the name of the scheduler class of the portlet.

Specified by:
setSchedulerClass in interface com.liferay.portal.model.Portlet
Parameters:
schedulerClass - the name of the scheduler class of the portlet

getPortletURLClass

public java.lang.String getPortletURLClass()
Gets the name of the portlet URL class of the portlet.

Specified by:
getPortletURLClass in interface com.liferay.portal.model.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.

Specified by:
setPortletURLClass in interface com.liferay.portal.model.Portlet
Parameters:
portletURLClass - the name of the portlet URL class of the portlet

getFriendlyURLMapperClass

public java.lang.String getFriendlyURLMapperClass()
Gets the name of the friendly URL mapper class of the portlet.

Specified by:
getFriendlyURLMapperClass in interface com.liferay.portal.model.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.

Specified by:
setFriendlyURLMapperClass in interface com.liferay.portal.model.Portlet
Parameters:
friendlyURLMapperClass - the name of the friendly URL plugin class of the portlet

getFriendlyURLMapperInstance

public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance()
Gets the friendly URL mapper instance of the portlet.

Specified by:
getFriendlyURLMapperInstance in interface com.liferay.portal.model.Portlet
Returns:
the friendly URL mapper instance of the portlet

getURLEncoderClass

public java.lang.String getURLEncoderClass()
Gets the name of the URL encoder class of the portlet.

Specified by:
getURLEncoderClass in interface com.liferay.portal.model.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.

Specified by:
setURLEncoderClass in interface com.liferay.portal.model.Portlet
Parameters:
urlEncoderClass - the name of the URL encoder class of the portlet

getURLEncoderInstance

public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance()
Gets the URL encoder instance of the portlet.

Specified by:
getURLEncoderInstance in interface com.liferay.portal.model.Portlet
Returns:
the URL encoder instance of the portlet

getPortletDataHandlerClass

public java.lang.String getPortletDataHandlerClass()
Gets the name of the portlet data handler class of the portlet.

Specified by:
getPortletDataHandlerClass in interface com.liferay.portal.model.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.

Specified by:
setPortletDataHandlerClass in interface com.liferay.portal.model.Portlet
Parameters:
portletDataHandlerClass - the name of portlet data handler class of the portlet

getPortletDataHandlerInstance

public com.liferay.portal.kernel.lar.PortletDataHandler getPortletDataHandlerInstance()
Gets the portlet data handler instance of the portlet.

Specified by:
getPortletDataHandlerInstance in interface com.liferay.portal.model.Portlet
Returns:
the portlet data handler instance of the portlet

getPortletLayoutListener

public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListener()
Gets the portlet layout listener of the portlet.

Specified by:
getPortletLayoutListener in interface com.liferay.portal.model.Portlet
Returns:
the name of the portlet layout listener class of the portlet

getPortletLayoutListenerClass

public java.lang.String getPortletLayoutListenerClass()
Gets the name of the portlet layout listener class of the portlet.

Specified by:
getPortletLayoutListenerClass in interface com.liferay.portal.model.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.

Specified by:
setPortletLayoutListenerClass in interface com.liferay.portal.model.Portlet
Parameters:
portletLayoutListenerClass - the name of the portlet layout listener class of the portlet

getSmtpMessageListenerClass

public java.lang.String getSmtpMessageListenerClass()
Gets the name of the SMTP message listener class of the portlet.

Specified by:
getSmtpMessageListenerClass in interface com.liferay.portal.model.Portlet
Returns:
the name of the SMTP message listener class of the portlet

setSmtpMessageListenerClass

public void setSmtpMessageListenerClass(java.lang.String smtpMessageListenerClass)
Sets the name of the SMTP message listener class of the portlet.

Specified by:
setSmtpMessageListenerClass in interface com.liferay.portal.model.Portlet
Parameters:
smtpMessageListenerClass - the name of the SMTP message listener class of the portlet

getSmtpMessageListenerInstance

public com.liferay.portal.kernel.smtp.MessageListener getSmtpMessageListenerInstance()
Gets the SMTP message listener instance of the portlet.

Specified by:
getSmtpMessageListenerInstance in interface com.liferay.portal.model.Portlet
Returns:
the SMTP message listener instance of the portlet

getDefaultPreferences

public java.lang.String getDefaultPreferences()
Gets the default preferences of the portlet.

Specified by:
getDefaultPreferences in interface com.liferay.portal.model.Portlet
Returns:
the default preferences of the portlet

setDefaultPreferences

public void setDefaultPreferences(java.lang.String defaultPreferences)
Sets the default preferences of the portlet.

Specified by:
setDefaultPreferences in interface com.liferay.portal.model.Portlet
Parameters:
defaultPreferences - the default preferences of the portlet

getPreferencesValidator

public java.lang.String getPreferencesValidator()
Gets the name of the preferences validator class of the portlet.

Specified by:
getPreferencesValidator in interface com.liferay.portal.model.Portlet
Returns:
the name of the preferences validator class of the portlet

setPreferencesValidator

public void setPreferencesValidator(java.lang.String prefsValidator)
Sets the name of the preferences validator class of the portlet.

Specified by:
setPreferencesValidator in interface com.liferay.portal.model.Portlet
Parameters:
prefsValidator - the name of the preferences validator class of the portlet

getPreferencesCompanyWide

public boolean getPreferencesCompanyWide()
Returns true if preferences are shared across the entire company.

Specified by:
getPreferencesCompanyWide in interface com.liferay.portal.model.Portlet
Returns:
true if preferences are shared across the entire company

isPreferencesCompanyWide

public boolean isPreferencesCompanyWide()
Returns true if preferences are shared across the entire company.

Specified by:
isPreferencesCompanyWide in interface com.liferay.portal.model.Portlet
Returns:
true if preferences are shared across the entire company

setPreferencesCompanyWide

public void setPreferencesCompanyWide(boolean prefsCompanyWide)
Sets to true if preferences are shared across the entire company.

Specified by:
setPreferencesCompanyWide in interface com.liferay.portal.model.Portlet
Parameters:
prefsCompanyWide - boolean value for whether preferences are shared across the entire company

getPreferencesUniquePerLayout

public boolean getPreferencesUniquePerLayout()
Returns true if preferences are unique per layout.

Specified by:
getPreferencesUniquePerLayout in interface com.liferay.portal.model.Portlet
Returns:
true if preferences are unique per layout

isPreferencesUniquePerLayout

public boolean isPreferencesUniquePerLayout()
Returns true if preferences are unique per layout.

Specified by:
isPreferencesUniquePerLayout in interface com.liferay.portal.model.Portlet
Returns:
true if preferences are unique per layout

setPreferencesUniquePerLayout

public void setPreferencesUniquePerLayout(boolean prefsUniquePerLayout)
Sets to true if preferences are unique per layout.

Specified by:
setPreferencesUniquePerLayout in interface com.liferay.portal.model.Portlet
Parameters:
prefsUniquePerLayout - boolean value for whether preferences are unique per layout

getPreferencesOwnedByGroup

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

Specified by:
getPreferencesOwnedByGroup in interface com.liferay.portal.model.Portlet
Returns:
true if preferences are owned by the group when the portlet is shown in a group layout; false if preferences are owned by the user at all times.

isPreferencesOwnedByGroup

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

Specified by:
isPreferencesOwnedByGroup in interface com.liferay.portal.model.Portlet
Returns:
true if preferences are owned by the group when the portlet is shown in a group layout; false if preferences are owned by the user at all times.

setPreferencesOwnedByGroup

public void setPreferencesOwnedByGroup(boolean prefsOwnedByGroup)
Sets to true if preferences are owned by the group when the portlet is shown in a group layout. Sets to false if preferences are owned by the user at all times.

Specified by:
setPreferencesOwnedByGroup in interface com.liferay.portal.model.Portlet
Parameters:
prefsOwnedByGroup - boolean value for whether preferences are owned by the group when the portlet is shown in a group layout or preferences are owned by the user at all times

getUseDefaultTemplate

public boolean getUseDefaultTemplate()
Returns true if the portlet uses the default template.

Specified by:
getUseDefaultTemplate in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet uses the default template

isUseDefaultTemplate

public boolean isUseDefaultTemplate()
Returns true if the portlet uses the default template.

Specified by:
isUseDefaultTemplate in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet uses the default template

setUseDefaultTemplate

public void setUseDefaultTemplate(boolean useDefaultTemplate)
Sets to true if the portlet uses the default template.

Specified by:
setUseDefaultTemplate in interface com.liferay.portal.model.Portlet
Parameters:
useDefaultTemplate - boolean value for whether the portlet uses the default template

getShowPortletAccessDenied

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

Specified by:
getShowPortletAccessDenied in interface com.liferay.portal.model.Portlet
Returns:
true if users are shown that they do not have access to the portlet

isShowPortletAccessDenied

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

Specified by:
isShowPortletAccessDenied in interface com.liferay.portal.model.Portlet
Returns:
true if users are shown that they do not have access to the portlet

setShowPortletAccessDenied

public void setShowPortletAccessDenied(boolean showPortletAccessDenied)
Sets to true if users are shown that they do not have access to the portlet.

Specified by:
setShowPortletAccessDenied in interface com.liferay.portal.model.Portlet
Parameters:
showPortletAccessDenied - boolean value for whether users are shown that they do not have access to the portlet

getShowPortletInactive

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

Specified by:
getShowPortletInactive in interface com.liferay.portal.model.Portlet
Returns:
true if users are shown that the portlet is inactive

isShowPortletInactive

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

Specified by:
isShowPortletInactive in interface com.liferay.portal.model.Portlet
Returns:
true if users are shown that the portlet is inactive

setShowPortletInactive

public void setShowPortletInactive(boolean showPortletInactive)
Sets to true if users are shown that the portlet is inactive.

Specified by:
setShowPortletInactive in interface com.liferay.portal.model.Portlet
Parameters:
showPortletInactive - boolean value for whether users are shown that the portlet is inactive

getActionURLRedirect

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

Specified by:
getActionURLRedirect in interface com.liferay.portal.model.Portlet
Returns:
true if an action URL for this portlet should cause an auto redirect

isActionURLRedirect

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

Specified by:
isActionURLRedirect in interface com.liferay.portal.model.Portlet
Returns:
true if an action URL for this portlet should cause an auto redirect

setActionURLRedirect

public void setActionURLRedirect(boolean actionURLRedirect)
Sets to true if an action URL for this portlet should cause an auto redirect.

Specified by:
setActionURLRedirect in interface com.liferay.portal.model.Portlet
Parameters:
actionURLRedirect - boolean value for whether an action URL for this portlet should cause an auto redirect

getRestoreCurrentView

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

Specified by:
getRestoreCurrentView in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet restores to the current view from the maximized state

isRestoreCurrentView

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

Specified by:
isRestoreCurrentView in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet restores to the current view from the maximized state

setRestoreCurrentView

public void setRestoreCurrentView(boolean restoreCurrentView)
Sets to true if the portlet restores to the current view from the maximized state.

Specified by:
setRestoreCurrentView in interface com.liferay.portal.model.Portlet
Parameters:
restoreCurrentView - boolean value for whether the portlet restores to the current view from the maximized state

getMaximizeEdit

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

Specified by:
getMaximizeEdit in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet goes into the maximized state when the user goes into the edit mode

isMaximizeEdit

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

Specified by:
isMaximizeEdit in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet goes into the maximized state when the user goes into the edit mode

setMaximizeEdit

public void setMaximizeEdit(boolean maximizeEdit)
Sets to true if the portlet goes into the maximized state when the user goes into the edit mode.

Specified by:
setMaximizeEdit in interface com.liferay.portal.model.Portlet
Parameters:
maximizeEdit - boolean value for whether the portlet goes into the maximized state when the user goes into the edit mode

getMaximizeHelp

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

Specified by:
getMaximizeHelp in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet goes into the maximized state when the user goes into the help mode

isMaximizeHelp

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

Specified by:
isMaximizeHelp in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet goes into the maximized state when the user goes into the help mode

setMaximizeHelp

public void setMaximizeHelp(boolean maximizeHelp)
Sets to true if the portlet goes into the maximized state when the user goes into the help mode.

Specified by:
setMaximizeHelp in interface com.liferay.portal.model.Portlet
Parameters:
maximizeHelp - boolean value for whether the portlet goes into the maximized state when the user goes into the help mode

getPopUpPrint

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

Specified by:
getPopUpPrint in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet goes into the pop up state when the user goes into the print mode

isPopUpPrint

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

Specified by:
isPopUpPrint in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet goes into the pop up state when the user goes into the print mode

setPopUpPrint

public void setPopUpPrint(boolean popUpPrint)
Sets to true if the portlet goes into the pop up state when the user goes into the print mode.

Specified by:
setPopUpPrint in interface com.liferay.portal.model.Portlet
Parameters:
popUpPrint - boolean value for whether the portlet goes into the pop up state when the user goes into the print mode

getLayoutCacheable

public boolean getLayoutCacheable()
Returns true to allow the portlet to be cached within the layout.

Specified by:
getLayoutCacheable in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet can be cached within the layout

isLayoutCacheable

public boolean isLayoutCacheable()
Returns true to allow the portlet to be cached within the layout.

Specified by:
isLayoutCacheable in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet can be cached within the layout

setLayoutCacheable

public void setLayoutCacheable(boolean layoutCacheable)
Sets to true to allow the portlet to be cached within the layout.

Specified by:
setLayoutCacheable in interface com.liferay.portal.model.Portlet
Parameters:
layoutCacheable - boolean value for whether the portlet can be cached within the layout

getInstanceable

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

Specified by:
getInstanceable in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet can be added multiple times to a layout

isInstanceable

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

Specified by:
isInstanceable in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet can be added multiple times to a layout

setInstanceable

public void setInstanceable(boolean instanceable)
Sets to true if the portlet can be added multiple times to a layout.

Specified by:
setInstanceable in interface com.liferay.portal.model.Portlet
Parameters:
instanceable - boolean value for whether the portlet can be added multiple times to a layout

getUserPrincipalStrategy

public java.lang.String getUserPrincipalStrategy()
Gets the user principal strategy of the portlet.

Specified by:
getUserPrincipalStrategy in interface com.liferay.portal.model.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.

Specified by:
setUserPrincipalStrategy in interface com.liferay.portal.model.Portlet
Parameters:
userPrincipalStrategy - the user principal strategy of the portlet

getPrivateRequestAttributes

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

Specified by:
getPrivateRequestAttributes in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet does not share request attributes with the portal or portlets from another WAR

isPrivateRequestAttributes

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

Specified by:
isPrivateRequestAttributes in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet does not share request attributes with the portal or portlets from another WAR

setPrivateRequestAttributes

public void setPrivateRequestAttributes(boolean privateRequestAttributes)
Sets to true if the portlet does not share request attributes with the portal or portlets from another WAR.

Specified by:
setPrivateRequestAttributes in interface com.liferay.portal.model.Portlet
Parameters:
privateRequestAttributes - boolean value for whether the portlet shares request attributes with the portal or portlets from another WAR

getPrivateSessionAttributes

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

Specified by:
getPrivateSessionAttributes in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet does not share session attributes with the portal

isPrivateSessionAttributes

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

Specified by:
isPrivateSessionAttributes in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet does not share session attributes with the portal

setPrivateSessionAttributes

public void setPrivateSessionAttributes(boolean privateSessionAttributes)
Sets to true if the portlet does not share session attributes with the portal.

Specified by:
setPrivateSessionAttributes in interface com.liferay.portal.model.Portlet
Parameters:
privateSessionAttributes - boolean value for whether the portlet shares session attributes with the portal

getRenderWeight

public int getRenderWeight()
Returns the render weight of the portlet.

Specified by:
getRenderWeight in interface com.liferay.portal.model.Portlet
Returns:
the render weight of the portlet

setRenderWeight

public void setRenderWeight(int renderWeight)
Sets the render weight of the portlet.

Specified by:
setRenderWeight in interface com.liferay.portal.model.Portlet
Parameters:
renderWeight - int value for the render weight of the portlet

getAjaxable

public boolean getAjaxable()
Returns true if the portlet can be displayed via Ajax.

Specified by:
getAjaxable in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet can be displayed via Ajax

isAjaxable

public boolean isAjaxable()
Returns true if the portlet can be displayed via Ajax.

Specified by:
isAjaxable in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet can be displayed via Ajax

setAjaxable

public void setAjaxable(boolean ajaxable)
Sets to true if the portlet can be displayed via Ajax.

Specified by:
setAjaxable in interface com.liferay.portal.model.Portlet
Parameters:
ajaxable - boolean value for whether the portlet can be displayed via Ajax

getHeaderPortalCss

public java.util.List getHeaderPortalCss()
Gets a list of CSS files that will be referenced from the page's header relative to the portal's context path.

Specified by:
getHeaderPortalCss in interface com.liferay.portal.model.Portlet
Returns:
a list of CSS files that will be referenced from the page's header relative to the portal's context path

setHeaderPortalCss

public void setHeaderPortalCss(java.util.List headerPortalCss)
Sets a list of CSS files that will be referenced from the page's header relative to the portal's context path.

Specified by:
setHeaderPortalCss in interface com.liferay.portal.model.Portlet
Parameters:
headerPortalCss - a list of CSS files that will be referenced from the page's header relative to the portal's context path

getHeaderPortletCss

public java.util.List getHeaderPortletCss()
Gets a list of CSS files that will be referenced from the page's header relative to the portlet's context path.

Specified by:
getHeaderPortletCss in interface com.liferay.portal.model.Portlet
Returns:
a list of CSS files that will be referenced from the page's header relative to the portlet's context path

setHeaderPortletCss

public void setHeaderPortletCss(java.util.List headerPortletCss)
Sets a list of CSS files that will be referenced from the page's header relative to the portlet's context path.

Specified by:
setHeaderPortletCss in interface com.liferay.portal.model.Portlet
Parameters:
headerPortletCss - a list of CSS files that will be referenced from the page's header relative to the portlet's context path

getHeaderPortalJavaScript

public java.util.List getHeaderPortalJavaScript()
Gets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.

Specified by:
getHeaderPortalJavaScript in interface com.liferay.portal.model.Portlet
Returns:
a list of JavaScript files that will be referenced from the page's header relative to the portal's context path

setHeaderPortalJavaScript

public void setHeaderPortalJavaScript(java.util.List headerPortalJavaScript)
Sets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.

Specified by:
setHeaderPortalJavaScript in interface com.liferay.portal.model.Portlet
Parameters:
headerPortalJavaScript - a list of JavaScript files that will be referenced from the page's header relative to the portal's context path

getHeaderPortletJavaScript

public java.util.List getHeaderPortletJavaScript()
Gets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.

Specified by:
getHeaderPortletJavaScript in interface com.liferay.portal.model.Portlet
Returns:
a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path

setHeaderPortletJavaScript

public void setHeaderPortletJavaScript(java.util.List headerPortletJavaScript)
Sets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.

Specified by:
setHeaderPortletJavaScript in interface com.liferay.portal.model.Portlet
Parameters:
headerPortletJavaScript - a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path

getFooterPortalCss

public java.util.List getFooterPortalCss()
Gets a list of CSS files that will be referenced from the page's footer relative to the portal's context path.

Specified by:
getFooterPortalCss in interface com.liferay.portal.model.Portlet
Returns:
a list of CSS files that will be referenced from the page's footer relative to the portal's context path

setFooterPortalCss

public void setFooterPortalCss(java.util.List footerPortalCss)
Sets a list of CSS files that will be referenced from the page's footer relative to the portal's context path.

Specified by:
setFooterPortalCss in interface com.liferay.portal.model.Portlet
Parameters:
footerPortalCss - a list of CSS files that will be referenced from the page's footer relative to the portal's context path

getFooterPortletCss

public java.util.List getFooterPortletCss()
Gets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.

Specified by:
getFooterPortletCss in interface com.liferay.portal.model.Portlet
Returns:
a list of CSS files that will be referenced from the page's footer relative to the portlet's context path

setFooterPortletCss

public void setFooterPortletCss(java.util.List footerPortletCss)
Sets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.

Specified by:
setFooterPortletCss in interface com.liferay.portal.model.Portlet
Parameters:
footerPortletCss - a list of CSS files that will be referenced from the page's footer relative to the portlet's context path

getFooterPortalJavaScript

public java.util.List getFooterPortalJavaScript()
Gets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.

Specified by:
getFooterPortalJavaScript in interface com.liferay.portal.model.Portlet
Returns:
a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path

setFooterPortalJavaScript

public void setFooterPortalJavaScript(java.util.List footerPortalJavaScript)
Sets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.

Specified by:
setFooterPortalJavaScript in interface com.liferay.portal.model.Portlet
Parameters:
footerPortalJavaScript - a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path

getFooterPortletJavaScript

public java.util.List getFooterPortletJavaScript()
Gets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.

Specified by:
getFooterPortletJavaScript in interface com.liferay.portal.model.Portlet
Returns:
a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path

setFooterPortletJavaScript

public void setFooterPortletJavaScript(java.util.List footerPortletJavaScript)
Sets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.

Specified by:
setFooterPortletJavaScript in interface com.liferay.portal.model.Portlet
Parameters:
footerPortletJavaScript - a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path

getAddDefaultResource

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

Specified by:
getAddDefaultResource in interface com.liferay.portal.model.Portlet
Returns:
true if default resources for the portlet are added to a page

isAddDefaultResource

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

Specified by:
isAddDefaultResource in interface com.liferay.portal.model.Portlet
Returns:
true if default resources for the portlet are added to a page

setAddDefaultResource

public void setAddDefaultResource(boolean addDefaultResource)
Sets to true if default resources for the portlet are added to a page.

Specified by:
setAddDefaultResource in interface com.liferay.portal.model.Portlet
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
Overrides:
setRoles in class PortletModelImpl
Parameters:
roles - a string of ordered comma delimited portlet ids

getRolesArray

public java.lang.String[] getRolesArray()
Gets an array of required roles of the portlet.

Specified by:
getRolesArray in interface com.liferay.portal.model.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.

Specified by:
setRolesArray in interface com.liferay.portal.model.Portlet
Parameters:
rolesArray - an array of required roles of the portlet

getUnlinkedRoles

public java.util.Set getUnlinkedRoles()
Gets the unlinked roles of the portlet.

Specified by:
getUnlinkedRoles in interface com.liferay.portal.model.Portlet
Returns:
unlinked roles of the portlet

setUnlinkedRoles

public void setUnlinkedRoles(java.util.Set unlinkedRoles)
Sets the unlinked roles of the portlet.

Specified by:
setUnlinkedRoles in interface com.liferay.portal.model.Portlet
Parameters:
unlinkedRoles - the unlinked roles of the portlet

getRoleMappers

public java.util.Map getRoleMappers()
Gets the role mappers of the portlet.

Specified by:
getRoleMappers in interface com.liferay.portal.model.Portlet
Returns:
role mappers of the portlet

setRoleMappers

public void setRoleMappers(java.util.Map roleMappers)
Sets the role mappers of the portlet.

Specified by:
setRoleMappers in interface com.liferay.portal.model.Portlet
Parameters:
roleMappers - the role mappers of the portlet

linkRoles

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

Specified by:
linkRoles in interface com.liferay.portal.model.Portlet

hasRoleWithName

public boolean hasRoleWithName(java.lang.String roleName)
Returns true if the portlet has a role with the specified name.

Specified by:
hasRoleWithName in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet has a role with the specified name

hasAddPortletPermission

public boolean hasAddPortletPermission(long userId)
Returns true if the user has the permission to add the portlet to a layout.

Specified by:
hasAddPortletPermission in interface com.liferay.portal.model.Portlet
Returns:
true if the user has the permission to add the portlet to a layout

getSystem

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

Specified by:
getSystem in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet is a system portlet that a user cannot manually add to their page

isSystem

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

Specified by:
isSystem in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet is a system portlet that a user cannot manually add to their page

setSystem

public void setSystem(boolean system)
Sets to true if the portlet is a system portlet that a user cannot manually add to their page.

Specified by:
setSystem in interface com.liferay.portal.model.Portlet
Parameters:
system - boolean value for whether the portlet is a system portlet that a user cannot manually add to their page

getInclude

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

Specified by:
getInclude in interface com.liferay.portal.model.Portlet
Returns:
true to include the portlet and make it available to be made active

isInclude

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

Specified by:
isInclude in interface com.liferay.portal.model.Portlet
Returns:
true to include the portlet and make it available to be made active

setInclude

public void setInclude(boolean include)
Sets to true to include the portlet and make it available to be made active.

Specified by:
setInclude in interface com.liferay.portal.model.Portlet
Parameters:
include - boolean value for whether to include the portlet and make it available to be made active

getInitParams

public java.util.Map getInitParams()
Gets the init parameters of the portlet.

Specified by:
getInitParams in interface com.liferay.portal.model.Portlet
Returns:
init parameters of the portlet

setInitParams

public void setInitParams(java.util.Map initParams)
Sets the init parameters of the portlet.

Specified by:
setInitParams in interface com.liferay.portal.model.Portlet
Parameters:
initParams - the init parameters of the portlet

getExpCache

public java.lang.Integer getExpCache()
Gets expiration cache of the portlet.

Specified by:
getExpCache in interface com.liferay.portal.model.Portlet
Returns:
expiration cache of the portlet

setExpCache

public void setExpCache(java.lang.Integer expCache)
Sets expiration cache of the portlet.

Specified by:
setExpCache in interface com.liferay.portal.model.Portlet
Parameters:
expCache - expiration cache of the portlet

getPortletModes

public java.util.Map getPortletModes()
Gets the portlet modes of the portlet.

Specified by:
getPortletModes in interface com.liferay.portal.model.Portlet
Returns:
portlet modes of the portlet

setPortletModes

public void setPortletModes(java.util.Map portletModes)
Sets the portlet modes of the portlet.

Specified by:
setPortletModes in interface com.liferay.portal.model.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.

Specified by:
hasPortletMode in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet supports the specified mime type and portlet mode

getAllPortletModes

public java.util.Set getAllPortletModes()
Gets a list of all portlet modes supported by the portlet.

Specified by:
getAllPortletModes in interface com.liferay.portal.model.Portlet
Returns:
a list of all portlet modes supported by the portlet

hasMultipleMimeTypes

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

Specified by:
hasMultipleMimeTypes in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet supports more than one mime type

getSupportedLocales

public java.util.Set getSupportedLocales()
Gets the supported locales of the portlet.

Specified by:
getSupportedLocales in interface com.liferay.portal.model.Portlet
Returns:
supported locales of the portlet

setSupportedLocales

public void setSupportedLocales(java.util.Set supportedLocales)
Sets the supported locales of the portlet.

Specified by:
setSupportedLocales in interface com.liferay.portal.model.Portlet
Parameters:
supportedLocales - the supported locales of the portlet

getResourceBundle

public java.lang.String getResourceBundle()
Gets the resource bundle of the portlet.

Specified by:
getResourceBundle in interface com.liferay.portal.model.Portlet
Returns:
resource bundle of the portlet

setResourceBundle

public void setResourceBundle(java.lang.String resourceBundle)
Sets the resource bundle of the portlet.

Specified by:
setResourceBundle in interface com.liferay.portal.model.Portlet
Parameters:
resourceBundle - the resource bundle of the portlet

getPortletInfo

public com.liferay.portal.model.PortletInfo getPortletInfo()
Gets the portlet info of the portlet.

Specified by:
getPortletInfo in interface com.liferay.portal.model.Portlet
Returns:
portlet info of the portlet

setPortletInfo

public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo)
Sets the portlet info of the portlet.

Specified by:
setPortletInfo in interface com.liferay.portal.model.Portlet
Parameters:
portletInfo - the portlet info of the portlet

getUserAttributes

public java.util.Set getUserAttributes()
Gets the user attributes of the portlet.

Specified by:
getUserAttributes in interface com.liferay.portal.model.Portlet
Returns:
user attributes of the portlet

setUserAttributes

public void setUserAttributes(java.util.Set userAttributes)
Sets the user attributes of the portlet.

Specified by:
setUserAttributes in interface com.liferay.portal.model.Portlet
Parameters:
userAttributes - the user attributes of the portlet

getCustomUserAttributes

public java.util.Map getCustomUserAttributes()
Gets the custom user attributes of the portlet.

Specified by:
getCustomUserAttributes in interface com.liferay.portal.model.Portlet
Returns:
custom user attributes of the portlet

setCustomUserAttributes

public void setCustomUserAttributes(java.util.Map customUserAttributes)
Sets the custom user attributes of the portlet.

Specified by:
setCustomUserAttributes in interface com.liferay.portal.model.Portlet
Parameters:
customUserAttributes - the custom user attributes of the portlet

getServletContextName

public java.lang.String getServletContextName()
Gets the servlet context name of the portlet.

Specified by:
getServletContextName in interface com.liferay.portal.model.Portlet
Returns:
the servlet context name of the portlet

setServletContextName

public void setServletContextName(java.lang.String servletContextName)
Sets the servlet context name of the portlet.

Specified by:
setServletContextName in interface com.liferay.portal.model.Portlet
Parameters:
servletContextName - the servlet context name of the portlet

getWARFile

public boolean getWARFile()
Returns true if the portlet is found in a WAR file.

Specified by:
getWARFile in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet is found in a WAR file

isWARFile

public boolean isWARFile()
Returns true if the portlet is found in a WAR file.

Specified by:
isWARFile in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet is found in a WAR file

setWARFile

public void setWARFile(boolean warFile)
Sets to true if the portlet is found in a WAR file.

Specified by:
setWARFile in interface com.liferay.portal.model.Portlet
Parameters:
warFile - boolean value for whether the portlet is found in a WAR file

getContextPath

public java.lang.String getContextPath()
Gets the servlet context path of the portlet.

Specified by:
getContextPath in interface com.liferay.portal.model.Portlet
Returns:
the servlet context path of the portlet

getClonedInstance

public com.liferay.portal.model.Portlet getClonedInstance(java.lang.String portletId)
Returns true if the portlet is found in a WAR file.

Specified by:
getClonedInstance in interface com.liferay.portal.model.Portlet
Parameters:
portletId - the cloned instance portlet id
Returns:
a cloned instance of the portlet

getStatic

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

Specified by:
getStatic in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet is a static portlet that is cannot be moved

isStatic

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

Specified by:
isStatic in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet is a static portlet that is cannot be moved

setStatic

public void setStatic(boolean staticPortlet)
Sets to true if the portlet is a static portlet that is cannot be moved.

Specified by:
setStatic in interface com.liferay.portal.model.Portlet
Parameters:
staticPortlet - boolean value for whether the portlet is a static portlet that cannot be moved

getStaticStart

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

Specified by:
getStaticStart in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet is a static portlet at the start of a list of portlets

isStaticStart

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

Specified by:
isStaticStart in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet is a static portlet at the start of a list of portlets

setStaticStart

public void setStaticStart(boolean staticPortletStart)
Sets to true if the portlet is a static portlet at the start of a list of portlets.

Specified by:
setStaticStart in interface com.liferay.portal.model.Portlet
Parameters:
staticPortletStart - boolean value for whether the portlet is a static portlet at the start of a list of portlets

getStaticEnd

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

Specified by:
getStaticEnd in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet is a static portlet at the end of a list of portlets

isStaticEnd

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

Specified by:
isStaticEnd in interface com.liferay.portal.model.Portlet
Returns:
true if the portlet is a static portlet at the end of a list of portlets

getServletURLPatterns

public java.util.List getServletURLPatterns()
The servlet url patterns that are part of this application.

Specified by:
getServletURLPatterns in interface com.liferay.portal.model.Portlet
Returns:
The servlet url patterns that are part of this application

setServletURLPatterns

public void setServletURLPatterns(java.util.List servletURLPatterns)
The servlet url patterns that are part of this application.

Specified by:
setServletURLPatterns in interface com.liferay.portal.model.Portlet
Parameters:
servletURLPatterns - servlet url patterns that are part of this application

clone

public java.lang.Object clone()
Creates and returns a copy of this object.

Specified by:
clone in interface com.liferay.portal.model.Portlet
Overrides:
clone in class PortletModelImpl
Returns:
a copy of this object

compareTo

public int compareTo(java.lang.Object obj)
Compares this portlet to the specified object.

Specified by:
compareTo in interface com.liferay.portal.model.Portlet
Overrides:
compareTo in class PortletModelImpl
Parameters:
obj - the object 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