|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Portlet
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 PortletImpl
and rerun the
ServiceBuilder to generate the new methods.
PortletModel
,
PortletImpl
,
PortletModelImpl
Method Summary | |
---|---|
void |
addProcessingEvent(QName processingEvent)
Adds a supported processing event. |
void |
addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
Adds a supported public render parameter. |
void |
addPublishingEvent(QName publishingEvent)
Adds a supported publishing event. |
void |
addSchedulerEntry(SchedulerEntry schedulerEntry)
Adds a scheduler entry. |
java.lang.Object |
clone()
Creates and returns a copy of this object. |
int |
compareTo(Portlet portlet)
Compares this portlet to the specified object. |
boolean |
equals(java.lang.Object obj)
Checks whether this portlet is equal to the specified object. |
boolean |
getActionURLRedirect()
Returns true if an action URL for this portlet should cause an auto redirect. |
boolean |
getAddDefaultResource()
Returns true if default resources for the portlet are added to a page. |
boolean |
getAjaxable()
Returns true if the portlet can be displayed via Ajax. |
java.util.Set<java.lang.String> |
getAllPortletModes()
Gets a list of all portlet modes supported by the portlet. |
java.util.Set<java.lang.String> |
getAllWindowStates()
Gets a list of all window states supported by the portlet. |
java.util.List<java.lang.String> |
getAssetRendererFactoryClasses()
Gets the names of the classes that represent asset types associated to the portlet. |
java.util.List<AssetRendererFactory> |
getAssetRendererFactoryInstances()
Gets the asset type instances of the portlet. |
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. |
ConfigurationAction |
getConfigurationActionInstance()
Gets the configuration action instance of the portlet. |
java.lang.String |
getContextPath()
Gets the servlet context path of the portlet. |
java.lang.String |
getControlPanelEntryCategory()
Gets the name of the category of the Control Panel where the portlet will be shown. |
java.lang.String |
getControlPanelEntryClass()
Gets the name of the class that will control when the portlet will be shown in the Control Panel. |
ControlPanelEntry |
getControlPanelEntryInstance()
Gets an instance of the class that will control when the portlet will be shown in the Control Panel. |
double |
getControlPanelEntryWeight()
Gets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel. |
java.lang.String |
getCssClassWrapper()
Gets the name of the CSS class that will be injected in the DIV that wraps this portlet. |
java.util.List<java.lang.String> |
getCustomAttributesDisplayClasses()
Gets the names of the classes that represent custom attribute displays associated to the portlet. |
java.util.List<CustomAttributesDisplay> |
getCustomAttributesDisplayInstances()
Gets the custom attribute display instances of the portlet. |
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.lang.String |
getFacebookIntegration()
Gets the Facebook integration method of the portlet. |
java.util.List<java.lang.String> |
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<java.lang.String> |
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<java.lang.String> |
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<java.lang.String> |
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. |
FriendlyURLMapper |
getFriendlyURLMapperInstance()
Gets the friendly URL mapper instance of the portlet. |
java.lang.String |
getFriendlyURLRoutes()
Gets the class loader resource path to the friendly URL routes of the portlet. |
java.util.List<java.lang.String> |
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<java.lang.String> |
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<java.lang.String> |
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<java.lang.String> |
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. |
Indexer |
getIndexerInstance()
Gets the indexer instance of the portlet. |
java.util.Map<java.lang.String,java.lang.String> |
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. |
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. |
OpenSearch |
getOpenSearchInstance()
Gets the indexer instance of the portlet. |
java.lang.String |
getPluginId()
Gets the plugin id of the portlet. |
PluginPackage |
getPluginPackage()
Get the package to which the portlet belongs to. |
java.lang.String |
getPluginType()
Gets the plugin type of the portlet. |
java.lang.String |
getPollerProcessorClass()
Gets the name of the poller processor class of the portlet. |
PollerProcessor |
getPollerProcessorInstance()
Gets the poller processor instance of the portlet. |
java.lang.String |
getPopMessageListenerClass()
Gets the name of the POP message listener class of the portlet. |
MessageListener |
getPopMessageListenerInstance()
Gets the POP message listener instance of the portlet. |
boolean |
getPopUpPrint()
Returns true if the portlet goes into the pop up state when the user goes into the print mode. |
PortletApp |
getPortletApp()
Get the application this portlet belongs to. |
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. |
PortletDataHandler |
getPortletDataHandlerInstance()
Gets the portlet data handler instance of the portlet. |
java.util.Map<java.lang.String,PortletFilter> |
getPortletFilters()
Gets the filters of the portlet. |
PortletInfo |
getPortletInfo()
Gets the portlet info of the portlet. |
java.lang.String |
getPortletLayoutListenerClass()
Gets the name of the portlet layout listener class of the portlet. |
PortletLayoutListener |
getPortletLayoutListenerInstance()
Gets the portlet layout listener instance of the portlet. |
java.util.Map<java.lang.String,java.util.Set<java.lang.String>> |
getPortletModes()
Gets the portlet modes of the portlet. |
java.lang.String |
getPortletName()
Gets the name 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. |
QName |
getProcessingEvent(java.lang.String uri,
java.lang.String localPart)
Gets the supported processing event from a namespace URI and a local part. |
java.util.Set<QName> |
getProcessingEvents()
Gets the supported processing events of the portlet. |
PublicRenderParameter |
getPublicRenderParameter(java.lang.String identifier)
Gets the supported public render parameter from an identifier. |
PublicRenderParameter |
getPublicRenderParameter(java.lang.String uri,
java.lang.String localPart)
Gets the supported public render parameter from a namespace URI and a local part. |
java.util.Set<PublicRenderParameter> |
getPublicRenderParameters()
Gets the supported public render parameters of the portlet. |
java.util.Set<QName> |
getPublishingEvents()
Gets the supported publishing events of the portlet. |
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<java.lang.String,java.lang.String> |
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. |
java.util.List<SchedulerEntry> |
getSchedulerEntries()
Gets the scheduler entries of the portlet. |
boolean |
getScopeable()
Returns true if the portlet supports scoping of data. |
boolean |
getShowPortletAccessDenied()
Returns true if users are shown that they do not have access to the portlet. |
boolean |
getShowPortletInactive()
Returns true if users are shown that the portlet is inactive. |
java.lang.String |
getSocialActivityInterpreterClass()
Gets the name of the social activity interpreter class of the portlet. |
SocialActivityInterpreter |
getSocialActivityInterpreterInstance()
Gets the name of the social activity interpreter instance of the portlet. |
java.lang.String |
getSocialRequestInterpreterClass()
Gets the name of the social request interpreter class of the portlet. |
SocialRequestInterpreter |
getSocialRequestInterpreterInstance()
Gets the name of the social request interpreter instance of the portlet. |
boolean |
getStatic()
Returns true if the portlet is a static portlet that is cannot be moved. |
boolean |
getStaticEnd()
Returns true if the portlet is a static portlet at the end of a list of portlets. |
boolean |
getStaticStart()
Returns true if the portlet is a static portlet at the start of a list of portlets. |
java.lang.String |
getStrutsPath()
Gets the struts path of the portlet. |
java.util.Set<java.lang.String> |
getSupportedLocales()
Gets the supported locales of the portlet. |
boolean |
getSystem()
Returns true if the portlet is a system portlet that a user cannot manually add to their page. |
long |
getTimestamp()
Gets the timestamp of the portlet. |
boolean |
getUndeployedPortlet()
Returns true if the portlet is an undeployed portlet. |
java.util.Set<java.lang.String> |
getUnlinkedRoles()
Gets the unlinked roles of the portlet. |
java.lang.String |
getURLEncoderClass()
Gets the name of the URL encoder class of the portlet. |
URLEncoder |
getURLEncoderInstance()
Gets the URL encoder instance of the portlet. |
boolean |
getUseDefaultTemplate()
Returns true if the portlet uses the default template. |
java.lang.String |
getUserPrincipalStrategy()
Gets the user principal strategy of the portlet. |
java.lang.String |
getVirtualPath()
Gets the virtual path of the portlet. |
java.lang.String |
getWebDAVStorageClass()
Gets the name of the WebDAV storage class of the portlet. |
WebDAVStorage |
getWebDAVStorageInstance()
Gets the name of the WebDAV storage instance of the portlet. |
java.lang.String |
getWebDAVStorageToken()
Gets the name of the WebDAV storage token of the portlet. |
java.util.Map<java.lang.String,java.util.Set<java.lang.String>> |
getWindowStates()
Gets the window states of the portlet. |
java.util.List<java.lang.String> |
getWorkflowHandlerClasses()
Gets the names of the classes that represent workflow handlers associated to the portlet. |
java.util.List<WorkflowHandler> |
getWorkflowHandlerInstances()
Gets the workflow handler instances of the portlet. |
java.lang.String |
getXmlRpcMethodClass()
Gets the name of the XML-RPC method class of the portlet. |
Method |
getXmlRpcMethodInstance()
Gets the name of the XML-RPC method instance of the portlet. |
boolean |
hasAddPortletPermission(long userId)
Returns true if the user has the permission to add the portlet to a layout. |
boolean |
hasMultipleMimeTypes()
Returns true if the portlet supports more than one mime type. |
boolean |
hasPortletMode(java.lang.String mimeType,
javax.portlet.PortletMode portletMode)
Returns true if the portlet supports the specified mime type and portlet mode. |
boolean |
hasRoleWithName(java.lang.String roleName)
Returns true if the portlet has a role with the specified name. |
boolean |
hasWindowState(java.lang.String mimeType,
javax.portlet.WindowState windowState)
Returns true if the portlet supports the specified mime type and window state. |
boolean |
isActionURLRedirect()
Returns true if an action URL for this portlet should cause an auto redirect. |
boolean |
isAddDefaultResource()
Returns true if default resources for the portlet are added to a page. |
boolean |
isAjaxable()
Returns true if the portlet can be displayed via Ajax. |
boolean |
isInclude()
Returns true to include the portlet and make it available to be made active. |
boolean |
isInstanceable()
Returns true if the portlet can be added multiple times to a layout. |
boolean |
isLayoutCacheable()
Returns true to allow the portlet to be cached within the layout. |
boolean |
isMaximizeEdit()
Returns true if the portlet goes into the maximized state when the user goes into the edit mode. |
boolean |
isMaximizeHelp()
Returns true if the portlet goes into the maximized state when the user goes into the help mode. |
boolean |
isPopUpPrint()
Returns true if the portlet goes into the pop up state when the user goes into the print mode. |
boolean |
isPreferencesCompanyWide()
Returns true if preferences are shared across the entire company. |
boolean |
isPreferencesOwnedByGroup()
Returns true if preferences are owned by the group when the portlet is shown in a group layout. |
boolean |
isPreferencesUniquePerLayout()
Returns true if preferences are unique per layout. |
boolean |
isPrivateRequestAttributes()
Returns true if the portlet does not share request attributes with the portal or portlets from another WAR. |
boolean |
isPrivateSessionAttributes()
Returns true if the portlet does not share session attributes with the portal. |
boolean |
isRestoreCurrentView()
Returns true if the portlet restores to the current view from the maximized state. |
boolean |
isScopeable()
Returns true if the portlet supports scoping of data. |
boolean |
isShowPortletAccessDenied()
Returns true if users are shown that they do not have access to the portlet. |
boolean |
isShowPortletInactive()
Returns true if users are shown that the portlet is inactive. |
boolean |
isStatic()
Returns true if the portlet is a static portlet that is cannot be moved. |
boolean |
isStaticEnd()
Returns true if the portlet is a static portlet at the end of a list of portlets. |
boolean |
isStaticStart()
Returns true if the portlet is a static portlet at the start of a list of portlets. |
boolean |
isSystem()
Returns true if the portlet is a system portlet that a user cannot manually add to their page. |
boolean |
isUndeployedPortlet()
Returns true if the portlet is an undeployed portlet. |
boolean |
isUseDefaultTemplate()
Returns true if the portlet uses the default template. |
void |
linkRoles()
Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml. |
void |
setActionURLRedirect(boolean actionURLRedirect)
Set to true if an action URL for this portlet should cause an auto redirect. |
void |
setAddDefaultResource(boolean addDefaultResource)
Set to true if default resources for the portlet are added to a page. |
void |
setAjaxable(boolean ajaxable)
Set to true if the portlet can be displayed via Ajax. |
void |
setAssetRendererFactoryClasses(java.util.List<java.lang.String> assetRendererFactoryClasses)
Sets the name of the classes that represent asset types associated to the portlet. |
void |
setConfigurationActionClass(java.lang.String configurationActionClass)
Sets the configuration action class of the portlet. |
void |
setControlPanelEntryCategory(java.lang.String controlPanelEntryCategory)
Set the name of the category of the Control Panel where the portlet will be shown. |
void |
setControlPanelEntryClass(java.lang.String controlPanelEntryClass)
Sets the name of the class that will control when the portlet will be shown in the Control Panel. |
void |
setControlPanelEntryWeight(double controlPanelEntryWeight)
Sets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel. |
void |
setCssClassWrapper(java.lang.String cssClassWrapper)
Sets the name of the CSS class that will be injected in the DIV that wraps this portlet. |
void |
setCustomAttributesDisplayClasses(java.util.List<java.lang.String> customAttributesDisplayClasses)
Sets the name of the classes that represent custom attribute displays associated to the portlet. |
void |
setDefaultPluginSetting(PluginSetting pluginSetting)
Sets the default plugin settings of the portlet. |
void |
setDefaultPreferences(java.lang.String defaultPreferences)
Sets the default preferences of the portlet. |
void |
setDisplayName(java.lang.String displayName)
Sets the display name of the portlet. |
void |
setExpCache(java.lang.Integer expCache)
Sets expiration cache of the portlet. |
void |
setFacebookIntegration(java.lang.String facebookIntegration)
Sets the Facebook integration method of the portlet. |
void |
setFooterPortalCss(java.util.List<java.lang.String> footerPortalCss)
Sets a list of CSS files that will be referenced from the page's footer relative to the portal's context path. |
void |
setFooterPortalJavaScript(java.util.List<java.lang.String> footerPortalJavaScript)
Sets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path. |
void |
setFooterPortletCss(java.util.List<java.lang.String> footerPortletCss)
Sets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path. |
void |
setFooterPortletJavaScript(java.util.List<java.lang.String> footerPortletJavaScript)
Sets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path. |
void |
setFriendlyURLMapperClass(java.lang.String friendlyURLMapperClass)
Sets the name of the friendly URL mapper class of the portlet. |
void |
setFriendlyURLRoutes(java.lang.String friendlyURLRoutes)
Sets the class loader resource path to the friendly URL routes of the portlet. |
void |
setHeaderPortalCss(java.util.List<java.lang.String> headerPortalCss)
Sets a list of CSS files that will be referenced from the page's header relative to the portal's context path. |
void |
setHeaderPortalJavaScript(java.util.List<java.lang.String> headerPortalJavaScript)
Sets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path. |
void |
setHeaderPortletCss(java.util.List<java.lang.String> headerPortletCss)
Sets a list of CSS files that will be referenced from the page's header relative to the portlet's context path. |
void |
setHeaderPortletJavaScript(java.util.List<java.lang.String> headerPortletJavaScript)
Sets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path. |
void |
setIcon(java.lang.String icon)
Sets the icon of the portlet. |
void |
setInclude(boolean include)
Set to true to include the portlet and make it available to be made active. |
void |
setIndexerClass(java.lang.String indexerClass)
Sets the name of the indexer class of the portlet. |
void |
setInitParams(java.util.Map<java.lang.String,java.lang.String> initParams)
Sets the init parameters of the portlet. |
void |
setInstanceable(boolean instanceable)
Set to true if the portlet can be added multiple times to a layout. |
void |
setLayoutCacheable(boolean layoutCacheable)
Set to true to allow the portlet to be cached within the layout. |
void |
setMaximizeEdit(boolean maximizeEdit)
Set to true if the portlet goes into the maximized state when the user goes into the edit mode. |
void |
setMaximizeHelp(boolean maximizeHelp)
Set to true if the portlet goes into the maximized state when the user goes into the help mode. |
void |
setOpenSearchClass(java.lang.String openSearchClass)
Sets the name of the open search class of the portlet. |
void |
setPluginPackage(PluginPackage pluginPackage)
Sets the plugin package this portlet belongs to. |
void |
setPollerProcessorClass(java.lang.String pollerProcessorClass)
Sets the name of the poller processor class of the portlet. |
void |
setPopMessageListenerClass(java.lang.String popMessageListenerClass)
Sets the name of the POP message listener class of the portlet. |
void |
setPopUpPrint(boolean popUpPrint)
Set to true if the portlet goes into the pop up state when the user goes into the print mode. |
void |
setPortletApp(PortletApp portletApp)
Sets the application this portlet belongs to. |
void |
setPortletClass(java.lang.String portletClass)
Sets the name of the portlet class of the portlet. |
void |
setPortletDataHandlerClass(java.lang.String portletDataHandlerClass)
Sets the name of the portlet data handler class of the portlet. |
void |
setPortletFilters(java.util.Map<java.lang.String,PortletFilter> portletFilters)
Sets the filters of the portlet. |
void |
setPortletInfo(PortletInfo portletInfo)
Sets the portlet info of the portlet. |
void |
setPortletLayoutListenerClass(java.lang.String portletLayoutListenerClass)
Sets the name of the portlet layout listener class of the portlet. |
void |
setPortletModes(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> portletModes)
Sets the portlet modes of the portlet. |
void |
setPortletName(java.lang.String portletName)
Sets the name of the portlet. |
void |
setPortletURLClass(java.lang.String portletURLClass)
Sets the name of the portlet URL class of the portlet. |
void |
setPreferencesCompanyWide(boolean preferencesCompanyWide)
Set to true if preferences are shared across the entire company. |
void |
setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
Set to true if preferences are owned by the group when the portlet is shown in a group layout. |
void |
setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
Set to true if preferences are unique per layout. |
void |
setPreferencesValidator(java.lang.String preferencesValidator)
Sets the name of the preferences validator class of the portlet. |
void |
setPrivateRequestAttributes(boolean privateRequestAttributes)
Set to true if the portlet does not share request attributes with the portal or portlets from another WAR. |
void |
setPrivateSessionAttributes(boolean privateSessionAttributes)
Set to true if the portlet does not share session attributes with the portal. |
void |
setProcessingEvents(java.util.Set<QName> processingEvents)
Sets the supported processing events of the portlet. |
void |
setPublicRenderParameters(java.util.Set<PublicRenderParameter> publicRenderParameters)
Sets the supported public render parameters of the portlet. |
void |
setPublishingEvents(java.util.Set<QName> publishingEvents)
Sets the supported publishing events of the portlet. |
void |
setRenderWeight(int renderWeight)
Sets the render weight of the portlet. |
void |
setResourceBundle(java.lang.String resourceBundle)
Sets the resource bundle of the portlet. |
void |
setRestoreCurrentView(boolean restoreCurrentView)
Set to true if the portlet restores to the current view from the maximized state. |
void |
setRoleMappers(java.util.Map<java.lang.String,java.lang.String> roleMappers)
Sets the role mappers of the portlet. |
void |
setRoles(java.lang.String roles)
Sets a string of ordered comma delimited portlet ids. |
void |
setRolesArray(java.lang.String[] rolesArray)
Sets an array of required roles of the portlet. |
void |
setSchedulerEntries(java.util.List<SchedulerEntry> schedulerEntries)
Sets the scheduler entries of the portlet. |
void |
setScopeable(boolean scopeable)
Set to true if the portlet supports scoping of data. |
void |
setShowPortletAccessDenied(boolean showPortletAccessDenied)
Set to true if users are shown that they do not have access to the portlet. |
void |
setShowPortletInactive(boolean showPortletInactive)
Set to true if users are shown that the portlet is inactive. |
void |
setSocialActivityInterpreterClass(java.lang.String socialActivityInterpreterClass)
Sets the name of the social activity interpreter class of the portlet. |
void |
setSocialRequestInterpreterClass(java.lang.String socialRequestInterpreterClass)
Sets the name of the social request interpreter class of the portlet. |
void |
setStatic(boolean staticPortlet)
Set to true if the portlet is a static portlet that is cannot be moved. |
void |
setStaticStart(boolean staticPortletStart)
Set to true if the portlet is a static portlet at the start of a list of portlets. |
void |
setStrutsPath(java.lang.String strutsPath)
Sets the struts path of the portlet. |
void |
setSupportedLocales(java.util.Set<java.lang.String> supportedLocales)
Sets the supported locales of the portlet. |
void |
setSystem(boolean system)
Set to true if the portlet is a system portlet that a user cannot manually add to their page. |
void |
setTimestamp(long timestamp)
Sets the timestamp of the portlet. |
void |
setUndeployedPortlet(boolean undeployedPortlet)
Set to true if the portlet is an undeployed portlet. |
void |
setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles)
Sets the unlinked roles of the portlet. |
void |
setURLEncoderClass(java.lang.String urlEncoderClass)
Sets the name of the URL encoder class of the portlet. |
void |
setUseDefaultTemplate(boolean useDefaultTemplate)
Set to true if the portlet uses the default template. |
void |
setUserPrincipalStrategy(java.lang.String userPrincipalStrategy)
Sets the user principal strategy of the portlet. |
void |
setVirtualPath(java.lang.String virtualPath)
Sets the virtual path of the portlet. |
void |
setWebDAVStorageClass(java.lang.String webDAVStorageClass)
Sets the name of the WebDAV storage class of the portlet. |
void |
setWebDAVStorageToken(java.lang.String webDAVStorageToken)
Sets the name of the WebDAV storage token of the portlet. |
void |
setWindowStates(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> windowStates)
Sets the window states of the portlet. |
void |
setWorkflowHandlerClasses(java.util.List<java.lang.String> workflowHandlerClasses)
Sets the name of the classes that represent workflow handlers associated to the portlet. |
void |
setXmlRpcMethodClass(java.lang.String xmlRpcMethodClass)
Sets the name of the XML-RPC method class of the portlet. |
Methods inherited from interface com.liferay.portal.model.PortletModel |
---|
getActive, getCompanyId, getExpandoBridge, getId, getPortletId, getPrimaryKey, getPrimaryKeyObj, getRoles, hashCode, isActive, isCachedModel, isEscapedModel, isNew, setActive, setCachedModel, setCompanyId, setEscapedModel, setExpandoBridgeAttributes, setId, setNew, setPortletId, setPrimaryKey, toEscapedModel, toString, toXmlString |
Method Detail |
---|
java.lang.String getRootPortletId()
java.lang.String getInstanceId()
java.lang.String getPluginId()
java.lang.String getPluginType()
PluginPackage getPluginPackage()
void setPluginPackage(PluginPackage pluginPackage)
pluginPackage
- the plugin packagePluginSetting getDefaultPluginSetting()
void setDefaultPluginSetting(PluginSetting pluginSetting)
pluginSetting
- the plugin settinglong getTimestamp()
void setTimestamp(long timestamp)
timestamp
- the timestamp of the portletjava.lang.String getIcon()
void setIcon(java.lang.String icon)
icon
- the icon of the portletjava.lang.String getVirtualPath()
void setVirtualPath(java.lang.String virtualPath)
virtualPath
- the virtual path of the portletjava.lang.String getStrutsPath()
void setStrutsPath(java.lang.String strutsPath)
strutsPath
- the struts path of the portletjava.lang.String getPortletName()
void setPortletName(java.lang.String portletName)
portletName
- the name of the portletjava.lang.String getDisplayName()
void setDisplayName(java.lang.String displayName)
displayName
- the display name of the portletjava.lang.String getPortletClass()
void setPortletClass(java.lang.String portletClass)
portletClass
- the name of the portlet class of the portletjava.lang.String getConfigurationActionClass()
void setConfigurationActionClass(java.lang.String configurationActionClass)
configurationActionClass
- the configuration action class of the
portletConfigurationAction getConfigurationActionInstance()
java.lang.String getIndexerClass()
void setIndexerClass(java.lang.String indexerClass)
indexerClass
- the name of the indexer class of the portletIndexer getIndexerInstance()
java.lang.String getOpenSearchClass()
void setOpenSearchClass(java.lang.String openSearchClass)
openSearchClass
- the name of the open search class of the portletOpenSearch getOpenSearchInstance()
void addSchedulerEntry(SchedulerEntry schedulerEntry)
java.util.List<SchedulerEntry> getSchedulerEntries()
void setSchedulerEntries(java.util.List<SchedulerEntry> schedulerEntries)
schedulerEntries
- the scheduler entries of the portletjava.lang.String getPortletURLClass()
void setPortletURLClass(java.lang.String portletURLClass)
portletURLClass
- the name of the portlet URL class of the portletjava.lang.String getFriendlyURLMapperClass()
void setFriendlyURLMapperClass(java.lang.String friendlyURLMapperClass)
friendlyURLMapperClass
- the name of the friendly URL plugin class
of the portletFriendlyURLMapper getFriendlyURLMapperInstance()
java.lang.String getFriendlyURLRoutes()
void setFriendlyURLRoutes(java.lang.String friendlyURLRoutes)
friendlyURLRoutes
- the class loader resource path to the friendly
URL routes of the portletjava.lang.String getURLEncoderClass()
void setURLEncoderClass(java.lang.String urlEncoderClass)
urlEncoderClass
- the name of the URL encoder class of the portletURLEncoder getURLEncoderInstance()
java.lang.String getPortletDataHandlerClass()
void setPortletDataHandlerClass(java.lang.String portletDataHandlerClass)
portletDataHandlerClass
- the name of portlet data handler class of
the portletPortletDataHandler getPortletDataHandlerInstance()
java.lang.String getPortletLayoutListenerClass()
void setPortletLayoutListenerClass(java.lang.String portletLayoutListenerClass)
portletLayoutListenerClass
- the name of the portlet layout listener
class of the portletPortletLayoutListener getPortletLayoutListenerInstance()
java.lang.String getPollerProcessorClass()
void setPollerProcessorClass(java.lang.String pollerProcessorClass)
pollerProcessorClass
- the name of the poller processor class of the
portletPollerProcessor getPollerProcessorInstance()
java.lang.String getPopMessageListenerClass()
void setPopMessageListenerClass(java.lang.String popMessageListenerClass)
popMessageListenerClass
- the name of the POP message listener class
of the portletMessageListener getPopMessageListenerInstance()
java.lang.String getSocialActivityInterpreterClass()
void setSocialActivityInterpreterClass(java.lang.String socialActivityInterpreterClass)
socialActivityInterpreterClass
- the name of the activity
interpreter class of the portletSocialActivityInterpreter getSocialActivityInterpreterInstance()
java.lang.String getSocialRequestInterpreterClass()
void setSocialRequestInterpreterClass(java.lang.String socialRequestInterpreterClass)
socialRequestInterpreterClass
- the name of the request interpreter
class of the portletSocialRequestInterpreter getSocialRequestInterpreterInstance()
java.lang.String getWebDAVStorageToken()
void setWebDAVStorageToken(java.lang.String webDAVStorageToken)
webDAVStorageToken
- the name of the WebDAV storage token of the
portletjava.lang.String getWebDAVStorageClass()
void setWebDAVStorageClass(java.lang.String webDAVStorageClass)
webDAVStorageClass
- the name of the WebDAV storage class of the
portletWebDAVStorage getWebDAVStorageInstance()
java.lang.String getXmlRpcMethodClass()
void setXmlRpcMethodClass(java.lang.String xmlRpcMethodClass)
xmlRpcMethodClass
- the name of the XML-RPC method class of the
portletMethod getXmlRpcMethodInstance()
java.lang.String getControlPanelEntryCategory()
void setControlPanelEntryCategory(java.lang.String controlPanelEntryCategory)
controlPanelEntryCategory
- the name of the category of the Control
Panel where the portlet will be showndouble getControlPanelEntryWeight()
void setControlPanelEntryWeight(double controlPanelEntryWeight)
controlPanelEntryWeight
- the relative weight of the portlet with
respect to the other portlets in the same category of the Control
Paneljava.lang.String getControlPanelEntryClass()
void setControlPanelEntryClass(java.lang.String controlPanelEntryClass)
controlPanelEntryClass
- the name of the class that will control
when the portlet will be shown in the Control PanelControlPanelEntry getControlPanelEntryInstance()
java.util.List<java.lang.String> getAssetRendererFactoryClasses()
void setAssetRendererFactoryClasses(java.util.List<java.lang.String> assetRendererFactoryClasses)
assetRendererFactoryClasses
- the names of the classes that
represent asset types associated to the portletjava.util.List<AssetRendererFactory> getAssetRendererFactoryInstances()
java.util.List<java.lang.String> getCustomAttributesDisplayClasses()
void setCustomAttributesDisplayClasses(java.util.List<java.lang.String> customAttributesDisplayClasses)
customAttributesDisplayClasses
- the names of the classes that
represent custom attribute displays associated to the portletjava.util.List<CustomAttributesDisplay> getCustomAttributesDisplayInstances()
java.util.List<java.lang.String> getWorkflowHandlerClasses()
void setWorkflowHandlerClasses(java.util.List<java.lang.String> workflowHandlerClasses)
workflowHandlerClasses
- the names of the classes that represent
workflow handlers associated to the portletjava.util.List<WorkflowHandler> getWorkflowHandlerInstances()
java.lang.String getDefaultPreferences()
void setDefaultPreferences(java.lang.String defaultPreferences)
defaultPreferences
- the default preferences of the portletjava.lang.String getPreferencesValidator()
void setPreferencesValidator(java.lang.String preferencesValidator)
preferencesValidator
- the name of the preferences validator class
of the portletboolean getPreferencesCompanyWide()
boolean isPreferencesCompanyWide()
void setPreferencesCompanyWide(boolean preferencesCompanyWide)
preferencesCompanyWide
- boolean value for whether preferences are
shared across the entire companyboolean getPreferencesUniquePerLayout()
boolean isPreferencesUniquePerLayout()
void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
preferencesUniquePerLayout
- boolean value for whether preferences
are unique per layoutboolean getPreferencesOwnedByGroup()
boolean isPreferencesOwnedByGroup()
void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
preferencesOwnedByGroup
- boolean value for whether preferences are
owned by the group when the portlet is shown in a group layout or
preferences are owned by the user at all timesboolean getUseDefaultTemplate()
boolean isUseDefaultTemplate()
void setUseDefaultTemplate(boolean useDefaultTemplate)
useDefaultTemplate
- boolean value for whether the portlet uses the
default templateboolean getShowPortletAccessDenied()
boolean isShowPortletAccessDenied()
void setShowPortletAccessDenied(boolean showPortletAccessDenied)
showPortletAccessDenied
- boolean value for whether users are shown
that they do not have access to the portletboolean getShowPortletInactive()
boolean isShowPortletInactive()
void setShowPortletInactive(boolean showPortletInactive)
showPortletInactive
- boolean value for whether users are shown that
the portlet is inactiveboolean getActionURLRedirect()
boolean isActionURLRedirect()
void setActionURLRedirect(boolean actionURLRedirect)
actionURLRedirect
- boolean value for whether an action URL for this
portlet should cause an auto redirectboolean getRestoreCurrentView()
boolean isRestoreCurrentView()
void setRestoreCurrentView(boolean restoreCurrentView)
restoreCurrentView
- boolean value for whether the portlet restores
to the current view from the maximized stateboolean getMaximizeEdit()
boolean isMaximizeEdit()
void setMaximizeEdit(boolean maximizeEdit)
maximizeEdit
- boolean value for whether the portlet goes into the
maximized state when the user goes into the edit modeboolean getMaximizeHelp()
boolean isMaximizeHelp()
void setMaximizeHelp(boolean maximizeHelp)
maximizeHelp
- boolean value for whether the portlet goes into the
maximized state when the user goes into the help modeboolean getPopUpPrint()
boolean isPopUpPrint()
void setPopUpPrint(boolean popUpPrint)
popUpPrint
- boolean value for whether the portlet goes into the pop
up state when the user goes into the print modeboolean getLayoutCacheable()
boolean isLayoutCacheable()
void setLayoutCacheable(boolean layoutCacheable)
layoutCacheable
- boolean value for whether the portlet can be
cached within the layoutboolean getInstanceable()
boolean isInstanceable()
void setInstanceable(boolean instanceable)
instanceable
- boolean value for whether the portlet can be added
multiple times to a layoutboolean getScopeable()
boolean isScopeable()
void setScopeable(boolean scopeable)
scopeable
- boolean value for whether or not the the portlet
supports scoping of datajava.lang.String getUserPrincipalStrategy()
void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy)
userPrincipalStrategy
- the user principal strategy of the portletboolean getPrivateRequestAttributes()
boolean isPrivateRequestAttributes()
void setPrivateRequestAttributes(boolean privateRequestAttributes)
privateRequestAttributes
- boolean value for whether the portlet
shares request attributes with the portal or portlets from another
WARboolean getPrivateSessionAttributes()
boolean isPrivateSessionAttributes()
void setPrivateSessionAttributes(boolean privateSessionAttributes)
privateSessionAttributes
- boolean value for whether the portlet
shares session attributes with the portalint getRenderWeight()
void setRenderWeight(int renderWeight)
renderWeight
- int value for the render weight of the portletboolean getAjaxable()
boolean isAjaxable()
void setAjaxable(boolean ajaxable)
ajaxable
- boolean value for whether the portlet can be displayed
via Ajaxjava.util.List<java.lang.String> getHeaderPortalCss()
void setHeaderPortalCss(java.util.List<java.lang.String> headerPortalCss)
headerPortalCss
- a list of CSS files that will be referenced from
the page's header relative to the portal's context pathjava.util.List<java.lang.String> getHeaderPortletCss()
void setHeaderPortletCss(java.util.List<java.lang.String> headerPortletCss)
headerPortletCss
- a list of CSS files that will be referenced from
the page's header relative to the portlet's context pathjava.util.List<java.lang.String> getHeaderPortalJavaScript()
void setHeaderPortalJavaScript(java.util.List<java.lang.String> headerPortalJavaScript)
headerPortalJavaScript
- a list of JavaScript files that will be
referenced from the page's header relative to the portal's context
pathjava.util.List<java.lang.String> getHeaderPortletJavaScript()
void setHeaderPortletJavaScript(java.util.List<java.lang.String> headerPortletJavaScript)
headerPortletJavaScript
- a list of JavaScript files that will be
referenced from the page's header relative to the portlet's
context pathjava.util.List<java.lang.String> getFooterPortalCss()
void setFooterPortalCss(java.util.List<java.lang.String> footerPortalCss)
footerPortalCss
- a list of CSS files that will be referenced from
the page's footer relative to the portal's context pathjava.util.List<java.lang.String> getFooterPortletCss()
void setFooterPortletCss(java.util.List<java.lang.String> footerPortletCss)
footerPortletCss
- a list of CSS files that will be referenced from
the page's footer relative to the portlet's context pathjava.util.List<java.lang.String> getFooterPortalJavaScript()
void setFooterPortalJavaScript(java.util.List<java.lang.String> footerPortalJavaScript)
footerPortalJavaScript
- a list of JavaScript files that will be
referenced from the page's footer relative to the portal's context
pathjava.util.List<java.lang.String> getFooterPortletJavaScript()
void setFooterPortletJavaScript(java.util.List<java.lang.String> footerPortletJavaScript)
footerPortletJavaScript
- a list of JavaScript files that will be
referenced from the page's footer relative to the portlet's
context pathjava.lang.String getCssClassWrapper()
void setCssClassWrapper(java.lang.String cssClassWrapper)
cssClassWrapper
- the name of the CSS class that will be injected in
the DIV that wraps this portletjava.lang.String getFacebookIntegration()
void setFacebookIntegration(java.lang.String facebookIntegration)
facebookIntegration
- the Facebook integration method of the portletboolean getAddDefaultResource()
boolean isAddDefaultResource()
void setAddDefaultResource(boolean addDefaultResource)
addDefaultResource
- boolean value for whether or not default
resources for the portlet are added to a pagevoid setRoles(java.lang.String roles)
setRoles
in interface PortletModel
roles
- a string of ordered comma delimited portlet idsjava.lang.String[] getRolesArray()
void setRolesArray(java.lang.String[] rolesArray)
rolesArray
- an array of required roles of the portletjava.util.Set<java.lang.String> getUnlinkedRoles()
void setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles)
unlinkedRoles
- the unlinked roles of the portletjava.util.Map<java.lang.String,java.lang.String> getRoleMappers()
void setRoleMappers(java.util.Map<java.lang.String,java.lang.String> roleMappers)
roleMappers
- the role mappers of the portletvoid linkRoles()
boolean hasRoleWithName(java.lang.String roleName)
boolean hasAddPortletPermission(long userId)
boolean getSystem()
boolean isSystem()
void setSystem(boolean system)
system
- boolean value for whether the portlet is a system portlet
that a user cannot manually add to their pageboolean getInclude()
boolean isInclude()
void setInclude(boolean include)
include
- boolean value for whether to include the portlet and make
it available to be made activejava.util.Map<java.lang.String,java.lang.String> getInitParams()
void setInitParams(java.util.Map<java.lang.String,java.lang.String> initParams)
initParams
- the init parameters of the portletjava.lang.Integer getExpCache()
void setExpCache(java.lang.Integer expCache)
expCache
- expiration cache of the portletjava.util.Map<java.lang.String,java.util.Set<java.lang.String>> getPortletModes()
void setPortletModes(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> portletModes)
portletModes
- the portlet modes of the portletboolean hasPortletMode(java.lang.String mimeType, javax.portlet.PortletMode portletMode)
java.util.Set<java.lang.String> getAllPortletModes()
boolean hasMultipleMimeTypes()
java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getWindowStates()
void setWindowStates(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> windowStates)
windowStates
- the window states of the portletboolean hasWindowState(java.lang.String mimeType, javax.portlet.WindowState windowState)
java.util.Set<java.lang.String> getAllWindowStates()
java.util.Set<java.lang.String> getSupportedLocales()
void setSupportedLocales(java.util.Set<java.lang.String> supportedLocales)
supportedLocales
- the supported locales of the portletjava.lang.String getResourceBundle()
void setResourceBundle(java.lang.String resourceBundle)
resourceBundle
- the resource bundle of the portletPortletInfo getPortletInfo()
void setPortletInfo(PortletInfo portletInfo)
portletInfo
- the portlet info of the portletjava.util.Map<java.lang.String,PortletFilter> getPortletFilters()
void setPortletFilters(java.util.Map<java.lang.String,PortletFilter> portletFilters)
portletFilters
- the filters of the portletvoid addProcessingEvent(QName processingEvent)
QName getProcessingEvent(java.lang.String uri, java.lang.String localPart)
java.util.Set<QName> getProcessingEvents()
void setProcessingEvents(java.util.Set<QName> processingEvents)
processingEvents
- the supported processing events of the portletvoid addPublishingEvent(QName publishingEvent)
java.util.Set<QName> getPublishingEvents()
void setPublishingEvents(java.util.Set<QName> publishingEvents)
publishingEvents
- the supported publishing events of the portletvoid addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
publicRenderParameter
- a supported public render parameterPublicRenderParameter getPublicRenderParameter(java.lang.String identifier)
PublicRenderParameter getPublicRenderParameter(java.lang.String uri, java.lang.String localPart)
java.util.Set<PublicRenderParameter> getPublicRenderParameters()
void setPublicRenderParameters(java.util.Set<PublicRenderParameter> publicRenderParameters)
publicRenderParameters
- the supported public render parameters of
the portletjava.lang.String getContextPath()
PortletApp getPortletApp()
void setPortletApp(PortletApp portletApp)
portletApp
- the application this portlet belongs toPortlet getClonedInstance(java.lang.String portletId)
portletId
- the cloned instance portlet id
boolean getStatic()
boolean isStatic()
void setStatic(boolean staticPortlet)
staticPortlet
- boolean value for whether the portlet is a static
portlet that cannot be movedboolean getStaticStart()
boolean isStaticStart()
void setStaticStart(boolean staticPortletStart)
staticPortletStart
- boolean value for whether the portlet is a
static portlet at the start of a list of portletsboolean getStaticEnd()
boolean isStaticEnd()
boolean getUndeployedPortlet()
boolean isUndeployedPortlet()
void setUndeployedPortlet(boolean undeployedPortlet)
undeployedPortlet
- boolean value for whether the portlet is an
undeployed portletjava.lang.Object clone()
clone
in interface BaseModel<Portlet>
clone
in interface PortletModel
int compareTo(Portlet portlet)
compareTo
in interface java.lang.Comparable<Portlet>
compareTo
in interface PortletModel
portlet
- the portlet to compare this portlet against
boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- the object to compare this portlet against
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |