com.liferay.portal.model
Interface Portlet

All Superinterfaces:
BaseModel, java.lang.Cloneable, java.lang.Comparable, PortletModel, java.io.Serializable

public interface Portlet
extends PortletModel

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This interface is a model that represents the Portlet table in the database.

Customize com.liferay.portal.service.model.impl.PortletImpl and rerun the ServiceBuilder to generate the new methods.

Author:
Brian Wing Shun Chan
See Also:
com.liferay.portal.service.model.PortletModel, com.liferay.portal.service.model.impl.PortletImpl, com.liferay.portal.service.model.impl.PortletModelImpl

Method Summary
 java.lang.Object clone()
           
 int compareTo(java.lang.Object obj)
           
 boolean equals(java.lang.Object obj)
           
 boolean getActionURLRedirect()
           
 boolean getAddDefaultResource()
           
 boolean getAjaxable()
           
 java.util.Set getAllPortletModes()
           
 Portlet getClonedInstance(java.lang.String portletId)
           
 java.lang.String getConfigurationActionClass()
           
 com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance()
           
 java.lang.String getContextPath()
           
 java.util.Map getCustomUserAttributes()
           
 PluginSetting getDefaultPluginSetting()
           
 java.lang.String getDefaultPreferences()
           
 java.lang.String getDisplayName()
           
 java.lang.Integer getExpCache()
           
 java.util.List getFooterPortalCss()
           
 java.util.List getFooterPortalJavaScript()
           
 java.util.List getFooterPortletCss()
           
 java.util.List getFooterPortletJavaScript()
           
 java.lang.String getFriendlyURLMapperClass()
           
 com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance()
           
 java.util.List getHeaderPortalCss()
           
 java.util.List getHeaderPortalJavaScript()
           
 java.util.List getHeaderPortletCss()
           
 java.util.List getHeaderPortletJavaScript()
           
 java.lang.String getIcon()
           
 boolean getInclude()
           
 java.lang.String getIndexerClass()
           
 java.util.Map getInitParams()
           
 boolean getInstanceable()
           
 java.lang.String getInstanceId()
           
 boolean getLayoutCacheable()
           
 boolean getMaximizeEdit()
           
 boolean getMaximizeHelp()
           
 java.lang.String getOpenSearchClass()
           
 java.lang.String getPluginId()
           
 com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage()
           
 java.lang.String getPluginType()
           
 boolean getPopUpPrint()
           
 java.lang.String getPortletClass()
           
 java.lang.String getPortletDataHandlerClass()
           
 com.liferay.portal.kernel.lar.PortletDataHandler getPortletDataHandlerInstance()
           
 PortletInfo getPortletInfo()
           
 com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListener()
           
 java.lang.String getPortletLayoutListenerClass()
           
 java.util.Map getPortletModes()
           
 java.lang.String getPortletURLClass()
           
 boolean getPreferencesCompanyWide()
           
 boolean getPreferencesOwnedByGroup()
           
 boolean getPreferencesUniquePerLayout()
           
 java.lang.String getPreferencesValidator()
           
 boolean getPrivateRequestAttributes()
           
 boolean getPrivateSessionAttributes()
           
 int getRenderWeight()
           
 java.lang.String getResourceBundle()
           
 boolean getRestoreCurrentView()
           
 java.util.Map getRoleMappers()
           
 java.lang.String[] getRolesArray()
           
 java.lang.String getRootPortletId()
           
 java.lang.String getSchedulerClass()
           
 java.lang.String getServletContextName()
           
 java.util.List getServletURLPatterns()
           
 boolean getShowPortletAccessDenied()
           
 boolean getShowPortletInactive()
           
 java.lang.String getSmtpMessageListenerClass()
           
 com.liferay.portal.kernel.smtp.MessageListener getSmtpMessageListenerInstance()
           
 boolean getStatic()
           
 boolean getStaticEnd()
           
 boolean getStaticStart()
           
 java.lang.String getStrutsPath()
           
 java.util.Set getSupportedLocales()
           
 boolean getSystem()
           
 java.util.Set getUnlinkedRoles()
           
 java.lang.String getURLEncoderClass()
           
 com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance()
           
 boolean getUseDefaultTemplate()
           
 java.util.Set getUserAttributes()
           
 java.lang.String getUserPrincipalStrategy()
           
 java.lang.String getVirtualPath()
           
 boolean getWARFile()
           
 boolean hasAddPortletPermission(long userId)
           
 boolean hasMultipleMimeTypes()
           
 boolean hasPortletMode(java.lang.String mimeType, javax.portlet.PortletMode portletMode)
           
 boolean hasRoleWithName(java.lang.String roleName)
           
 boolean isActionURLRedirect()
           
 boolean isAddDefaultResource()
           
 boolean isAjaxable()
           
 boolean isInclude()
           
 boolean isInstanceable()
           
 boolean isLayoutCacheable()
           
 boolean isMaximizeEdit()
           
 boolean isMaximizeHelp()
           
 boolean isPopUpPrint()
           
 boolean isPreferencesCompanyWide()
           
 boolean isPreferencesOwnedByGroup()
           
 boolean isPreferencesUniquePerLayout()
           
 boolean isPrivateRequestAttributes()
           
 boolean isPrivateSessionAttributes()
           
 boolean isRestoreCurrentView()
           
 boolean isShowPortletAccessDenied()
           
 boolean isShowPortletInactive()
           
 boolean isStatic()
           
 boolean isStaticEnd()
           
 boolean isStaticStart()
           
 boolean isSystem()
           
 boolean isUseDefaultTemplate()
           
 boolean isWARFile()
           
 void linkRoles()
           
 void setActionURLRedirect(boolean actionURLRedirect)
           
 void setAddDefaultResource(boolean addDefaultResource)
           
 void setAjaxable(boolean ajaxable)
           
 void setConfigurationActionClass(java.lang.String configurationActionClass)
           
 void setCustomUserAttributes(java.util.Map customUserAttributes)
           
 void setDefaultPluginSetting(PluginSetting pluginSetting)
           
 void setDefaultPreferences(java.lang.String defaultPreferences)
           
 void setDisplayName(java.lang.String displayName)
           
 void setExpCache(java.lang.Integer expCache)
           
 void setFooterPortalCss(java.util.List footerPortalCss)
           
 void setFooterPortalJavaScript(java.util.List footerPortalJavaScript)
           
 void setFooterPortletCss(java.util.List footerPortletCss)
           
 void setFooterPortletJavaScript(java.util.List footerPortletJavaScript)
           
 void setFriendlyURLMapperClass(java.lang.String friendlyURLMapperClass)
           
 void setHeaderPortalCss(java.util.List headerPortalCss)
           
 void setHeaderPortalJavaScript(java.util.List headerPortalJavaScript)
           
 void setHeaderPortletCss(java.util.List headerPortletCss)
           
 void setHeaderPortletJavaScript(java.util.List headerPortletJavaScript)
           
 void setIcon(java.lang.String icon)
           
 void setInclude(boolean include)
           
 void setIndexerClass(java.lang.String indexerClass)
           
 void setInitParams(java.util.Map initParams)
           
 void setInstanceable(boolean instanceable)
           
 void setLayoutCacheable(boolean layoutCacheable)
           
 void setMaximizeEdit(boolean maximizeEdit)
           
 void setMaximizeHelp(boolean maximizeHelp)
           
 void setOpenSearchClass(java.lang.String openSearchClass)
           
 void setPluginPackage(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 void setPopUpPrint(boolean popUpPrint)
           
 void setPortletClass(java.lang.String portletClass)
           
 void setPortletDataHandlerClass(java.lang.String portletDataHandlerClass)
           
 void setPortletInfo(PortletInfo portletInfo)
           
 void setPortletLayoutListenerClass(java.lang.String portletLayoutListenerClass)
           
 void setPortletModes(java.util.Map portletModes)
           
 void setPortletURLClass(java.lang.String portletURLClass)
           
 void setPreferencesCompanyWide(boolean prefsCompanyWide)
           
 void setPreferencesOwnedByGroup(boolean prefsOwnedByGroup)
           
 void setPreferencesUniquePerLayout(boolean prefsUniquePerLayout)
           
 void setPreferencesValidator(java.lang.String prefsValidator)
           
 void setPrivateRequestAttributes(boolean privateRequestAttributes)
           
 void setPrivateSessionAttributes(boolean privateSessionAttributes)
           
 void setRenderWeight(int renderWeight)
           
 void setResourceBundle(java.lang.String resourceBundle)
           
 void setRestoreCurrentView(boolean restoreCurrentView)
           
 void setRoleMappers(java.util.Map roleMappers)
           
 void setRoles(java.lang.String roles)
           
 void setRolesArray(java.lang.String[] rolesArray)
           
 void setSchedulerClass(java.lang.String schedulerClass)
           
 void setServletContextName(java.lang.String servletContextName)
           
 void setServletURLPatterns(java.util.List servletURLPatterns)
           
 void setShowPortletAccessDenied(boolean showPortletAccessDenied)
           
 void setShowPortletInactive(boolean showPortletInactive)
           
 void setSmtpMessageListenerClass(java.lang.String smtpMessageListenerClass)
           
 void setStatic(boolean staticPortlet)
           
 void setStaticStart(boolean staticPortletStart)
           
 void setStrutsPath(java.lang.String strutsPath)
           
 void setSupportedLocales(java.util.Set supportedLocales)
           
 void setSystem(boolean system)
           
 void setUnlinkedRoles(java.util.Set unlinkedRoles)
           
 void setURLEncoderClass(java.lang.String urlEncoderClass)
           
 void setUseDefaultTemplate(boolean useDefaultTemplate)
           
 void setUserAttributes(java.util.Set userAttributes)
           
 void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy)
           
 void setVirtualPath(java.lang.String virtualPath)
           
 void setWARFile(boolean warFile)
           
 
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
 

