Package com.liferay.portal.kernel.model
Class PortletWrapper
Object
com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<Portlet>
com.liferay.portal.kernel.model.PortletWrapper
- All Implemented Interfaces:
BaseModel<Portlet>
,ClassedModel
,ModelWrapper<Portlet>
,MVCCModel
,PersistedModel
,Portlet
,PortletModel
,ShardedModel
,Serializable
,Cloneable
,Comparable<Portlet>
public class PortletWrapper
extends BaseModelWrapper<Portlet>
implements ModelWrapper<Portlet>, Portlet
This class is a wrapper for Portlet
.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Field Summary
Fields inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper
model
Fields inherited from interface com.liferay.portal.kernel.model.Portlet
ID_ACCESSOR, PORTLET_ID_ACCESSOR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addApplicationType
(ApplicationType applicationType) Adds an application type.void
addPortletDependency
(PortletDependency portletDependency) Adds a portlet CSS/JavaScript resource dependency.void
addProcessingEvent
(QName processingEvent) Adds a processing event.void
addPublicRenderParameter
(PublicRenderParameter publicRenderParameter) Adds a public render parameter.void
addPublishingEvent
(QName publishingEvent) Adds a publishing event.void
addSchedulerEntry
(SchedulerEntry schedulerEntry) Adds a scheduler entry.clone()
Creates and returns a copy of this object.int
Compares this portlet to the specified object.boolean
Checks whether this portlet is equal to the specified object.int
Returns the action timeout of the portlet.boolean
Returnstrue
if an action URL for this portlet should cause an auto redirect.boolean
Returns the active of this portlet.boolean
Returnstrue
if default resources for the portlet are added to a page.boolean
Returnstrue
if the portlet can be displayed via Ajax.Returns the portlet modes of the portlet.Returns the window states of the portlet.Returns the application types of the portlet.Returns the names of the classes that represent asset types associated with the portlet.Returns the names of the parameters that will be automatically propagated through the portlet.Returns the category names of the portlet.getClonedInstance
(String portletId) Returnstrue
if the portlet is found in a WAR file.long
Returns the company ID of this portlet.Returns the configuration action class of the portlet.Returns the configuration action instance of the portlet.Returns the servlet context name of the portlet.Returns the servlet context path of the portlet.Returns the name of the category of the Control Panel where the portlet will be shown.Returns the name of the class that will control when the portlet will be shown in the Control Panel.Returns an instance of the class that will control when the portlet will be shown in the Control Panel.double
Returns the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.Returns the name of the CSS class that will be injected in the DIV that wraps this portlet.Returns the names of the classes that represent custom attribute displays associated with the portlet.Returns the custom attribute display instances of the portlet.Get the default plugin settings of the portlet.Returns the default preferences of the portlet.Returns the display name of the portlet.Returns expiration cache of the portlet.Returns a list of CSS files that will be referenced from the page's footer relative to the portal's context path.Returns a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.Returns a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.Returns a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.Returns the name of the friendly URL mapper class of the portlet.Returns the friendly URL mapper instance of the portlet.Returns the name of the friendly URL mapping of the portlet.getFriendlyURLMapping
(boolean lookUpFriendlyURLMapper) Returns the class loader resource path to the friendly URL routes of the portlet.Returns a list of CSS files that will be referenced from the page's header relative to the portal's context path.Returns a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.Returns a list of CSS files that will be referenced from the page's header relative to the portlet's context path.Returns a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.Returns a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet.int
Returns the header timeout of the portlet.getIcon()
Returns the icon of the portlet.long
getId()
Returns the ID of this portlet.boolean
Returnstrue
to include the portlet and make it available to be made active.Returns the names of the classes that represent indexers associated with the portlet.Returns the indexer instances of the portlet.Returns the init parameters of the portlet.boolean
Returnstrue
if the portlet can be added multiple times to a layout.Returns the instance ID of the portlet.boolean
Returnstrue
to allow the portlet to be cached within the layout.boolean
Returnstrue
if the portlet goes into the maximized state when the user goes into the edit mode.boolean
Returnstrue
if the portlet goes into the maximized state when the user goes into the help mode.int
Returns the maximum size of buffered bytes before storing occurs.Returns the directory for storing uploaded files.long
Returns the maximum number of bytes permitted for an uploaded file.long
Returns the maximum number of bytes permitted for a multipart request.long
Returns the mvcc version of this portlet.Returns the name of the open search class of the portlet.Returns the indexer instance of the portlet.Returns the parent struts path of the portlet.Returns the name of the permission propagator class of the portlet.Returns the permission propagator instance of the portlet.Returns the plugin ID of the portlet.Returns this portlet's plugin package.Returns the plugin type of the portlet.Returns the name of the POP message listener class of the portlet.Returns the POP message listener instance of the portlet.boolean
Returnstrue
if the portlet goes into the pop up state when the user goes into the print mode.Returns this portlet's application.Returns the name of the portlet class of the portlet.Returns the name of the portlet data handler class of the portlet.Returns the portlet data handler instance of the portlet.Returns the portlet's CSS/JavaScript resource dependencies.Returns the filters of the portlet.Returns the portlet ID of this portlet.Returns the portlet info of the portlet.Returns the name of the portlet layout listener class of the portlet.Returns the portlet layout listener instance of the portlet.Returns the portlet modes of the portlet.Returns the name of the portlet.Returns the name of the portlet URL class of the portlet.boolean
Returnstrue
if preferences are shared across the entire company.boolean
Returnstrue
if preferences are owned by the group when the portlet is shown in a group layout.boolean
Returnstrue
if preferences are unique per layout.Returns the name of the preferences validator class of the portlet.long
Returns the primary key of this portlet.boolean
Returnstrue
if the portlet does not share request attributes with the portal or portlets from another WAR.boolean
Returnstrue
if the portlet does not share session attributes with the portal.getProcessingEvent
(String uri, String localPart) Returns the processing event from a namespace URI and a local part.Returns the processing events of the portlet.getPublicRenderParameter
(String identifier) Returns the public render parameter from an identifier.getPublicRenderParameter
(String uri, String localPart) Returns the spublic render parameter from a namespace URI and a local part.Returns the public render parameters of the portlet.Returns the publishing events of the portlet.boolean
getReady()
Returnstrue
if the portlet is ready to be used.int
Returns the render timeout of the portlet.int
Returns the render weight of the portlet.Returns the resource bundle of the portlet.boolean
Returnstrue
if the portlet restores to the current view from the maximized state.Returns the role mappers of the portlet.getRoles()
Returns the roles of this portlet.String[]
Returns an array of required roles of the portlet.Returns the root portlet of this portlet instance.Returns the root portlet ID of the portlet.Returns the scheduler entries of the portlet.boolean
Returnstrue
if the portlet supports scoping of data.boolean
Returnstrue
if users are shown that they do not have access to the portlet.boolean
Returnstrue
if users are shown that the portlet is inactive.boolean
Returnstrue
if the portlet uses Single Page Application.Returns the names of the classes that represent social activity interpreters associated with the portlet.Returns the social activity interpreter instances of the portlet.Returns the name of the social request interpreter class of the portlet.Returns the name of the social request interpreter instance of the portlet.Returns the names of the classes that represent staged model data handlers associated with the portlet.Returns the staged model data handler instances of the portlet.boolean
Returnstrue
if the portlet is a static portlet that is cannot be moved.boolean
Returnstrue
if the portlet is a static portlet at the end of a list of portlets.Returns the path for static resources served by this portlet.boolean
Returnstrue
if the portlet is a static portlet at the start of a list of portlets.Returns the struts path of the portlet.Returns the supported locales of the portlet.boolean
Returnstrue
if the portlet is a system portlet that a user cannot manually add to their page.Returns the name of the template handler class of the portlet.Returns the template handler instance of the portlet.long
Returns the timestamp of the portlet.Returns the names of the classes that represent trash handlers associated with the portlet.Returns the trash handler instances of the portlet.boolean
Returnstrue
if the portlet is an undeployed portlet.Returns the unlinked roles of the portlet.Returns the name of the URL encoder class of the portlet.Returns the URL encoder instance of the portlet.boolean
Returnstrue
if the portlet uses the default template.long
Returns the user ID of the portlet.Returns the class loader resource path to the use notification definitions of the portlet.Returns the names of the classes that represent user notification handlers associated with the portlet.Returns the user notification handler instances of the portlet.Returns the user principal strategy of the portlet.Returns the virtual path of the portlet.Returns the name of the WebDAV storage class of the portlet.Returns the name of the WebDAV storage instance of the portlet.Returns the name of the WebDAV storage token of the portlet.Returns the window states of the portlet.Returns the names of the classes that represent workflow handlers associated with the portlet.List<WorkflowHandler<?>>
Returns the workflow handler instances of the portlet.Returns the name of the XML-RPC method class of the portlet.Returns the name of the XML-RPC method instance of the portlet.boolean
hasAddPortletPermission
(long userId) Returnstrue
if the user has the permission to add the portlet to a layout.boolean
boolean
boolean
boolean
int
hashCode()
boolean
boolean
boolean
boolean
boolean
Returnstrue
if the portlet supports more than one mime type.boolean
hasPortletMode
(String mimeType, PortletMode portletMode) Returnstrue
if the portlet supports the specified mime type and portlet mode.boolean
hasRoleWithName
(String roleName) Returnstrue
if the portlet has a role with the specified name.boolean
hasWindowState
(String mimeType, WindowState windowState) Returnstrue
if the portlet supports the specified mime type and window state.boolean
Returnstrue
if an action URL for this portlet should cause an auto redirect.boolean
isActive()
Returnstrue
if this portlet is active.boolean
Returnstrue
if default resources for the portlet are added to a page.boolean
Returnstrue
if the portlet can be displayed via Ajax.boolean
Returnstrue
if the portlet supports asynchronous processing in resource requests.boolean
boolean
Returnstrue
to include the portlet and make it available to be made active.boolean
Returnstrue
if the portlet can be added multiple times to a layout.boolean
Returnstrue
to allow the portlet to be cached within the layout.boolean
Returnstrue
if the portlet goes into the maximized state when the user goes into the edit mode.boolean
Returnstrue
if the portlet goes into the maximized state when the user goes into the help mode.boolean
Returnstrue
if the portlet'sserveResource(ResourceRequest,ResourceResponse)
method should be invoked during a partial action triggered by a different portlet on the same portal page.boolean
Returnstrue
if the portlet goes into the pop up state when the user goes into the print mode.boolean
Returnstrue
if the CSS resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.boolean
Returnstrue
if the JavaScript resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.boolean
Returnstrue
if preferences are shared across the entire company.boolean
Returnstrue
if preferences are owned by the group when the portlet is shown in a group layout.boolean
Returnstrue
if preferences are unique per layout.boolean
Returnstrue
if the portlet does not share request attributes with the portal or portlets from another WAR.boolean
Returnstrue
if the portlet does not share session attributes with the portal.boolean
isReady()
Returnstrue
if the portlet is ready to be used.boolean
Returnstrue
if the portlet will only process namespaced parameters.boolean
Returnstrue
if the portlet restores to the current view from the maximized state.boolean
Returnstrue
if the portlet supports scoping of data.boolean
Returnstrue
if users are shown that they do not have access to the portlet.boolean
Returnstrue
if users are shown that the portlet is inactive.boolean
Returnstrue
if the portlet uses Single Page Application.boolean
isStatic()
Returnstrue
if the portlet is a static portlet that is cannot be moved.boolean
Returnstrue
if the portlet is a static portlet at the end of a list of portlets.boolean
Returnstrue
if the portlet is a static portlet at the start of a list of portlets.boolean
isSystem()
Returnstrue
if the portlet is a system portlet that a user cannot manually add to their page.boolean
Returnstrue
if the portlet is an undeployed portlet.boolean
Returnstrue
if the portlet uses the default template.void
Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml.void
persist()
Updates this model instance in the database or adds it if it does not yet exist.void
setActionTimeout
(int actionTimeout) Sets the action timeout of the portlet.void
setActionURLRedirect
(boolean actionURLRedirect) Set totrue
if an action URL for this portlet should cause an auto redirect.void
setActive
(boolean active) Sets whether this portlet is active.void
setAddDefaultResource
(boolean addDefaultResource) Set totrue
if default resources for the portlet are added to a page.void
setAjaxable
(boolean ajaxable) Set totrue
if the portlet can be displayed via Ajax.void
setApplicationTypes
(Set<ApplicationType> applicationTypes) Sets the application types of the portlet.void
setAssetRendererFactoryClasses
(List<String> assetRendererFactoryClasses) Sets the names of the classes that represent asset types associated with the portlet.void
setAsyncSupported
(boolean asyncSupported) Set totrue
if the portlet supports asynchronous processing in resource requests.void
setAutopropagatedParameters
(Set<String> autopropagatedParameters) Sets the names of the parameters that will be automatically propagated through the portlet.void
setCategoryNames
(Set<String> categoryNames) Sets the category names of the portlet.void
setCompanyId
(long companyId) Sets the company ID of this portlet.void
setConfigurationActionClass
(String configurationActionClass) Sets the configuration action class of the portlet.void
setControlPanelEntryCategory
(String controlPanelEntryCategory) Set the name of the category of the Control Panel where the portlet will be shown.void
setControlPanelEntryClass
(String controlPanelEntryClass) Sets the name of the class that will control when the portlet will be shown in the Control Panel.void
setControlPanelEntryWeight
(double controlPanelEntryWeight) Sets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.void
setCssClassWrapper
(String cssClassWrapper) Sets the name of the CSS class that will be injected in the DIV that wraps this portlet.void
setCustomAttributesDisplayClasses
(List<String> customAttributesDisplayClasses) Sets the names of the classes that represent custom attribute displays associated with the portlet.void
setDefaultPluginSetting
(PluginSetting pluginSetting) Sets the default plugin settings of the portlet.void
setDefaultPreferences
(String defaultPreferences) Sets the default preferences of the portlet.void
setDisplayName
(String displayName) Sets the display name of the portlet.void
setExpCache
(Integer expCache) Sets expiration cache of the portlet.void
setFooterPortalCss
(List<String> footerPortalCss) Sets a list of CSS files that will be referenced from the page's footer relative to the portal's context path.void
setFooterPortalJavaScript
(List<String> footerPortalJavaScript) Sets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path.void
setFooterPortletCss
(List<String> footerPortletCss) Sets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path.void
setFooterPortletJavaScript
(List<String> footerPortletJavaScript) Sets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path.void
setFriendlyURLMapperClass
(String friendlyURLMapperClass) Sets the name of the friendly URL mapper class of the portlet.void
setFriendlyURLMapping
(String friendlyURLMapping) Sets the name of the friendly URL mapping of the portlet.void
setFriendlyURLRoutes
(String friendlyURLRoutes) Sets the class loader resource path to the friendly URL routes of the portlet.void
setHeaderPortalCss
(List<String> headerPortalCss) Sets a list of CSS files that will be referenced from the page's header relative to the portal's context path.void
setHeaderPortalJavaScript
(List<String> headerPortalJavaScript) Sets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path.void
setHeaderPortletCss
(List<String> headerPortletCss) Sets a list of CSS files that will be referenced from the page's header relative to the portlet's context path.void
setHeaderPortletJavaScript
(List<String> headerPortletJavaScript) Sets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path.void
setHeaderRequestAttributePrefixes
(List<String> headerRequestAttributePrefixes) Sets a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet.void
setHeaderTimeout
(int headerTimeout) Sets the header timeout of the portlet.void
Sets the icon of the portlet.void
setId
(long id) Sets the ID of this portlet.void
setInclude
(boolean include) Set totrue
to include the portlet and make it available to be made active.void
setIndexerClasses
(List<String> indexerClasses) Sets the names of the classes that represent indexers associated with the portlet.void
setInitParams
(Map<String, String> initParams) Sets the init parameters of the portlet.void
setInstanceable
(boolean instanceable) Set totrue
if the portlet can be added multiple times to a layout.void
setLayoutCacheable
(boolean layoutCacheable) Set totrue
to allow the portlet to be cached within the layout.void
setMaximizeEdit
(boolean maximizeEdit) Set totrue
if the portlet goes into the maximized state when the user goes into the edit mode.void
setMaximizeHelp
(boolean maximizeHelp) Set totrue
if the portlet goes into the maximized state when the user goes into the help mode.void
setModelAttributes
(Map<String, Object> attributes) void
setMultipartFileSizeThreshold
(int multipartFileSizeThreshold) Sets the maximum size of buffered bytes before storing occurs.void
setMultipartLocation
(String multipartLocation) Sets the directory for storing uploaded files.void
setMultipartMaxFileSize
(long multipartMaxFileSize) Sets the maximum number of bytes permitted for an uploaded file.void
setMultipartMaxRequestSize
(long multipartMaxRequestSize) Sets the maximum number of bytes permitted for a multipart request.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this portlet.void
setOpenSearchClass
(String openSearchClass) Sets the name of the open search class of the portlet.void
setParentStrutsPath
(String parentStrutsPath) Sets the parent struts path of the portlet.void
setPartialActionServeResource
(boolean partialActionServeResource) Sets whether the portlet's serve resource should be invoked during a partial action triggered by a different portlet on the same portal page.void
setPermissionPropagatorClass
(String permissionPropagatorClass) Sets the name of the permission propagator class of the portlet.void
setPluginPackage
(PluginPackage pluginPackage) Sets this portlet's plugin package.void
setPopMessageListenerClass
(String popMessageListenerClass) Sets the name of the POP message listener class of the portlet.void
setPopUpPrint
(boolean popUpPrint) Sets whether the portlet goes into the pop up state when the user goes into the print mode.void
setPortletApp
(PortletApp portletApp) Sets this portlet's application.void
setPortletClass
(String portletClass) Sets the name of the portlet class of the portlet.void
setPortletConfigurationListenerClass
(String portletConfigurationListenerClass) void
setPortletDataHandlerClass
(String portletDataHandlerClass) Sets the name of the portlet data handler class of the portlet.void
setPortletDependencyCssEnabled
(boolean portletDependencyCssEnabled) Sets whether the CSS resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.void
setPortletDependencyJavaScriptEnabled
(boolean portletDependencyJavaScriptEnabled) Sets whether the JavaScript resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.void
setPortletFilters
(Map<String, PortletFilter> portletFilters) Sets the filters of the portlet.void
setPortletId
(String portletId) Sets the portlet ID of this portlet.void
setPortletInfo
(PortletInfo portletInfo) Sets the portlet info of the portlet.void
setPortletLayoutListenerClass
(String portletLayoutListenerClass) Sets the name of the portlet layout listener class of the portlet.void
setPortletModes
(Map<String, Set<String>> portletModes) Sets the portlet modes of the portlet.void
setPortletName
(String portletName) Sets the name of the portlet.void
setPortletURLClass
(String portletURLClass) Sets the name of the portlet URL class of the portlet.void
setPreferencesCompanyWide
(boolean preferencesCompanyWide) Set totrue
if preferences are shared across the entire company.void
setPreferencesOwnedByGroup
(boolean preferencesOwnedByGroup) Set totrue
if preferences are owned by the group when the portlet is shown in a group layout.void
setPreferencesUniquePerLayout
(boolean preferencesUniquePerLayout) Set totrue
if preferences are unique per layout.void
setPreferencesValidator
(String preferencesValidator) Sets the name of the preferences validator class of the portlet.void
setPrimaryKey
(long primaryKey) Sets the primary key of this portlet.void
setPrivateRequestAttributes
(boolean privateRequestAttributes) Set totrue
if the portlet does not share request attributes with the portal or portlets from another WAR.void
setPrivateSessionAttributes
(boolean privateSessionAttributes) Set totrue
if the portlet does not share session attributes with the portal.void
setProcessingEvents
(Set<QName> processingEvents) Sets the processing events of the portlet.void
setPublicRenderParameters
(Set<PublicRenderParameter> publicRenderParameters) Sets the public render parameters of the portlet.void
setPublishingEvents
(Set<QName> publishingEvents) Sets the publishing events of the portlet.void
setReady
(boolean ready) Set totrue
if the portlet is ready to be used.void
setRenderTimeout
(int renderTimeout) Sets the render timeout of the portlet.void
setRenderWeight
(int renderWeight) Sets the render weight of the portlet.void
setRequiresNamespacedParameters
(boolean requiresNamespacedParameters) Set totrue
if the portlet will only process namespaced parameters.void
setResourceBundle
(String resourceBundle) Sets the resource bundle of the portlet.void
setRestoreCurrentView
(boolean restoreCurrentView) Set totrue
if the portlet restores to the current view from the maximized state.void
setRoleMappers
(Map<String, String> roleMappers) Sets the role mappers of the portlet.void
Sets the roles of this portlet.void
setRolesArray
(String[] rolesArray) Sets an array of required roles of the portlet.void
setSchedulerEntries
(List<SchedulerEntry> schedulerEntries) Sets the scheduler entries of the portlet.void
setScopeable
(boolean scopeable) Set totrue
if the portlet supports scoping of data.void
setShowPortletAccessDenied
(boolean showPortletAccessDenied) Set totrue
if users are shown that they do not have access to the portlet.void
setShowPortletInactive
(boolean showPortletInactive) Set totrue
if users are shown that the portlet is inactive.void
setSinglePageApplication
(boolean singlePageApplication) Set totrue
if the portlet uses Single Page Application.void
setSocialActivityInterpreterClasses
(List<String> socialActivityInterpreterClasses) Sets the names of the classes that represent social activity interpreters associated with the portlet.void
setSocialRequestInterpreterClass
(String socialRequestInterpreterClass) Sets the name of the social request interpreter class of the portlet.void
setStagedModelDataHandlerClasses
(List<String> stagedModelDataHandlerClasses) Sets the names of the classes that represent staged model data handlers associated with the portlet.void
setStatic
(boolean staticPortlet) Set totrue
if the portlet is a static portlet that is cannot be moved.void
setStaticStart
(boolean staticPortletStart) Set totrue
if the portlet is a static portlet at the start of a list of portlets.void
setStrutsPath
(String strutsPath) Sets the struts path of the portlet.void
setSupportedLocales
(Set<String> supportedLocales) Sets the supported locales of the portlet.void
setSystem
(boolean system) Set totrue
if the portlet is a system portlet that a user cannot manually add to their page.void
setTemplateHandlerClass
(String templateHandlerClass) Sets the name of the template handler class of the portlet.void
setTrashHandlerClasses
(List<String> trashHandlerClasses) Sets the names of the classes that represent trash handlers associated to the portlet.void
setUndeployedPortlet
(boolean undeployedPortlet) Set totrue
if the portlet is an undeployed portlet.void
setUnlinkedRoles
(Set<String> unlinkedRoles) Sets the unlinked roles of the portlet.void
setURLEncoderClass
(String urlEncoderClass) Sets the name of the URL encoder class of the portlet.void
setUseDefaultTemplate
(boolean useDefaultTemplate) Set totrue
if the portlet uses the default template.void
setUserNotificationDefinitions
(String userNotificationDefinitions) Sets the class loader resource path to the user notification definitions of the portlet.void
setUserNotificationHandlerClasses
(List<String> userNotificationHandlerClasses) Sets the names of the classes that represent user notification handlers associated with the portlet.void
setUserPrincipalStrategy
(String userPrincipalStrategy) Sets the user principal strategy of the portlet.void
setVirtualPath
(String virtualPath) Sets the virtual path of the portlet.void
setWebDAVStorageClass
(String webDAVStorageClass) Sets the name of the WebDAV storage class of the portlet.void
setWebDAVStorageToken
(String webDAVStorageToken) Sets the name of the WebDAV storage token of the portlet.void
setWindowStates
(Map<String, Set<String>> windowStates) Sets the window states of the portlet.void
setWorkflowHandlerClasses
(List<String> workflowHandlerClasses) Sets the names of the classes that represent workflow handlers associated to the portlet.void
setXmlRpcMethodClass
(String xmlRpcMethodClass) Sets the name of the XML-RPC method class of the portlet.void
protected PortletWrapper
Methods inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper
getExpandoBridge, getModelClass, getModelClassName, getPrimaryKeyObj, getWrappedModel, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString, toUnescapedModel
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface com.liferay.portal.kernel.model.ModelWrapper
getWrappedModel
-
Constructor Details
-
PortletWrapper
-
-
Method Details
-
getModelAttributes
- Specified by:
getModelAttributes
in interfaceBaseModel<Portlet>
-
setModelAttributes
- Specified by:
setModelAttributes
in interfaceBaseModel<Portlet>
-
addApplicationType
Adds an application type.- Specified by:
addApplicationType
in interfacePortlet
- Parameters:
applicationType
- an application type
-
addPortletDependency
Adds a portlet CSS/JavaScript resource dependency.- Specified by:
addPortletDependency
in interfacePortlet
- Parameters:
portletDependency
- the portlet CSS/JavaScript resource dependency
-
addProcessingEvent
Adds a processing event.- Specified by:
addProcessingEvent
in interfacePortlet
-
addPublicRenderParameter
Adds a public render parameter.- Specified by:
addPublicRenderParameter
in interfacePortlet
- Parameters:
publicRenderParameter
- a public render parameter
-
addPublishingEvent
Adds a publishing event.- Specified by:
addPublishingEvent
in interfacePortlet
-
addSchedulerEntry
Adds a scheduler entry.- Specified by:
addSchedulerEntry
in interfacePortlet
-
clone
Creates and returns a copy of this object. -
cloneWithOriginalValues
- Specified by:
cloneWithOriginalValues
in interfaceBaseModel<Portlet>
- Specified by:
cloneWithOriginalValues
in interfacePortletModel
-
compareTo
Compares this portlet to the specified object.- Specified by:
compareTo
in interfaceComparable<Portlet>
- Specified by:
compareTo
in interfacePortlet
- Overrides:
compareTo
in classBaseModelWrapper<Portlet>
- Parameters:
portlet
- the portlet to compare this portlet against- Returns:
- the value 0 if the argument portlet is equal to this portlet; a value less than -1 if this portlet is less than the portlet argument; and 1 if this portlet is greater than the portlet argument
-
equals
Checks whether this portlet is equal to the specified object.- Specified by:
equals
in interfacePortlet
- Overrides:
equals
in classBaseModelWrapper<Portlet>
- Parameters:
object
- the object to compare this portlet against- Returns:
true
if the portlet is equal to the specified object
-
getActionTimeout
public int getActionTimeout()Returns the action timeout of the portlet.- Specified by:
getActionTimeout
in interfacePortlet
- Returns:
- the action timeout of the portlet
-
getActionURLRedirect
public boolean getActionURLRedirect()Returnstrue
if an action URL for this portlet should cause an auto redirect.- Specified by:
getActionURLRedirect
in interfacePortlet
- Returns:
true
if an action URL for this portlet should cause an auto redirect
-
getActive
public boolean getActive()Returns the active of this portlet.- Specified by:
getActive
in interfacePortletModel
- Returns:
- the active of this portlet
-
getAddDefaultResource
public boolean getAddDefaultResource()Returnstrue
if default resources for the portlet are added to a page.- Specified by:
getAddDefaultResource
in interfacePortlet
- Returns:
true
if default resources for the portlet are added to a page
-
getAjaxable
public boolean getAjaxable()Returnstrue
if the portlet can be displayed via Ajax.- Specified by:
getAjaxable
in interfacePortlet
- Returns:
true
if the portlet can be displayed via Ajax
-
getAllPortletModes
Returns the portlet modes of the portlet.- Specified by:
getAllPortletModes
in interfacePortlet
- Returns:
- the portlet modes of the portlet
-
getAllWindowStates
Returns the window states of the portlet.- Specified by:
getAllWindowStates
in interfacePortlet
- Returns:
- the window states of the portlet
-
getApplicationTypes
Returns the application types of the portlet.- Specified by:
getApplicationTypes
in interfacePortlet
- Returns:
- the application types of the portlet
-
getAssetRendererFactoryClasses
Returns the names of the classes that represent asset types associated with the portlet.- Specified by:
getAssetRendererFactoryClasses
in interfacePortlet
- Returns:
- the names of the classes that represent asset types associated with the portlet
-
getAutopropagatedParameters
Returns the names of the parameters that will be automatically propagated through the portlet.- Specified by:
getAutopropagatedParameters
in interfacePortlet
- Returns:
- the names of the parameters that will be automatically propagated through the portlet
-
getCategoryNames
Returns the category names of the portlet.- Specified by:
getCategoryNames
in interfacePortlet
- Returns:
- the category names of the portlet
-
getClonedInstance
Returnstrue
if the portlet is found in a WAR file.- Specified by:
getClonedInstance
in interfacePortlet
- Parameters:
portletId
- the cloned instance portlet ID- Returns:
- a cloned instance of the portlet
-
getCompanyId
public long getCompanyId()Returns the company ID of this portlet.- Specified by:
getCompanyId
in interfacePortletModel
- Specified by:
getCompanyId
in interfaceShardedModel
- Returns:
- the company ID of this portlet
-
getConfigurationActionClass
Returns the configuration action class of the portlet.- Specified by:
getConfigurationActionClass
in interfacePortlet
- Returns:
- the configuration action class of the portlet
-
getConfigurationActionInstance
Returns the configuration action instance of the portlet.- Specified by:
getConfigurationActionInstance
in interfacePortlet
- Returns:
- the configuration action instance of the portlet
-
getContextName
Returns the servlet context name of the portlet.- Specified by:
getContextName
in interfacePortlet
- Returns:
- the servlet context name of the portlet
-
getContextPath
Returns the servlet context path of the portlet.- Specified by:
getContextPath
in interfacePortlet
- Returns:
- the servlet context path of the portlet
-
getControlPanelEntryCategory
Returns the name of the category of the Control Panel where the portlet will be shown.- Specified by:
getControlPanelEntryCategory
in interfacePortlet
- Returns:
- the name of the category of the Control Panel where the portlet will be shown
-
getControlPanelEntryClass
Returns the name of the class that will control when the portlet will be shown in the Control Panel.- Specified by:
getControlPanelEntryClass
in interfacePortlet
- Returns:
- the name of the class that will control when the portlet will be shown in the Control Panel
-
getControlPanelEntryInstance
Returns an instance of the class that will control when the portlet will be shown in the Control Panel.- Specified by:
getControlPanelEntryInstance
in interfacePortlet
- Returns:
- the instance of the class that will control when the portlet will be shown in the Control Panel
-
getControlPanelEntryWeight
public double getControlPanelEntryWeight()Returns the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.- Specified by:
getControlPanelEntryWeight
in interfacePortlet
- Returns:
- the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel
-
getCssClassWrapper
Returns the name of the CSS class that will be injected in the DIV that wraps this portlet.- Specified by:
getCssClassWrapper
in interfacePortlet
- Returns:
- the name of the CSS class that will be injected in the DIV that wraps this portlet
-
getCustomAttributesDisplayClasses
Returns the names of the classes that represent custom attribute displays associated with the portlet.- Specified by:
getCustomAttributesDisplayClasses
in interfacePortlet
- Returns:
- the names of the classes that represent asset types associated with the portlet
-
getCustomAttributesDisplayInstances
Returns the custom attribute display instances of the portlet.- Specified by:
getCustomAttributesDisplayInstances
in interfacePortlet
- Returns:
- the custom attribute display instances of the portlet
-
getDefaultPluginSetting
Get the default plugin settings of the portlet.- Specified by:
getDefaultPluginSetting
in interfacePortlet
- Returns:
- the plugin settings
-
getDefaultPreferences
Returns the default preferences of the portlet.- Specified by:
getDefaultPreferences
in interfacePortlet
- Returns:
- the default preferences of the portlet
-
getDisplayName
Returns the display name of the portlet.- Specified by:
getDisplayName
in interfacePortlet
- Returns:
- the display name of the portlet
-
getExpCache
Returns expiration cache of the portlet.- Specified by:
getExpCache
in interfacePortlet
- Returns:
- expiration cache of the portlet
-
getFriendlyURLMapperClass
Returns the name of the friendly URL mapper class of the portlet.- Specified by:
getFriendlyURLMapperClass
in interfacePortlet
- Returns:
- the name of the friendly URL mapper class of the portlet
-
getFriendlyURLMapperInstance
Returns the friendly URL mapper instance of the portlet.- Specified by:
getFriendlyURLMapperInstance
in interfacePortlet
- Returns:
- the friendly URL mapper instance of the portlet
-
getFriendlyURLMapping
Returns the name of the friendly URL mapping of the portlet.- Specified by:
getFriendlyURLMapping
in interfacePortlet
- Returns:
- the name of the friendly URL mapping of the portlet
-
getFriendlyURLMapping
- Specified by:
getFriendlyURLMapping
in interfacePortlet
-
getFriendlyURLRoutes
Returns the class loader resource path to the friendly URL routes of the portlet.- Specified by:
getFriendlyURLRoutes
in interfacePortlet
- Returns:
- the class loader resource path to the friendly URL routes of the portlet
-
getHeaderPortalCss
Returns 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 interfacePortlet
- Returns:
- a list of CSS files that will be referenced from the page's header relative to the portal's context path
-
getHeaderPortalJavaScript
Returns 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 interfacePortlet
- Returns:
- a list of JavaScript files that will be referenced from the page's header relative to the portal's context path
-
getHeaderPortletCss
Returns 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 interfacePortlet
- Returns:
- a list of CSS files that will be referenced from the page's header relative to the portlet's context path
-
getHeaderPortletJavaScript
Returns 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 interfacePortlet
- Returns:
- a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path
-
getHeaderRequestAttributePrefixes
Returns a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet. Header request attributes that have names starting with any of the prefixes will be copied from the header request to the subsequent render request.- Specified by:
getHeaderRequestAttributePrefixes
in interfacePortlet
- Returns:
- a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet. Header request attributes that have names starting with any of the prefixes will be copied from the header request to the subsequent render request.
-
getHeaderTimeout
public int getHeaderTimeout()Returns the header timeout of the portlet.- Specified by:
getHeaderTimeout
in interfacePortlet
- Returns:
- the header timeout of the portlet
-
getIcon
Returns the icon of the portlet. -
getId
public long getId()Returns the ID of this portlet.- Specified by:
getId
in interfacePortletModel
- Returns:
- the ID of this portlet
-
getInclude
public boolean getInclude()Returnstrue
to include the portlet and make it available to be made active.- Specified by:
getInclude
in interfacePortlet
- Returns:
true
to include the portlet and make it available to be made active
-
getIndexerClasses
Returns the names of the classes that represent indexers associated with the portlet.- Specified by:
getIndexerClasses
in interfacePortlet
- Returns:
- the names of the classes that represent indexers associated with the portlet
-
getIndexerInstances
Returns the indexer instances of the portlet.- Specified by:
getIndexerInstances
in interfacePortlet
- Returns:
- the indexer instances of the portlet
-
getInitParams
Returns the init parameters of the portlet.- Specified by:
getInitParams
in interfacePortlet
- Returns:
- init parameters of the portlet
-
getInstanceable
public boolean getInstanceable()Returnstrue
if the portlet can be added multiple times to a layout.- Specified by:
getInstanceable
in interfacePortlet
- Returns:
true
if the portlet can be added multiple times to a layout
-
getInstanceId
Returns the instance ID of the portlet.- Specified by:
getInstanceId
in interfacePortlet
- Returns:
- the instance ID of the portlet
-
getLayoutCacheable
public boolean getLayoutCacheable()Returnstrue
to allow the portlet to be cached within the layout.- Specified by:
getLayoutCacheable
in interfacePortlet
- Returns:
true
if the portlet can be cached within the layout
-
getMaximizeEdit
public boolean getMaximizeEdit()Returnstrue
if the portlet goes into the maximized state when the user goes into the edit mode.- Specified by:
getMaximizeEdit
in interfacePortlet
- Returns:
true
if the portlet goes into the maximized state when the user goes into the edit mode
-
getMaximizeHelp
public boolean getMaximizeHelp()Returnstrue
if the portlet goes into the maximized state when the user goes into the help mode.- Specified by:
getMaximizeHelp
in interfacePortlet
- Returns:
true
if the portlet goes into the maximized state when the user goes into the help mode
-
getMultipartFileSizeThreshold
public int getMultipartFileSizeThreshold()Returns the maximum size of buffered bytes before storing occurs.- Specified by:
getMultipartFileSizeThreshold
in interfacePortlet
- Returns:
- the maximum size of buffered bytes before storing occurs
-
getMultipartLocation
Returns the directory for storing uploaded files.- Specified by:
getMultipartLocation
in interfacePortlet
- Returns:
- the directory for storing uploaded files
-
getMultipartMaxFileSize
public long getMultipartMaxFileSize()Returns the maximum number of bytes permitted for an uploaded file.- Specified by:
getMultipartMaxFileSize
in interfacePortlet
- Returns:
- the maximum number of bytes permitted for an uploaded file
-
getMultipartMaxRequestSize
public long getMultipartMaxRequestSize()Returns the maximum number of bytes permitted for a multipart request.- Specified by:
getMultipartMaxRequestSize
in interfacePortlet
- Returns:
- the maximum number of bytes permitted for a multipart request
-
getMvccVersion
public long getMvccVersion()Returns the mvcc version of this portlet.- Specified by:
getMvccVersion
in interfaceMVCCModel
- Specified by:
getMvccVersion
in interfacePortletModel
- Returns:
- the mvcc version of this portlet
-
getOpenSearchClass
Returns the name of the open search class of the portlet.- Specified by:
getOpenSearchClass
in interfacePortlet
- Returns:
- the name of the open search class of the portlet
-
getOpenSearchInstance
Returns the indexer instance of the portlet.- Specified by:
getOpenSearchInstance
in interfacePortlet
- Returns:
- the indexer instance of the portlet
-
getParentStrutsPath
Returns the parent struts path of the portlet.- Specified by:
getParentStrutsPath
in interfacePortlet
- Returns:
- the parent struts path of the portlet.
-
getPermissionPropagatorClass
Returns the name of the permission propagator class of the portlet.- Specified by:
getPermissionPropagatorClass
in interfacePortlet
- Returns:
- the name of the permission propagator class of the portlet
-
getPermissionPropagatorInstance
Returns the permission propagator instance of the portlet.- Specified by:
getPermissionPropagatorInstance
in interfacePortlet
- Returns:
- the permission propagator instance of the portlet
-
getPluginId
Returns the plugin ID of the portlet.- Specified by:
getPluginId
in interfacePortlet
- Returns:
- the plugin ID of the portlet
-
getPluginPackage
Returns this portlet's plugin package.- Specified by:
getPluginPackage
in interfacePortlet
- Returns:
- this portlet's plugin package
-
getPluginType
Returns the plugin type of the portlet.- Specified by:
getPluginType
in interfacePortlet
- Returns:
- the plugin type of the portlet
-
getPopMessageListenerClass
Returns the name of the POP message listener class of the portlet.- Specified by:
getPopMessageListenerClass
in interfacePortlet
- Returns:
- the name of the POP message listener class of the portlet
-
getPopMessageListenerInstance
Returns the POP message listener instance of the portlet.- Specified by:
getPopMessageListenerInstance
in interfacePortlet
- Returns:
- the POP message listener instance of the portlet
-
getPopUpPrint
public boolean getPopUpPrint()Returnstrue
if the portlet goes into the pop up state when the user goes into the print mode.- Specified by:
getPopUpPrint
in interfacePortlet
- Returns:
true
if the portlet goes into the pop up state when the user goes into the print mode
-
getPortletApp
Returns this portlet's application.- Specified by:
getPortletApp
in interfacePortlet
- Returns:
- this portlet's application
-
getPortletClass
Returns the name of the portlet class of the portlet.- Specified by:
getPortletClass
in interfacePortlet
- Returns:
- the name of the portlet class of the portlet
-
getPortletConfigurationListenerClass
- Specified by:
getPortletConfigurationListenerClass
in interfacePortlet
-
getPortletConfigurationListenerInstance
- Specified by:
getPortletConfigurationListenerInstance
in interfacePortlet
-
getPortletDataHandlerClass
Returns the name of the portlet data handler class of the portlet.- Specified by:
getPortletDataHandlerClass
in interfacePortlet
- Returns:
- the name of the portlet data handler class of the portlet
-
getPortletDataHandlerInstance
Returns the portlet data handler instance of the portlet.- Specified by:
getPortletDataHandlerInstance
in interfacePortlet
- Returns:
- the portlet data handler instance of the portlet
-
getPortletDependencies
Returns the portlet's CSS/JavaScript resource dependencies.- Specified by:
getPortletDependencies
in interfacePortlet
- Returns:
- the portlet's CSS/JavaScript resource dependencies
-
getPortletFilters
Returns the filters of the portlet.- Specified by:
getPortletFilters
in interfacePortlet
- Returns:
- filters of the portlet
-
getPortletId
Returns the portlet ID of this portlet.- Specified by:
getPortletId
in interfacePortletModel
- Returns:
- the portlet ID of this portlet
-
getPortletInfo
Returns the portlet info of the portlet.- Specified by:
getPortletInfo
in interfacePortlet
- Returns:
- portlet info of the portlet
-
getPortletLayoutListenerClass
Returns the name of the portlet layout listener class of the portlet.- Specified by:
getPortletLayoutListenerClass
in interfacePortlet
- Returns:
- the name of the portlet layout listener class of the portlet
-
getPortletLayoutListenerInstance
Returns the portlet layout listener instance of the portlet.- Specified by:
getPortletLayoutListenerInstance
in interfacePortlet
- Returns:
- the portlet layout listener instance of the portlet
-
getPortletModes
Returns the portlet modes of the portlet.- Specified by:
getPortletModes
in interfacePortlet
- Returns:
- portlet modes of the portlet
-
getPortletName
Returns the name of the portlet.- Specified by:
getPortletName
in interfacePortlet
- Returns:
- the display name of the portlet
-
getPortletURLClass
Returns the name of the portlet URL class of the portlet.- Specified by:
getPortletURLClass
in interfacePortlet
- Returns:
- the name of the portlet URL class of the portlet
-
getPreferencesCompanyWide
public boolean getPreferencesCompanyWide()Returnstrue
if preferences are shared across the entire company.- Specified by:
getPreferencesCompanyWide
in interfacePortlet
- Returns:
true
if preferences are shared across the entire company
-
getPreferencesOwnedByGroup
public boolean getPreferencesOwnedByGroup()Returnstrue
if preferences are owned by the group when the portlet is shown in a group layout. Returnsfalse
if preferences are owned by the user at all times.- Specified by:
getPreferencesOwnedByGroup
in interfacePortlet
- 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.
-
getPreferencesUniquePerLayout
public boolean getPreferencesUniquePerLayout()Returnstrue
if preferences are unique per layout.- Specified by:
getPreferencesUniquePerLayout
in interfacePortlet
- Returns:
true
if preferences are unique per layout
-
getPreferencesValidator
Returns the name of the preferences validator class of the portlet.- Specified by:
getPreferencesValidator
in interfacePortlet
- Returns:
- the name of the preferences validator class of the portlet
-
getPrimaryKey
public long getPrimaryKey()Returns the primary key of this portlet.- Specified by:
getPrimaryKey
in interfacePortletModel
- Returns:
- the primary key of this portlet
-
getPrivateRequestAttributes
public boolean getPrivateRequestAttributes()Returnstrue
if the portlet does not share request attributes with the portal or portlets from another WAR.- Specified by:
getPrivateRequestAttributes
in interfacePortlet
- Returns:
true
if the portlet does not share request attributes with the portal or portlets from another WAR
-
getPrivateSessionAttributes
public boolean getPrivateSessionAttributes()Returnstrue
if the portlet does not share session attributes with the portal.- Specified by:
getPrivateSessionAttributes
in interfacePortlet
- Returns:
true
if the portlet does not share session attributes with the portal
-
getProcessingEvent
Returns the processing event from a namespace URI and a local part.- Specified by:
getProcessingEvent
in interfacePortlet
- Parameters:
uri
- the namespace URIlocalPart
- the local part- Returns:
- the processing event from a namespace URI and a local part
-
getProcessingEvents
Returns the processing events of the portlet.- Specified by:
getProcessingEvents
in interfacePortlet
- Returns:
- the processing events of the portlet
-
getPublicRenderParameter
Returns the public render parameter from an identifier.- Specified by:
getPublicRenderParameter
in interfacePortlet
- Parameters:
identifier
- the identifier- Returns:
- the public render parameter from an identifier
-
getPublicRenderParameter
Returns the spublic render parameter from a namespace URI and a local part.- Specified by:
getPublicRenderParameter
in interfacePortlet
- Parameters:
uri
- the namespace URIlocalPart
- the local part- Returns:
- the spublic render parameter from a namespace URI and a local part
-
getPublicRenderParameters
Returns the public render parameters of the portlet.- Specified by:
getPublicRenderParameters
in interfacePortlet
- Returns:
- the public render parameters of the portlet
-
getPublishingEvents
Returns the publishing events of the portlet.- Specified by:
getPublishingEvents
in interfacePortlet
- Returns:
- the publishing events of the portlet
-
getReady
public boolean getReady()Returnstrue
if the portlet is ready to be used. -
getRenderTimeout
public int getRenderTimeout()Returns the render timeout of the portlet.- Specified by:
getRenderTimeout
in interfacePortlet
- Returns:
- the render timeout of the portlet
-
getRenderWeight
public int getRenderWeight()Returns the render weight of the portlet.- Specified by:
getRenderWeight
in interfacePortlet
- Returns:
- the render weight of the portlet
-
getResourceBundle
Returns the resource bundle of the portlet.- Specified by:
getResourceBundle
in interfacePortlet
- Returns:
- resource bundle of the portlet
-
getRestoreCurrentView
public boolean getRestoreCurrentView()Returnstrue
if the portlet restores to the current view from the maximized state.- Specified by:
getRestoreCurrentView
in interfacePortlet
- Returns:
true
if the portlet restores to the current view from the maximized state
-
getRoleMappers
Returns the role mappers of the portlet.- Specified by:
getRoleMappers
in interfacePortlet
- Returns:
- role mappers of the portlet
-
getRoles
Returns the roles of this portlet.- Specified by:
getRoles
in interfacePortletModel
- Returns:
- the roles of this portlet
-
getRolesArray
Returns an array of required roles of the portlet.- Specified by:
getRolesArray
in interfacePortlet
- Returns:
- an array of required roles of the portlet
-
getRootPortlet
Returns the root portlet of this portlet instance.- Specified by:
getRootPortlet
in interfacePortlet
- Returns:
- the root portlet of this portlet instance
-
getRootPortletId
Returns the root portlet ID of the portlet.- Specified by:
getRootPortletId
in interfacePortlet
- Returns:
- the root portlet ID of the portlet
-
getSchedulerEntries
Returns the scheduler entries of the portlet.- Specified by:
getSchedulerEntries
in interfacePortlet
- Returns:
- the scheduler entries of the portlet
-
getScopeable
public boolean getScopeable()Returnstrue
if the portlet supports scoping of data.- Specified by:
getScopeable
in interfacePortlet
- Returns:
true
if the portlet supports scoping of data
-
getShowPortletAccessDenied
public boolean getShowPortletAccessDenied()Returnstrue
if users are shown that they do not have access to the portlet.- Specified by:
getShowPortletAccessDenied
in interfacePortlet
- Returns:
true
if users are shown that they do not have access to the portlet
-
getShowPortletInactive
public boolean getShowPortletInactive()Returnstrue
if users are shown that the portlet is inactive.- Specified by:
getShowPortletInactive
in interfacePortlet
- Returns:
true
if users are shown that the portlet is inactive
-
getSinglePageApplication
public boolean getSinglePageApplication()Returnstrue
if the portlet uses Single Page Application.- Specified by:
getSinglePageApplication
in interfacePortlet
- Returns:
true
if the portlet uses Single Page Application
-
getSocialActivityInterpreterClasses
Returns the names of the classes that represent social activity interpreters associated with the portlet.- Specified by:
getSocialActivityInterpreterClasses
in interfacePortlet
- Returns:
- the names of the classes that represent social activity interpreters associated with the portlet
-
getSocialActivityInterpreterInstances
Returns the social activity interpreter instances of the portlet.- Specified by:
getSocialActivityInterpreterInstances
in interfacePortlet
- Returns:
- the social activity interpreter instances of the portlet
-
getSocialRequestInterpreterClass
Returns the name of the social request interpreter class of the portlet.- Specified by:
getSocialRequestInterpreterClass
in interfacePortlet
- Returns:
- the name of the social request interpreter class of the portlet
-
getSocialRequestInterpreterInstance
Returns the name of the social request interpreter instance of the portlet.- Specified by:
getSocialRequestInterpreterInstance
in interfacePortlet
- Returns:
- the name of the social request interpreter instance of the portlet
-
getStagedModelDataHandlerClasses
Returns the names of the classes that represent staged model data handlers associated with the portlet.- Specified by:
getStagedModelDataHandlerClasses
in interfacePortlet
- Returns:
- the names of the classes that represent staged model data handlers associated with the portlet
-
getStagedModelDataHandlerInstances
Returns the staged model data handler instances of the portlet.- Specified by:
getStagedModelDataHandlerInstances
in interfacePortlet
- Returns:
- the staged model data handler instances of the portlet
-
getStatic
public boolean getStatic()Returnstrue
if the portlet is a static portlet that is cannot be moved. -
getStaticEnd
public boolean getStaticEnd()Returnstrue
if the portlet is a static portlet at the end of a list of portlets.- Specified by:
getStaticEnd
in interfacePortlet
- Returns:
true
if the portlet is a static portlet at the end of a list of portlets
-
getStaticResourcePath
Returns the path for static resources served by this portlet.- Specified by:
getStaticResourcePath
in interfacePortlet
- Returns:
- the path for static resources served by this portlet
-
getStaticStart
public boolean getStaticStart()Returnstrue
if the portlet is a static portlet at the start of a list of portlets.- Specified by:
getStaticStart
in interfacePortlet
- Returns:
true
if the portlet is a static portlet at the start of a list of portlets
-
getStrutsPath
Returns the struts path of the portlet.- Specified by:
getStrutsPath
in interfacePortlet
- Returns:
- the struts path of the portlet
-
getSupportedLocales
Returns the supported locales of the portlet.- Specified by:
getSupportedLocales
in interfacePortlet
- Returns:
- the supported locales of the portlet
-
getSystem
public boolean getSystem()Returnstrue
if the portlet is a system portlet that a user cannot manually add to their page. -
getTemplateHandlerClass
Returns the name of the template handler class of the portlet.- Specified by:
getTemplateHandlerClass
in interfacePortlet
- Returns:
- the name of the template handler class of the portlet
-
getTemplateHandlerInstance
Returns the template handler instance of the portlet.- Specified by:
getTemplateHandlerInstance
in interfacePortlet
- Returns:
- the template handler instance of the portlet
-
getTimestamp
public long getTimestamp()Returns the timestamp of the portlet.- Specified by:
getTimestamp
in interfacePortlet
- Returns:
- the timestamp of the portlet
-
getTrashHandlerClasses
Returns the names of the classes that represent trash handlers associated with the portlet.- Specified by:
getTrashHandlerClasses
in interfacePortlet
- Returns:
- the names of the classes that represent trash handlers associated with the portlet
-
getTrashHandlerInstances
Returns the trash handler instances of the portlet.- Specified by:
getTrashHandlerInstances
in interfacePortlet
- Returns:
- the trash handler instances of the portlet
-
getUndeployedPortlet
public boolean getUndeployedPortlet()Returnstrue
if the portlet is an undeployed portlet.- Specified by:
getUndeployedPortlet
in interfacePortlet
- Returns:
true
if the portlet is a placeholder of an undeployed portlet
-
getUnlinkedRoles
Returns the unlinked roles of the portlet.- Specified by:
getUnlinkedRoles
in interfacePortlet
- Returns:
- unlinked roles of the portlet
-
getURLEncoderClass
Returns the name of the URL encoder class of the portlet.- Specified by:
getURLEncoderClass
in interfacePortlet
- Returns:
- the name of the URL encoder class of the portlet
-
getURLEncoderInstance
Returns the URL encoder instance of the portlet.- Specified by:
getURLEncoderInstance
in interfacePortlet
- Returns:
- the URL encoder instance of the portlet
-
getUseDefaultTemplate
public boolean getUseDefaultTemplate()Returnstrue
if the portlet uses the default template.- Specified by:
getUseDefaultTemplate
in interfacePortlet
- Returns:
true
if the portlet uses the default template
-
getUserId
public long getUserId()Returns the user ID of the portlet. This only applies when the portlet is added by a user in a customizable layout. -
getUserNotificationDefinitions
Returns the class loader resource path to the use notification definitions of the portlet.- Specified by:
getUserNotificationDefinitions
in interfacePortlet
- Returns:
- the class loader resource path to the use notification definitions of the portlet
-
getUserNotificationHandlerClasses
Returns the names of the classes that represent user notification handlers associated with the portlet.- Specified by:
getUserNotificationHandlerClasses
in interfacePortlet
- Returns:
- the names of the classes that represent user notification handlers associated with the portlet
-
getUserNotificationHandlerInstances
Returns the user notification handler instances of the portlet.- Specified by:
getUserNotificationHandlerInstances
in interfacePortlet
- Returns:
- the user notification handler instances of the portlet
-
getUserPrincipalStrategy
Returns the user principal strategy of the portlet.- Specified by:
getUserPrincipalStrategy
in interfacePortlet
- Returns:
- the user principal strategy of the portlet
-
getVirtualPath
Returns the virtual path of the portlet.- Specified by:
getVirtualPath
in interfacePortlet
- Returns:
- the virtual path of the portlet
-
getWebDAVStorageClass
Returns the name of the WebDAV storage class of the portlet.- Specified by:
getWebDAVStorageClass
in interfacePortlet
- Returns:
- the name of the WebDAV storage class of the portlet
-
getWebDAVStorageInstance
Returns the name of the WebDAV storage instance of the portlet.- Specified by:
getWebDAVStorageInstance
in interfacePortlet
- Returns:
- the name of the WebDAV storage instance of the portlet
-
getWebDAVStorageToken
Returns the name of the WebDAV storage token of the portlet.- Specified by:
getWebDAVStorageToken
in interfacePortlet
- Returns:
- the name of the WebDAV storage token of the portlet
-
getWindowStates
Returns the window states of the portlet.- Specified by:
getWindowStates
in interfacePortlet
- Returns:
- window states of the portlet
-
getWorkflowHandlerClasses
Returns the names of the classes that represent workflow handlers associated with the portlet.- Specified by:
getWorkflowHandlerClasses
in interfacePortlet
- Returns:
- the names of the classes that represent workflow handlers associated with the portlet
-
getWorkflowHandlerInstances
Returns the workflow handler instances of the portlet.- Specified by:
getWorkflowHandlerInstances
in interfacePortlet
- Returns:
- the workflow handler instances of the portlet
-
getXmlRpcMethodClass
Returns the name of the XML-RPC method class of the portlet.- Specified by:
getXmlRpcMethodClass
in interfacePortlet
- Returns:
- the name of the XML-RPC method class of the portlet
-
getXmlRpcMethodInstance
Returns the name of the XML-RPC method instance of the portlet.- Specified by:
getXmlRpcMethodInstance
in interfacePortlet
- Returns:
- the name of the XML-RPC method instance of the portlet
-
hasAddPortletPermission
public boolean hasAddPortletPermission(long userId) Returnstrue
if the user has the permission to add the portlet to a layout.- Specified by:
hasAddPortletPermission
in interfacePortlet
- Parameters:
userId
- the primary key of the user- Returns:
true
if the user has the permission to add the portlet to a layout
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacePortlet
- Overrides:
hashCode
in classBaseModelWrapper<Portlet>
-
hasHeaderPortalCss
public boolean hasHeaderPortalCss()- Specified by:
hasHeaderPortalCss
in interfacePortlet
-
hasHeaderPortalJavaScript
public boolean hasHeaderPortalJavaScript()- Specified by:
hasHeaderPortalJavaScript
in interfacePortlet
-
hasHeaderPortletCss
public boolean hasHeaderPortletCss()- Specified by:
hasHeaderPortletCss
in interfacePortlet
-
hasHeaderPortletJavaScript
public boolean hasHeaderPortletJavaScript()- Specified by:
hasHeaderPortletJavaScript
in interfacePortlet
-
hasMultipleMimeTypes
public boolean hasMultipleMimeTypes()Returnstrue
if the portlet supports more than one mime type.- Specified by:
hasMultipleMimeTypes
in interfacePortlet
- Returns:
true
if the portlet supports more than one mime type
-
hasPortletMode
Returnstrue
if the portlet supports the specified mime type and portlet mode.- Specified by:
hasPortletMode
in interfacePortlet
- Parameters:
mimeType
- the mime typeportletMode
- the portlet mode- Returns:
true
if the portlet supports the specified mime type and portlet mode
-
hasRoleWithName
Returnstrue
if the portlet has a role with the specified name.- Specified by:
hasRoleWithName
in interfacePortlet
- Parameters:
roleName
- the role name- Returns:
true
if the portlet has a role with the specified name
-
hasWindowState
Returnstrue
if the portlet supports the specified mime type and window state.- Specified by:
hasWindowState
in interfacePortlet
- Parameters:
mimeType
- the mime typewindowState
- the window state- Returns:
true
if the portlet supports the specified mime type and window state
-
isActionURLRedirect
public boolean isActionURLRedirect()Returnstrue
if an action URL for this portlet should cause an auto redirect.- Specified by:
isActionURLRedirect
in interfacePortlet
- Returns:
true
if an action URL for this portlet should cause an auto redirect
-
isActive
public boolean isActive()Returnstrue
if this portlet is active.- Specified by:
isActive
in interfacePortletModel
- Returns:
true
if this portlet is active;false
otherwise
-
isAddDefaultResource
public boolean isAddDefaultResource()Returnstrue
if default resources for the portlet are added to a page.- Specified by:
isAddDefaultResource
in interfacePortlet
- Returns:
true
if default resources for the portlet are added to a page
-
isAjaxable
public boolean isAjaxable()Returnstrue
if the portlet can be displayed via Ajax.- Specified by:
isAjaxable
in interfacePortlet
- Returns:
true
if the portlet can be displayed via Ajax
-
isAsyncSupported
public boolean isAsyncSupported()Returnstrue
if the portlet supports asynchronous processing in resource requests.- Specified by:
isAsyncSupported
in interfacePortlet
- Returns:
true
if the portlet supports asynchrounous processing in resource requests
-
isFullPageDisplayable
public boolean isFullPageDisplayable()- Specified by:
isFullPageDisplayable
in interfacePortlet
-
isInclude
public boolean isInclude()Returnstrue
to include the portlet and make it available to be made active. -
isInstanceable
public boolean isInstanceable()Returnstrue
if the portlet can be added multiple times to a layout.- Specified by:
isInstanceable
in interfacePortlet
- Returns:
true
if the portlet can be added multiple times to a layout
-
isLayoutCacheable
public boolean isLayoutCacheable()Returnstrue
to allow the portlet to be cached within the layout.- Specified by:
isLayoutCacheable
in interfacePortlet
- Returns:
true
if the portlet can be cached within the layout
-
isMaximizeEdit
public boolean isMaximizeEdit()Returnstrue
if the portlet goes into the maximized state when the user goes into the edit mode.- Specified by:
isMaximizeEdit
in interfacePortlet
- Returns:
true
if the portlet goes into the maximized state when the user goes into the edit mode
-
isMaximizeHelp
public boolean isMaximizeHelp()Returnstrue
if the portlet goes into the maximized state when the user goes into the help mode.- Specified by:
isMaximizeHelp
in interfacePortlet
- Returns:
true
if the portlet goes into the maximized state when the user goes into the help mode
-
isPartialActionServeResource
public boolean isPartialActionServeResource()Returnstrue
if the portlet'sserveResource(ResourceRequest,ResourceResponse)
method should be invoked during a partial action triggered by a different portlet on the same portal page.- Specified by:
isPartialActionServeResource
in interfacePortlet
- Returns:
true
if the portlet'sserveResource(ResourceRequest,ResourceResponse)
method should be invoked during a partial action triggered by a different portlet on the same portal page
-
isPopUpPrint
public boolean isPopUpPrint()Returnstrue
if the portlet goes into the pop up state when the user goes into the print mode.- Specified by:
isPopUpPrint
in interfacePortlet
- Returns:
true
if the portlet goes into the pop up state when the user goes into the print mode
-
isPortletDependencyCssEnabled
public boolean isPortletDependencyCssEnabled()Returnstrue
if the CSS resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.- Specified by:
isPortletDependencyCssEnabled
in interfacePortlet
- Returns:
true
if the specified CSS resource dependencies are to be referenced in the page's header
-
isPortletDependencyJavaScriptEnabled
public boolean isPortletDependencyJavaScriptEnabled()Returnstrue
if the JavaScript resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.- Specified by:
isPortletDependencyJavaScriptEnabled
in interfacePortlet
- Returns:
true
if the specified JavaScript resource dependencies are to be referenced in the page's header
-
isPreferencesCompanyWide
public boolean isPreferencesCompanyWide()Returnstrue
if preferences are shared across the entire company.- Specified by:
isPreferencesCompanyWide
in interfacePortlet
- Returns:
true
if preferences are shared across the entire company
-
isPreferencesOwnedByGroup
public boolean isPreferencesOwnedByGroup()Returnstrue
if preferences are owned by the group when the portlet is shown in a group layout. Returnsfalse
if preferences are owned by the user at all times.- Specified by:
isPreferencesOwnedByGroup
in interfacePortlet
- 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.
-
isPreferencesUniquePerLayout
public boolean isPreferencesUniquePerLayout()Returnstrue
if preferences are unique per layout.- Specified by:
isPreferencesUniquePerLayout
in interfacePortlet
- Returns:
true
if preferences are unique per layout
-
isPrivateRequestAttributes
public boolean isPrivateRequestAttributes()Returnstrue
if the portlet does not share request attributes with the portal or portlets from another WAR.- Specified by:
isPrivateRequestAttributes
in interfacePortlet
- Returns:
true
if the portlet does not share request attributes with the portal or portlets from another WAR
-
isPrivateSessionAttributes
public boolean isPrivateSessionAttributes()Returnstrue
if the portlet does not share session attributes with the portal.- Specified by:
isPrivateSessionAttributes
in interfacePortlet
- Returns:
true
if the portlet does not share session attributes with the portal
-
isReady
public boolean isReady()Returnstrue
if the portlet is ready to be used. -
isRequiresNamespacedParameters
public boolean isRequiresNamespacedParameters()Returnstrue
if the portlet will only process namespaced parameters.- Specified by:
isRequiresNamespacedParameters
in interfacePortlet
- Returns:
true
if the portlet will only process namespaced parameters
-
isRestoreCurrentView
public boolean isRestoreCurrentView()Returnstrue
if the portlet restores to the current view from the maximized state.- Specified by:
isRestoreCurrentView
in interfacePortlet
- Returns:
true
if the portlet restores to the current view from the maximized state
-
isScopeable
public boolean isScopeable()Returnstrue
if the portlet supports scoping of data.- Specified by:
isScopeable
in interfacePortlet
- Returns:
true
if the portlet supports scoping of data
-
isShowPortletAccessDenied
public boolean isShowPortletAccessDenied()Returnstrue
if users are shown that they do not have access to the portlet.- Specified by:
isShowPortletAccessDenied
in interfacePortlet
- Returns:
true
if users are shown that they do not have access to the portlet
-
isShowPortletInactive
public boolean isShowPortletInactive()Returnstrue
if users are shown that the portlet is inactive.- Specified by:
isShowPortletInactive
in interfacePortlet
- Returns:
true
if users are shown that the portlet is inactive
-
isSinglePageApplication
public boolean isSinglePageApplication()Returnstrue
if the portlet uses Single Page Application.- Specified by:
isSinglePageApplication
in interfacePortlet
- Returns:
true
if the portlet uses Single Page Application
-
isStatic
public boolean isStatic()Returnstrue
if the portlet is a static portlet that is cannot be moved. -
isStaticEnd
public boolean isStaticEnd()Returnstrue
if the portlet is a static portlet at the end of a list of portlets.- Specified by:
isStaticEnd
in interfacePortlet
- Returns:
true
if the portlet is a static portlet at the end of a list of portlets
-
isStaticStart
public boolean isStaticStart()Returnstrue
if the portlet is a static portlet at the start of a list of portlets.- Specified by:
isStaticStart
in interfacePortlet
- Returns:
true
if the portlet is a static portlet at the start of a list of portlets
-
isSystem
public boolean isSystem()Returnstrue
if the portlet is a system portlet that a user cannot manually add to their page. -
isUndeployedPortlet
public boolean isUndeployedPortlet()Returnstrue
if the portlet is an undeployed portlet.- Specified by:
isUndeployedPortlet
in interfacePortlet
- Returns:
true
if the portlet is a placeholder of an undeployed portlet
-
isUseDefaultTemplate
public boolean isUseDefaultTemplate()Returnstrue
if the portlet uses the default template.- Specified by:
isUseDefaultTemplate
in interfacePortlet
- Returns:
true
if the portlet uses the default template
-
linkRoles
public void linkRoles()Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml. -
persist
public void persist()Description copied from interface:PersistedModel
Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.- Specified by:
persist
in interfacePersistedModel
-
setActionTimeout
public void setActionTimeout(int actionTimeout) Sets the action timeout of the portlet.- Specified by:
setActionTimeout
in interfacePortlet
- Parameters:
actionTimeout
- the action timeout of the portlet
-
setActionURLRedirect
public void setActionURLRedirect(boolean actionURLRedirect) Set totrue
if an action URL for this portlet should cause an auto redirect.- Specified by:
setActionURLRedirect
in interfacePortlet
- Parameters:
actionURLRedirect
- boolean value for whether an action URL for this portlet should cause an auto redirect
-
setActive
public void setActive(boolean active) Sets whether this portlet is active.- Specified by:
setActive
in interfacePortletModel
- Parameters:
active
- the active of this portlet
-
setAddDefaultResource
public void setAddDefaultResource(boolean addDefaultResource) Set totrue
if default resources for the portlet are added to a page.- Specified by:
setAddDefaultResource
in interfacePortlet
- Parameters:
addDefaultResource
- boolean value for whether or not default resources for the portlet are added to a page
-
setAjaxable
public void setAjaxable(boolean ajaxable) Set totrue
if the portlet can be displayed via Ajax.- Specified by:
setAjaxable
in interfacePortlet
- Parameters:
ajaxable
- boolean value for whether the portlet can be displayed via Ajax
-
setApplicationTypes
Sets the application types of the portlet.- Specified by:
setApplicationTypes
in interfacePortlet
- Parameters:
applicationTypes
- the application types of the portlet
-
setAssetRendererFactoryClasses
Sets the names of the classes that represent asset types associated with the portlet.- Specified by:
setAssetRendererFactoryClasses
in interfacePortlet
- Parameters:
assetRendererFactoryClasses
- the names of the classes that represent asset types associated with the portlet
-
setAsyncSupported
public void setAsyncSupported(boolean asyncSupported) Set totrue
if the portlet supports asynchronous processing in resource requests.- Specified by:
setAsyncSupported
in interfacePortlet
- Parameters:
asyncSupported
- boolean value for whether the portlet supports asynchronous processing in resource requests
-
setAutopropagatedParameters
Sets the names of the parameters that will be automatically propagated through the portlet.- Specified by:
setAutopropagatedParameters
in interfacePortlet
- Parameters:
autopropagatedParameters
- the names of the parameters that will be automatically propagated through the portlet
-
setCategoryNames
Sets the category names of the portlet.- Specified by:
setCategoryNames
in interfacePortlet
- Parameters:
categoryNames
- the category names of the portlet
-
setCompanyId
public void setCompanyId(long companyId) Sets the company ID of this portlet.- Specified by:
setCompanyId
in interfacePortletModel
- Specified by:
setCompanyId
in interfaceShardedModel
- Parameters:
companyId
- the company ID of this portlet
-
setConfigurationActionClass
Sets the configuration action class of the portlet.- Specified by:
setConfigurationActionClass
in interfacePortlet
- Parameters:
configurationActionClass
- the configuration action class of the portlet
-
setControlPanelEntryCategory
Set the name of the category of the Control Panel where the portlet will be shown.- Specified by:
setControlPanelEntryCategory
in interfacePortlet
- Parameters:
controlPanelEntryCategory
- the name of the category of the Control Panel where the portlet will be shown
-
setControlPanelEntryClass
Sets the name of the class that will control when the portlet will be shown in the Control Panel.- Specified by:
setControlPanelEntryClass
in interfacePortlet
- Parameters:
controlPanelEntryClass
- the name of the class that will control when the portlet will be shown in the Control Panel
-
setControlPanelEntryWeight
public void setControlPanelEntryWeight(double controlPanelEntryWeight) Sets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.- Specified by:
setControlPanelEntryWeight
in interfacePortlet
- Parameters:
controlPanelEntryWeight
- the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel
-
setCssClassWrapper
Sets the name of the CSS class that will be injected in the DIV that wraps this portlet.- Specified by:
setCssClassWrapper
in interfacePortlet
- Parameters:
cssClassWrapper
- the name of the CSS class that will be injected in the DIV that wraps this portlet
-
setCustomAttributesDisplayClasses
Sets the names of the classes that represent custom attribute displays associated with the portlet.- Specified by:
setCustomAttributesDisplayClasses
in interfacePortlet
- Parameters:
customAttributesDisplayClasses
- the names of the classes that represent custom attribute displays associated with the portlet
-
setDefaultPluginSetting
Sets the default plugin settings of the portlet.- Specified by:
setDefaultPluginSetting
in interfacePortlet
- Parameters:
pluginSetting
- the plugin setting
-
setDefaultPreferences
Sets the default preferences of the portlet.- Specified by:
setDefaultPreferences
in interfacePortlet
- Parameters:
defaultPreferences
- the default preferences of the portlet
-
setDisplayName
Sets the display name of the portlet.- Specified by:
setDisplayName
in interfacePortlet
- Parameters:
displayName
- the display name of the portlet
-
setExpCache
Sets expiration cache of the portlet.- Specified by:
setExpCache
in interfacePortlet
- Parameters:
expCache
- expiration cache of the portlet
-
setFriendlyURLMapperClass
Sets the name of the friendly URL mapper class of the portlet.- Specified by:
setFriendlyURLMapperClass
in interfacePortlet
- Parameters:
friendlyURLMapperClass
- the name of the friendly URL mapper class of the portlet
-
setFriendlyURLMapping
Sets the name of the friendly URL mapping of the portlet.- Specified by:
setFriendlyURLMapping
in interfacePortlet
- Parameters:
friendlyURLMapping
- the name of the friendly URL mapping of the portlet
-
setFriendlyURLRoutes
Sets the class loader resource path to the friendly URL routes of the portlet.- Specified by:
setFriendlyURLRoutes
in interfacePortlet
- Parameters:
friendlyURLRoutes
- the class loader resource path to the friendly URL routes of the portlet
-
setHeaderPortalCss
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 interfacePortlet
- Parameters:
headerPortalCss
- a list of CSS files that will be referenced from the page's header relative to the portal's context path
-
setHeaderPortalJavaScript
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 interfacePortlet
- Parameters:
headerPortalJavaScript
- a list of JavaScript files that will be referenced from the page's header relative to the portal's context path
-
setHeaderPortletCss
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 interfacePortlet
- Parameters:
headerPortletCss
- a list of CSS files that will be referenced from the page's header relative to the portlet's context path
-
setHeaderPortletJavaScript
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 interfacePortlet
- Parameters:
headerPortletJavaScript
- a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path
-
setHeaderRequestAttributePrefixes
Sets a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet. Header request attributes that have names starting with any of the prefixes will be copied from the header request to the subsequent render request.- Specified by:
setHeaderRequestAttributePrefixes
in interfacePortlet
- Parameters:
headerRequestAttributePrefixes
- a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet. Header request attributes that have names starting with any of the prefixes will be copied from the header request to the subsequent render request.
-
setHeaderTimeout
public void setHeaderTimeout(int headerTimeout) Sets the header timeout of the portlet.- Specified by:
setHeaderTimeout
in interfacePortlet
- Parameters:
headerTimeout
- the header timeout of the portlet
-
setIcon
Sets the icon of the portlet. -
setId
public void setId(long id) Sets the ID of this portlet.- Specified by:
setId
in interfacePortletModel
- Parameters:
id
- the ID of this portlet
-
setInclude
public void setInclude(boolean include) Set totrue
to include the portlet and make it available to be made active.- Specified by:
setInclude
in interfacePortlet
- Parameters:
include
- boolean value for whether to include the portlet and make it available to be made active
-
setIndexerClasses
Sets the names of the classes that represent indexers associated with the portlet.- Specified by:
setIndexerClasses
in interfacePortlet
- Parameters:
indexerClasses
- the names of the classes that represent indexers associated with the portlet
-
setInitParams
Sets the init parameters of the portlet.- Specified by:
setInitParams
in interfacePortlet
- Parameters:
initParams
- the init parameters of the portlet
-
setInstanceable
public void setInstanceable(boolean instanceable) Set totrue
if the portlet can be added multiple times to a layout.- Specified by:
setInstanceable
in interfacePortlet
- Parameters:
instanceable
- boolean value for whether the portlet can be added multiple times to a layout
-
setLayoutCacheable
public void setLayoutCacheable(boolean layoutCacheable) Set totrue
to allow the portlet to be cached within the layout.- Specified by:
setLayoutCacheable
in interfacePortlet
- Parameters:
layoutCacheable
- boolean value for whether the portlet can be cached within the layout
-
setMaximizeEdit
public void setMaximizeEdit(boolean maximizeEdit) Set totrue
if the portlet goes into the maximized state when the user goes into the edit mode.- Specified by:
setMaximizeEdit
in interfacePortlet
- Parameters:
maximizeEdit
- boolean value for whether the portlet goes into the maximized state when the user goes into the edit mode
-
setMaximizeHelp
public void setMaximizeHelp(boolean maximizeHelp) Set totrue
if the portlet goes into the maximized state when the user goes into the help mode.- Specified by:
setMaximizeHelp
in interfacePortlet
- Parameters:
maximizeHelp
- boolean value for whether the portlet goes into the maximized state when the user goes into the help mode
-
setMultipartFileSizeThreshold
public void setMultipartFileSizeThreshold(int multipartFileSizeThreshold) Sets the maximum size of buffered bytes before storing occurs.- Specified by:
setMultipartFileSizeThreshold
in interfacePortlet
- Parameters:
multipartFileSizeThreshold
- the maximum size of buffered bytes before storing occurs
-
setMultipartLocation
Sets the directory for storing uploaded files.- Specified by:
setMultipartLocation
in interfacePortlet
- Parameters:
multipartLocation
- the directory for storing uploaded files
-
setMultipartMaxFileSize
public void setMultipartMaxFileSize(long multipartMaxFileSize) Sets the maximum number of bytes permitted for an uploaded file.- Specified by:
setMultipartMaxFileSize
in interfacePortlet
- Parameters:
multipartMaxFileSize
- the maximum number of bytes permitted for an uploaded file
-
setMultipartMaxRequestSize
public void setMultipartMaxRequestSize(long multipartMaxRequestSize) Sets the maximum number of bytes permitted for a multipart request.- Specified by:
setMultipartMaxRequestSize
in interfacePortlet
- Parameters:
multipartMaxRequestSize
- the maximum number of bytes permitted for a multipart request
-
setMvccVersion
public void setMvccVersion(long mvccVersion) Sets the mvcc version of this portlet.- Specified by:
setMvccVersion
in interfaceMVCCModel
- Specified by:
setMvccVersion
in interfacePortletModel
- Parameters:
mvccVersion
- the mvcc version of this portlet
-
setOpenSearchClass
Sets the name of the open search class of the portlet.- Specified by:
setOpenSearchClass
in interfacePortlet
- Parameters:
openSearchClass
- the name of the open search class of the portlet
-
setParentStrutsPath
Sets the parent struts path of the portlet.- Specified by:
setParentStrutsPath
in interfacePortlet
- Parameters:
parentStrutsPath
- the parent struts path of the portlet
-
setPartialActionServeResource
public void setPartialActionServeResource(boolean partialActionServeResource) Sets whether the portlet's serve resource should be invoked during a partial action triggered by a different portlet on the same portal page.- Specified by:
setPartialActionServeResource
in interfacePortlet
- Parameters:
partialActionServeResource
- whether the portlet'sserveResource(ResourceRequest,ResourceResponse)
method should be invoked during a partial action triggered by a different portlet on the same portal page
-
setPermissionPropagatorClass
Sets the name of the permission propagator class of the portlet.- Specified by:
setPermissionPropagatorClass
in interfacePortlet
-
setPluginPackage
Sets this portlet's plugin package.- Specified by:
setPluginPackage
in interfacePortlet
- Parameters:
pluginPackage
- this portlet's plugin package
-
setPopMessageListenerClass
Sets the name of the POP message listener class of the portlet.- Specified by:
setPopMessageListenerClass
in interfacePortlet
- Parameters:
popMessageListenerClass
- the name of the POP message listener class of the portlet
-
setPopUpPrint
public void setPopUpPrint(boolean popUpPrint) Sets whether the portlet goes into the pop up state when the user goes into the print mode.- Specified by:
setPopUpPrint
in interfacePortlet
- Parameters:
popUpPrint
- whether the portlet goes into the pop up state when the user goes into the print mode
-
setPortletApp
Sets this portlet's application.- Specified by:
setPortletApp
in interfacePortlet
- Parameters:
portletApp
- this portlet's application
-
setPortletClass
Sets the name of the portlet class of the portlet.- Specified by:
setPortletClass
in interfacePortlet
- Parameters:
portletClass
- the name of the portlet class of the portlet
-
setPortletConfigurationListenerClass
- Specified by:
setPortletConfigurationListenerClass
in interfacePortlet
-
setPortletDataHandlerClass
Sets the name of the portlet data handler class of the portlet.- Specified by:
setPortletDataHandlerClass
in interfacePortlet
- Parameters:
portletDataHandlerClass
- the name of portlet data handler class of the portlet
-
setPortletDependencyCssEnabled
public void setPortletDependencyCssEnabled(boolean portletDependencyCssEnabled) Sets whether the CSS resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.- Specified by:
setPortletDependencyCssEnabled
in interfacePortlet
- Parameters:
portletDependencyCssEnabled
- whether the CSS resource dependencies that are specified inportlet.xml
,
-
setPortletDependencyJavaScriptEnabled
public void setPortletDependencyJavaScriptEnabled(boolean portletDependencyJavaScriptEnabled) Sets whether the JavaScript resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header.- Specified by:
setPortletDependencyJavaScriptEnabled
in interfacePortlet
- Parameters:
portletDependencyJavaScriptEnabled
- whether the JavaScript resource dependencies specified inportlet.xml
, @Dependency
,HeaderResponse.addDependency(String, String, String)
, orHeaderResponse.addDependency(String, String, String, String)
are to be referenced in the page's header
-
setPortletFilters
Sets the filters of the portlet.- Specified by:
setPortletFilters
in interfacePortlet
- Parameters:
portletFilters
- the filters of the portlet
-
setPortletId
Sets the portlet ID of this portlet.- Specified by:
setPortletId
in interfacePortletModel
- Parameters:
portletId
- the portlet ID of this portlet
-
setPortletInfo
Sets the portlet info of the portlet.- Specified by:
setPortletInfo
in interfacePortlet
- Parameters:
portletInfo
- the portlet info of the portlet
-
setPortletLayoutListenerClass
Sets the name of the portlet layout listener class of the portlet.- Specified by:
setPortletLayoutListenerClass
in interfacePortlet
- Parameters:
portletLayoutListenerClass
- the name of the portlet layout listener class of the portlet
-
setPortletModes
Sets the portlet modes of the portlet.- Specified by:
setPortletModes
in interfacePortlet
- Parameters:
portletModes
- the portlet modes of the portlet
-
setPortletName
Sets the name of the portlet.- Specified by:
setPortletName
in interfacePortlet
- Parameters:
portletName
- the name of the portlet
-
setPortletURLClass
Sets the name of the portlet URL class of the portlet.- Specified by:
setPortletURLClass
in interfacePortlet
- Parameters:
portletURLClass
- the name of the portlet URL class of the portlet
-
setPreferencesCompanyWide
public void setPreferencesCompanyWide(boolean preferencesCompanyWide) Set totrue
if preferences are shared across the entire company.- Specified by:
setPreferencesCompanyWide
in interfacePortlet
- Parameters:
preferencesCompanyWide
- boolean value for whether preferences are shared across the entire company
-
setPreferencesOwnedByGroup
public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup) Set totrue
if preferences are owned by the group when the portlet is shown in a group layout. Set tofalse
if preferences are owned by the user at all times.- Specified by:
setPreferencesOwnedByGroup
in interfacePortlet
- Parameters:
preferencesOwnedByGroup
- boolean value for whether preferences are owned by the group when the portlet is shown in a group layout or preferences are owned by the user at all times
-
setPreferencesUniquePerLayout
public void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout) Set totrue
if preferences are unique per layout.- Specified by:
setPreferencesUniquePerLayout
in interfacePortlet
- Parameters:
preferencesUniquePerLayout
- boolean value for whether preferences are unique per layout
-
setPreferencesValidator
Sets the name of the preferences validator class of the portlet.- Specified by:
setPreferencesValidator
in interfacePortlet
- Parameters:
preferencesValidator
- the name of the preferences validator class of the portlet
-
setPrimaryKey
public void setPrimaryKey(long primaryKey) Sets the primary key of this portlet.- Specified by:
setPrimaryKey
in interfacePortletModel
- Parameters:
primaryKey
- the primary key of this portlet
-
setPrivateRequestAttributes
public void setPrivateRequestAttributes(boolean privateRequestAttributes) Set totrue
if the portlet does not share request attributes with the portal or portlets from another WAR.- Specified by:
setPrivateRequestAttributes
in interfacePortlet
- Parameters:
privateRequestAttributes
- boolean value for whether the portlet shares request attributes with the portal or portlets from another WAR
-
setPrivateSessionAttributes
public void setPrivateSessionAttributes(boolean privateSessionAttributes) Set totrue
if the portlet does not share session attributes with the portal.- Specified by:
setPrivateSessionAttributes
in interfacePortlet
- Parameters:
privateSessionAttributes
- boolean value for whether the portlet shares session attributes with the portal
-
setProcessingEvents
Sets the processing events of the portlet.- Specified by:
setProcessingEvents
in interfacePortlet
- Parameters:
processingEvents
- the processing events of the portlet
-
setPublicRenderParameters
Sets the public render parameters of the portlet.- Specified by:
setPublicRenderParameters
in interfacePortlet
- Parameters:
publicRenderParameters
- the public render parameters of the portlet
-
setPublishingEvents
Sets the publishing events of the portlet.- Specified by:
setPublishingEvents
in interfacePortlet
- Parameters:
publishingEvents
- the publishing events of the portlet
-
setReady
public void setReady(boolean ready) Set totrue
if the portlet is ready to be used. -
setRenderTimeout
public void setRenderTimeout(int renderTimeout) Sets the render timeout of the portlet.- Specified by:
setRenderTimeout
in interfacePortlet
- Parameters:
renderTimeout
- the render timeout of the portlet
-
setRenderWeight
public void setRenderWeight(int renderWeight) Sets the render weight of the portlet.- Specified by:
setRenderWeight
in interfacePortlet
- Parameters:
renderWeight
- int value for the render weight of the portlet
-
setRequiresNamespacedParameters
public void setRequiresNamespacedParameters(boolean requiresNamespacedParameters) Set totrue
if the portlet will only process namespaced parameters.- Specified by:
setRequiresNamespacedParameters
in interfacePortlet
- Parameters:
requiresNamespacedParameters
- boolean value for whether the portlet will only process namespaced parameters
-
setResourceBundle
Sets the resource bundle of the portlet.- Specified by:
setResourceBundle
in interfacePortlet
- Parameters:
resourceBundle
- the resource bundle of the portlet
-
setRestoreCurrentView
public void setRestoreCurrentView(boolean restoreCurrentView) Set totrue
if the portlet restores to the current view from the maximized state.- Specified by:
setRestoreCurrentView
in interfacePortlet
- Parameters:
restoreCurrentView
- boolean value for whether the portlet restores to the current view from the maximized state
-
setRoleMappers
Sets the role mappers of the portlet.- Specified by:
setRoleMappers
in interfacePortlet
- Parameters:
roleMappers
- the role mappers of the portlet
-
setRoles
Sets the roles of this portlet.- Specified by:
setRoles
in interfacePortletModel
- Parameters:
roles
- the roles of this portlet
-
setRolesArray
Sets an array of required roles of the portlet.- Specified by:
setRolesArray
in interfacePortlet
- Parameters:
rolesArray
- an array of required roles of the portlet
-
setSchedulerEntries
Sets the scheduler entries of the portlet.- Specified by:
setSchedulerEntries
in interfacePortlet
- Parameters:
schedulerEntries
- the scheduler entries of the portlet
-
setScopeable
public void setScopeable(boolean scopeable) Set totrue
if the portlet supports scoping of data.- Specified by:
setScopeable
in interfacePortlet
- Parameters:
scopeable
- boolean value for whether or not the the portlet supports scoping of data
-
setShowPortletAccessDenied
public void setShowPortletAccessDenied(boolean showPortletAccessDenied) Set totrue
if users are shown that they do not have access to the portlet.- Specified by:
setShowPortletAccessDenied
in interfacePortlet
- Parameters:
showPortletAccessDenied
- boolean value for whether users are shown that they do not have access to the portlet
-
setShowPortletInactive
public void setShowPortletInactive(boolean showPortletInactive) Set totrue
if users are shown that the portlet is inactive.- Specified by:
setShowPortletInactive
in interfacePortlet
- Parameters:
showPortletInactive
- boolean value for whether users are shown that the portlet is inactive
-
setSinglePageApplication
public void setSinglePageApplication(boolean singlePageApplication) Set totrue
if the portlet uses Single Page Application.- Specified by:
setSinglePageApplication
in interfacePortlet
- Parameters:
singlePageApplication
- boolean value for whether or not the the portlet uses Single Page Application
-
setSocialActivityInterpreterClasses
Sets the names of the classes that represent social activity interpreters associated with the portlet.- Specified by:
setSocialActivityInterpreterClasses
in interfacePortlet
- Parameters:
socialActivityInterpreterClasses
- the names of the classes that represent social activity interpreters associated with the portlet
-
setSocialRequestInterpreterClass
Sets the name of the social request interpreter class of the portlet.- Specified by:
setSocialRequestInterpreterClass
in interfacePortlet
- Parameters:
socialRequestInterpreterClass
- the name of the request interpreter class of the portlet
-
setStagedModelDataHandlerClasses
Sets the names of the classes that represent staged model data handlers associated with the portlet.- Specified by:
setStagedModelDataHandlerClasses
in interfacePortlet
- Parameters:
stagedModelDataHandlerClasses
- the names of the classes that represent staged model data handlers associated with the portlet
-
setStatic
public void setStatic(boolean staticPortlet) Set totrue
if the portlet is a static portlet that is cannot be moved. -
setStaticStart
public void setStaticStart(boolean staticPortletStart) Set totrue
if the portlet is a static portlet at the start of a list of portlets.- Specified by:
setStaticStart
in interfacePortlet
- Parameters:
staticPortletStart
- boolean value for whether the portlet is a static portlet at the start of a list of portlets
-
setStrutsPath
Sets the struts path of the portlet.- Specified by:
setStrutsPath
in interfacePortlet
- Parameters:
strutsPath
- the struts path of the portlet
-
setSupportedLocales
Sets the supported locales of the portlet.- Specified by:
setSupportedLocales
in interfacePortlet
- Parameters:
supportedLocales
- the supported locales of the portlet
-
setSystem
public void setSystem(boolean system) Set totrue
if the portlet is a system portlet that a user cannot manually add to their page. -
setTemplateHandlerClass
Sets the name of the template handler class of the portlet.- Specified by:
setTemplateHandlerClass
in interfacePortlet
- Parameters:
templateHandlerClass
- the name of template handler class of the portlet
-
setTrashHandlerClasses
Sets the names of the classes that represent trash handlers associated to the portlet.- Specified by:
setTrashHandlerClasses
in interfacePortlet
- Parameters:
trashHandlerClasses
- the names of the classes that represent trash handlers associated with the portlet
-
setUndeployedPortlet
public void setUndeployedPortlet(boolean undeployedPortlet) Set totrue
if the portlet is an undeployed portlet.- Specified by:
setUndeployedPortlet
in interfacePortlet
- Parameters:
undeployedPortlet
- boolean value for whether the portlet is an undeployed portlet
-
setUnlinkedRoles
Sets the unlinked roles of the portlet.- Specified by:
setUnlinkedRoles
in interfacePortlet
- Parameters:
unlinkedRoles
- the unlinked roles of the portlet
-
setURLEncoderClass
Sets the name of the URL encoder class of the portlet.- Specified by:
setURLEncoderClass
in interfacePortlet
- Parameters:
urlEncoderClass
- the name of the URL encoder class of the portlet
-
setUseDefaultTemplate
public void setUseDefaultTemplate(boolean useDefaultTemplate) Set totrue
if the portlet uses the default template.- Specified by:
setUseDefaultTemplate
in interfacePortlet
- Parameters:
useDefaultTemplate
- boolean value for whether the portlet uses the default template
-
setUserNotificationDefinitions
Sets the class loader resource path to the user notification definitions of the portlet.- Specified by:
setUserNotificationDefinitions
in interfacePortlet
- Parameters:
userNotificationDefinitions
- the class loader resource path to the user notification definitions of the portlet
-
setUserNotificationHandlerClasses
Sets the names of the classes that represent user notification handlers associated with the portlet.- Specified by:
setUserNotificationHandlerClasses
in interfacePortlet
- Parameters:
userNotificationHandlerClasses
- the names of the classes that represent user notification handlers associated with the portlet
-
setUserPrincipalStrategy
Sets the user principal strategy of the portlet.- Specified by:
setUserPrincipalStrategy
in interfacePortlet
- Parameters:
userPrincipalStrategy
- the user principal strategy of the portlet
-
setVirtualPath
Sets the virtual path of the portlet.- Specified by:
setVirtualPath
in interfacePortlet
- Parameters:
virtualPath
- the virtual path of the portlet
-
setWebDAVStorageClass
Sets the name of the WebDAV storage class of the portlet.- Specified by:
setWebDAVStorageClass
in interfacePortlet
- Parameters:
webDAVStorageClass
- the name of the WebDAV storage class of the portlet
-
setWebDAVStorageToken
Sets the name of the WebDAV storage token of the portlet.- Specified by:
setWebDAVStorageToken
in interfacePortlet
- Parameters:
webDAVStorageToken
- the name of the WebDAV storage token of the portlet
-
setWindowStates
Sets the window states of the portlet.- Specified by:
setWindowStates
in interfacePortlet
- Parameters:
windowStates
- the window states of the portlet
-
setWorkflowHandlerClasses
Sets the names of the classes that represent workflow handlers associated to the portlet.- Specified by:
setWorkflowHandlerClasses
in interfacePortlet
- Parameters:
workflowHandlerClasses
- the names of the classes that represent workflow handlers associated with the portlet
-
setXmlRpcMethodClass
Sets the name of the XML-RPC method class of the portlet.- Specified by:
setXmlRpcMethodClass
in interfacePortlet
- Parameters:
xmlRpcMethodClass
- the name of the XML-RPC method class of the portlet
-
toXmlString
- Specified by:
toXmlString
in interfacePortletModel
-
unsetReady
public void unsetReady()- Specified by:
unsetReady
in interfacePortlet
-
wrap
- Specified by:
wrap
in classBaseModelWrapper<Portlet>
-