Method Detail

getRootPortletId

public java.lang.String getRootPortletId()

getInstanceId

public java.lang.String getInstanceId()

getPluginId

public java.lang.String getPluginId()

getPluginType

public java.lang.String getPluginType()

getPluginPackage

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

setPluginPackage

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

getDefaultPluginSetting

public PluginSetting getDefaultPluginSetting()

setDefaultPluginSetting

public void setDefaultPluginSetting(PluginSetting pluginSetting)

getIcon

public java.lang.String getIcon()

setIcon

public void setIcon(java.lang.String icon)

getVirtualPath

public java.lang.String getVirtualPath()

setVirtualPath

public void setVirtualPath(java.lang.String virtualPath)

getStrutsPath

public java.lang.String getStrutsPath()

setStrutsPath

public void setStrutsPath(java.lang.String strutsPath)

getDisplayName

public java.lang.String getDisplayName()

setDisplayName

public void setDisplayName(java.lang.String displayName)

getPortletClass

public java.lang.String getPortletClass()

setPortletClass

public void setPortletClass(java.lang.String portletClass)

getConfigurationActionClass

public java.lang.String getConfigurationActionClass()

setConfigurationActionClass

public void setConfigurationActionClass(java.lang.String configurationActionClass)

getConfigurationActionInstance

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

getIndexerClass

public java.lang.String getIndexerClass()

setIndexerClass

public void setIndexerClass(java.lang.String indexerClass)

getOpenSearchClass

public java.lang.String getOpenSearchClass()

setOpenSearchClass

public void setOpenSearchClass(java.lang.String openSearchClass)

getSchedulerClass

public java.lang.String getSchedulerClass()

setSchedulerClass

public void setSchedulerClass(java.lang.String schedulerClass)

getPortletURLClass

public java.lang.String getPortletURLClass()

setPortletURLClass

public void setPortletURLClass(java.lang.String portletURLClass)

getFriendlyURLMapperClass

public java.lang.String getFriendlyURLMapperClass()

setFriendlyURLMapperClass

public void setFriendlyURLMapperClass(java.lang.String friendlyURLMapperClass)

getFriendlyURLMapperInstance

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

getURLEncoderClass

public java.lang.String getURLEncoderClass()

setURLEncoderClass

public void setURLEncoderClass(java.lang.String urlEncoderClass)

getURLEncoderInstance

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

getPortletDataHandlerClass

public java.lang.String getPortletDataHandlerClass()

setPortletDataHandlerClass

public void setPortletDataHandlerClass(java.lang.String portletDataHandlerClass)

getPortletDataHandlerInstance

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

getPortletLayoutListener

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

getPortletLayoutListenerClass

public java.lang.String getPortletLayoutListenerClass()

setPortletLayoutListenerClass

public void setPortletLayoutListenerClass(java.lang.String portletLayoutListenerClass)

getSmtpMessageListenerClass

public java.lang.String getSmtpMessageListenerClass()

setSmtpMessageListenerClass

public void setSmtpMessageListenerClass(java.lang.String smtpMessageListenerClass)

getSmtpMessageListenerInstance

public com.liferay.portal.kernel.smtp.MessageListener getSmtpMessageListenerInstance()

getDefaultPreferences

public java.lang.String getDefaultPreferences()

setDefaultPreferences

public void setDefaultPreferences(java.lang.String defaultPreferences)

getPreferencesValidator

public java.lang.String getPreferencesValidator()

setPreferencesValidator

public void setPreferencesValidator(java.lang.String prefsValidator)

getPreferencesCompanyWide

public boolean getPreferencesCompanyWide()

isPreferencesCompanyWide

public boolean isPreferencesCompanyWide()

setPreferencesCompanyWide

public void setPreferencesCompanyWide(boolean prefsCompanyWide)

getPreferencesUniquePerLayout

public boolean getPreferencesUniquePerLayout()

isPreferencesUniquePerLayout

public boolean isPreferencesUniquePerLayout()

setPreferencesUniquePerLayout

public void setPreferencesUniquePerLayout(boolean prefsUniquePerLayout)

getPreferencesOwnedByGroup

public boolean getPreferencesOwnedByGroup()

isPreferencesOwnedByGroup

public boolean isPreferencesOwnedByGroup()

setPreferencesOwnedByGroup

public void setPreferencesOwnedByGroup(boolean prefsOwnedByGroup)

getUseDefaultTemplate

public boolean getUseDefaultTemplate()

isUseDefaultTemplate

public boolean isUseDefaultTemplate()

setUseDefaultTemplate

public void setUseDefaultTemplate(boolean useDefaultTemplate)

getShowPortletAccessDenied

public boolean getShowPortletAccessDenied()

isShowPortletAccessDenied

public boolean isShowPortletAccessDenied()

setShowPortletAccessDenied

public void setShowPortletAccessDenied(boolean showPortletAccessDenied)

getShowPortletInactive

public boolean getShowPortletInactive()

isShowPortletInactive

public boolean isShowPortletInactive()

setShowPortletInactive

public void setShowPortletInactive(boolean showPortletInactive)

getActionURLRedirect

public boolean getActionURLRedirect()

isActionURLRedirect

public boolean isActionURLRedirect()

setActionURLRedirect

public void setActionURLRedirect(boolean actionURLRedirect)

getRestoreCurrentView

public boolean getRestoreCurrentView()

isRestoreCurrentView

public boolean isRestoreCurrentView()

setRestoreCurrentView

public void setRestoreCurrentView(boolean restoreCurrentView)

getMaximizeEdit

public boolean getMaximizeEdit()

isMaximizeEdit

public boolean isMaximizeEdit()

setMaximizeEdit

public void setMaximizeEdit(boolean maximizeEdit)

getMaximizeHelp

public boolean getMaximizeHelp()

isMaximizeHelp

public boolean isMaximizeHelp()

setMaximizeHelp

public void setMaximizeHelp(boolean maximizeHelp)

getPopUpPrint

public boolean getPopUpPrint()

isPopUpPrint

public boolean isPopUpPrint()

setPopUpPrint

public void setPopUpPrint(boolean popUpPrint)

getLayoutCacheable

public boolean getLayoutCacheable()

isLayoutCacheable

public boolean isLayoutCacheable()

setLayoutCacheable

public void setLayoutCacheable(boolean layoutCacheable)

getInstanceable

public boolean getInstanceable()

isInstanceable

public boolean isInstanceable()

setInstanceable

public void setInstanceable(boolean instanceable)

getUserPrincipalStrategy

public java.lang.String getUserPrincipalStrategy()

setUserPrincipalStrategy

public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy)

getPrivateRequestAttributes

public boolean getPrivateRequestAttributes()

isPrivateRequestAttributes

public boolean isPrivateRequestAttributes()

setPrivateRequestAttributes

public void setPrivateRequestAttributes(boolean privateRequestAttributes)

getPrivateSessionAttributes

public boolean getPrivateSessionAttributes()

isPrivateSessionAttributes

public boolean isPrivateSessionAttributes()

setPrivateSessionAttributes

public void setPrivateSessionAttributes(boolean privateSessionAttributes)

getRenderWeight

public int getRenderWeight()

setRenderWeight

public void setRenderWeight(int renderWeight)

getAjaxable

public boolean getAjaxable()

isAjaxable

public boolean isAjaxable()

setAjaxable

public void setAjaxable(boolean ajaxable)

getHeaderPortalCss

public java.util.List getHeaderPortalCss()

setHeaderPortalCss

public void setHeaderPortalCss(java.util.List headerPortalCss)

getHeaderPortletCss

public java.util.List getHeaderPortletCss()

setHeaderPortletCss

public void setHeaderPortletCss(java.util.List headerPortletCss)

getHeaderPortalJavaScript

public java.util.List getHeaderPortalJavaScript()

setHeaderPortalJavaScript

public void setHeaderPortalJavaScript(java.util.List headerPortalJavaScript)

getHeaderPortletJavaScript

public java.util.List getHeaderPortletJavaScript()

setHeaderPortletJavaScript

public void setHeaderPortletJavaScript(java.util.List headerPortletJavaScript)

getFooterPortalCss

public java.util.List getFooterPortalCss()

setFooterPortalCss

public void setFooterPortalCss(java.util.List footerPortalCss)

getFooterPortletCss

public java.util.List getFooterPortletCss()

setFooterPortletCss

public void setFooterPortletCss(java.util.List footerPortletCss)

getFooterPortalJavaScript

public java.util.List getFooterPortalJavaScript()

setFooterPortalJavaScript

public void setFooterPortalJavaScript(java.util.List footerPortalJavaScript)

getFooterPortletJavaScript

public java.util.List getFooterPortletJavaScript()

setFooterPortletJavaScript

public void setFooterPortletJavaScript(java.util.List footerPortletJavaScript)

getAddDefaultResource

public boolean getAddDefaultResource()

isAddDefaultResource

public boolean isAddDefaultResource()

setAddDefaultResource

public void setAddDefaultResource(boolean addDefaultResource)

setRoles

public void setRoles(java.lang.String roles)
Specified by:
setRoles in interface PortletModel

getRolesArray

public java.lang.String[] getRolesArray()

setRolesArray

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

getUnlinkedRoles

public java.util.Set getUnlinkedRoles()

setUnlinkedRoles

public void setUnlinkedRoles(java.util.Set unlinkedRoles)

getRoleMappers

public java.util.Map getRoleMappers()

setRoleMappers

public void setRoleMappers(java.util.Map roleMappers)

linkRoles

public void linkRoles()

hasRoleWithName

public boolean hasRoleWithName(java.lang.String roleName)

hasAddPortletPermission

public boolean hasAddPortletPermission(long userId)

getSystem

public boolean getSystem()

isSystem

public boolean isSystem()

setSystem

public void setSystem(boolean system)

getInclude

public boolean getInclude()

isInclude

public boolean isInclude()

setInclude

public void setInclude(boolean include)

getInitParams

public java.util.Map getInitParams()

setInitParams

public void setInitParams(java.util.Map initParams)

getExpCache

public java.lang.Integer getExpCache()

setExpCache

public void setExpCache(java.lang.Integer expCache)

getPortletModes

public java.util.Map getPortletModes()

setPortletModes

public void setPortletModes(java.util.Map portletModes)

hasPortletMode

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

getAllPortletModes

public java.util.Set getAllPortletModes()

hasMultipleMimeTypes

public boolean hasMultipleMimeTypes()

getSupportedLocales

public java.util.Set getSupportedLocales()

setSupportedLocales

public void setSupportedLocales(java.util.Set supportedLocales)

getResourceBundle

public java.lang.String getResourceBundle()

setResourceBundle

public void setResourceBundle(java.lang.String resourceBundle)

getPortletInfo

public PortletInfo getPortletInfo()

setPortletInfo

public void setPortletInfo(PortletInfo portletInfo)

getUserAttributes

public java.util.Set getUserAttributes()

setUserAttributes

public void setUserAttributes(java.util.Set userAttributes)

getCustomUserAttributes

public java.util.Map getCustomUserAttributes()

setCustomUserAttributes

public void setCustomUserAttributes(java.util.Map customUserAttributes)

getServletContextName

public java.lang.String getServletContextName()

setServletContextName

public void setServletContextName(java.lang.String servletContextName)

getWARFile

public boolean getWARFile()

isWARFile

public boolean isWARFile()

setWARFile

public void setWARFile(boolean warFile)

getContextPath

public java.lang.String getContextPath()

getClonedInstance

public Portlet getClonedInstance(java.lang.String portletId)

getStatic

public boolean getStatic()

isStatic

public boolean isStatic()

setStatic

public void setStatic(boolean staticPortlet)

getStaticStart

public boolean getStaticStart()

isStaticStart

public boolean isStaticStart()

setStaticStart

public void setStaticStart(boolean staticPortletStart)

getStaticEnd

public boolean getStaticEnd()

isStaticEnd

public boolean isStaticEnd()

getServletURLPatterns

public java.util.List getServletURLPatterns()

setServletURLPatterns

public void setServletURLPatterns(java.util.List servletURLPatterns)

clone

public java.lang.Object clone()
Specified by:
clone in interface BaseModel

compareTo

public int compareTo(java.lang.Object obj)
Specified by:
compareTo in interface java.lang.Comparable

equals

public boolean equals(java.lang.Object obj)