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
modelFields inherited from interface com.liferay.portal.kernel.model.Portlet
ID_ACCESSOR, PORTLET_ID_ACCESSOR -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddApplicationType(ApplicationType applicationType) Adds an application type.voidaddPortletDependency(PortletDependency portletDependency) Adds a portlet CSS/JavaScript resource dependency.voidaddProcessingEvent(QName processingEvent) Adds a processing event.voidaddPublicRenderParameter(PublicRenderParameter publicRenderParameter) Adds a public render parameter.voidaddPublishingEvent(QName publishingEvent) Adds a publishing event.voidaddSchedulerEntry(SchedulerEntry schedulerEntry) Adds a scheduler entry.clone()Creates and returns a copy of this object.intCompares this portlet to the specified object.booleanChecks whether this portlet is equal to the specified object.intReturns the action timeout of the portlet.booleanReturnstrueif an action URL for this portlet should cause an auto redirect.booleanReturns the active of this portlet.booleanReturnstrueif default resources for the portlet are added to a page.booleanReturnstrueif 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) Returnstrueif the portlet is found in a WAR file.longReturns 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.doubleReturns 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.intReturns the header timeout of the portlet.getIcon()Returns the icon of the portlet.longgetId()Returns the ID of this portlet.booleanReturnstrueto 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.booleanReturnstrueif the portlet can be added multiple times to a layout.Returns the instance ID of the portlet.booleanReturnstrueto allow the portlet to be cached within the layout.booleanReturnstrueif the portlet goes into the maximized state when the user goes into the edit mode.booleanReturnstrueif the portlet goes into the maximized state when the user goes into the help mode.intReturns the maximum size of buffered bytes before storing occurs.Returns the directory for storing uploaded files.longReturns the maximum number of bytes permitted for an uploaded file.longReturns the maximum number of bytes permitted for a multipart request.longReturns 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.booleanReturnstrueif 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.booleanReturnstrueif preferences are shared across the entire company.booleanReturnstrueif preferences are owned by the group when the portlet is shown in a group layout.booleanReturnstrueif preferences are unique per layout.Returns the name of the preferences validator class of the portlet.longReturns the primary key of this portlet.booleanReturnstrueif the portlet does not share request attributes with the portal or portlets from another WAR.booleanReturnstrueif 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.booleangetReady()Returnstrueif the portlet is ready to be used.intReturns the render timeout of the portlet.intReturns the render weight of the portlet.Returns the resource bundle of the portlet.booleanReturnstrueif 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.booleanReturnstrueif the portlet supports scoping of data.booleanReturnstrueif users are shown that they do not have access to the portlet.booleanReturnstrueif users are shown that the portlet is inactive.booleanReturnstrueif 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.booleanReturnstrueif the portlet is a static portlet that is cannot be moved.booleanReturnstrueif the portlet is a static portlet at the end of a list of portlets.Returns the path for static resources served by this portlet.booleanReturnstrueif 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.booleanReturnstrueif 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.longReturns 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.booleanReturnstrueif 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.booleanReturnstrueif the portlet uses the default template.longReturns 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.booleanhasAddPortletPermission(long userId) Returnstrueif the user has the permission to add the portlet to a layout.booleanbooleanbooleanbooleaninthashCode()booleanbooleanbooleanbooleanbooleanReturnstrueif the portlet supports more than one mime type.booleanhasPortletMode(String mimeType, PortletMode portletMode) Returnstrueif the portlet supports the specified mime type and portlet mode.booleanhasRoleWithName(String roleName) Returnstrueif the portlet has a role with the specified name.booleanhasWindowState(String mimeType, WindowState windowState) Returnstrueif the portlet supports the specified mime type and window state.booleanReturnstrueif an action URL for this portlet should cause an auto redirect.booleanisActive()Returnstrueif this portlet is active.booleanReturnstrueif default resources for the portlet are added to a page.booleanReturnstrueif the portlet can be displayed via Ajax.booleanReturnstrueif the portlet supports asynchronous processing in resource requests.booleanbooleanReturnstrueto include the portlet and make it available to be made active.booleanReturnstrueif the portlet can be added multiple times to a layout.booleanReturnstrueto allow the portlet to be cached within the layout.booleanReturnstrueif the portlet goes into the maximized state when the user goes into the edit mode.booleanReturnstrueif the portlet goes into the maximized state when the user goes into the help mode.booleanReturnstrueif the portlet'sserveResource(ResourceRequest,ResourceResponse)method should be invoked during a partial action triggered by a different portlet on the same portal page.booleanReturnstrueif the portlet goes into the pop up state when the user goes into the print mode.booleanReturnstrueif 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.booleanReturnstrueif 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.booleanReturnstrueif preferences are shared across the entire company.booleanReturnstrueif preferences are owned by the group when the portlet is shown in a group layout.booleanReturnstrueif preferences are unique per layout.booleanReturnstrueif the portlet does not share request attributes with the portal or portlets from another WAR.booleanReturnstrueif the portlet does not share session attributes with the portal.booleanisReady()Returnstrueif the portlet is ready to be used.booleanReturnstrueif the portlet will only process namespaced parameters.booleanReturnstrueif the portlet restores to the current view from the maximized state.booleanReturnstrueif the portlet supports scoping of data.booleanReturnstrueif users are shown that they do not have access to the portlet.booleanReturnstrueif users are shown that the portlet is inactive.booleanReturnstrueif the portlet uses Single Page Application.booleanisStatic()Returnstrueif the portlet is a static portlet that is cannot be moved.booleanReturnstrueif the portlet is a static portlet at the end of a list of portlets.booleanReturnstrueif the portlet is a static portlet at the start of a list of portlets.booleanisSystem()Returnstrueif the portlet is a system portlet that a user cannot manually add to their page.booleanReturnstrueif the portlet is an undeployed portlet.booleanReturnstrueif the portlet uses the default template.voidLink the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml.voidpersist()Updates this model instance in the database or adds it if it does not yet exist.voidsetActionTimeout(int actionTimeout) Sets the action timeout of the portlet.voidsetActionURLRedirect(boolean actionURLRedirect) Set totrueif an action URL for this portlet should cause an auto redirect.voidsetActive(boolean active) Sets whether this portlet is active.voidsetAddDefaultResource(boolean addDefaultResource) Set totrueif default resources for the portlet are added to a page.voidsetAjaxable(boolean ajaxable) Set totrueif the portlet can be displayed via Ajax.voidsetApplicationTypes(Set<ApplicationType> applicationTypes) Sets the application types of the portlet.voidsetAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses) Sets the names of the classes that represent asset types associated with the portlet.voidsetAsyncSupported(boolean asyncSupported) Set totrueif the portlet supports asynchronous processing in resource requests.voidsetAutopropagatedParameters(Set<String> autopropagatedParameters) Sets the names of the parameters that will be automatically propagated through the portlet.voidsetCategoryNames(Set<String> categoryNames) Sets the category names of the portlet.voidsetCompanyId(long companyId) Sets the company ID of this portlet.voidsetConfigurationActionClass(String configurationActionClass) Sets the configuration action class of the portlet.voidsetControlPanelEntryCategory(String controlPanelEntryCategory) Set the name of the category of the Control Panel where the portlet will be shown.voidsetControlPanelEntryClass(String controlPanelEntryClass) Sets the name of the class that will control when the portlet will be shown in the Control Panel.voidsetControlPanelEntryWeight(double controlPanelEntryWeight) Sets the relative weight of the portlet with respect to the other portlets in the same category of the Control Panel.voidsetCssClassWrapper(String cssClassWrapper) Sets the name of the CSS class that will be injected in the DIV that wraps this portlet.voidsetCustomAttributesDisplayClasses(List<String> customAttributesDisplayClasses) Sets the names of the classes that represent custom attribute displays associated with the portlet.voidsetDefaultPluginSetting(PluginSetting pluginSetting) Sets the default plugin settings of the portlet.voidsetDefaultPreferences(String defaultPreferences) Sets the default preferences of the portlet.voidsetDisplayName(String displayName) Sets the display name of the portlet.voidsetExpCache(Integer expCache) Sets expiration cache of the portlet.voidsetFooterPortalCss(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.voidsetFooterPortalJavaScript(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.voidsetFooterPortletCss(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.voidsetFooterPortletJavaScript(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.voidsetFriendlyURLMapperClass(String friendlyURLMapperClass) Sets the name of the friendly URL mapper class of the portlet.voidsetFriendlyURLMapping(String friendlyURLMapping) Sets the name of the friendly URL mapping of the portlet.voidsetFriendlyURLRoutes(String friendlyURLRoutes) Sets the class loader resource path to the friendly URL routes of the portlet.voidsetHeaderPortalCss(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.voidsetHeaderPortalJavaScript(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.voidsetHeaderPortletCss(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.voidsetHeaderPortletJavaScript(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.voidsetHeaderRequestAttributePrefixes(List<String> headerRequestAttributePrefixes) Sets a list of attribute name prefixes that will be referenced after the HEADER_PHASE completes for each portlet.voidsetHeaderTimeout(int headerTimeout) Sets the header timeout of the portlet.voidSets the icon of the portlet.voidsetId(long id) Sets the ID of this portlet.voidsetInclude(boolean include) Set totrueto include the portlet and make it available to be made active.voidsetIndexerClasses(List<String> indexerClasses) Sets the names of the classes that represent indexers associated with the portlet.voidsetInitParams(Map<String, String> initParams) Sets the init parameters of the portlet.voidsetInstanceable(boolean instanceable) Set totrueif the portlet can be added multiple times to a layout.voidsetLayoutCacheable(boolean layoutCacheable) Set totrueto allow the portlet to be cached within the layout.voidsetMaximizeEdit(boolean maximizeEdit) Set totrueif the portlet goes into the maximized state when the user goes into the edit mode.voidsetMaximizeHelp(boolean maximizeHelp) Set totrueif the portlet goes into the maximized state when the user goes into the help mode.voidsetModelAttributes(Map<String, Object> attributes) voidsetMultipartFileSizeThreshold(int multipartFileSizeThreshold) Sets the maximum size of buffered bytes before storing occurs.voidsetMultipartLocation(String multipartLocation) Sets the directory for storing uploaded files.voidsetMultipartMaxFileSize(long multipartMaxFileSize) Sets the maximum number of bytes permitted for an uploaded file.voidsetMultipartMaxRequestSize(long multipartMaxRequestSize) Sets the maximum number of bytes permitted for a multipart request.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this portlet.voidsetOpenSearchClass(String openSearchClass) Sets the name of the open search class of the portlet.voidsetParentStrutsPath(String parentStrutsPath) Sets the parent struts path of the portlet.voidsetPartialActionServeResource(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.voidsetPermissionPropagatorClass(String permissionPropagatorClass) Sets the name of the permission propagator class of the portlet.voidsetPluginPackage(PluginPackage pluginPackage) Sets this portlet's plugin package.voidsetPopMessageListenerClass(String popMessageListenerClass) Sets the name of the POP message listener class of the portlet.voidsetPopUpPrint(boolean popUpPrint) Sets whether the portlet goes into the pop up state when the user goes into the print mode.voidsetPortletApp(PortletApp portletApp) Sets this portlet's application.voidsetPortletClass(String portletClass) Sets the name of the portlet class of the portlet.voidsetPortletConfigurationListenerClass(String portletConfigurationListenerClass) voidsetPortletDataHandlerClass(String portletDataHandlerClass) Sets the name of the portlet data handler class of the portlet.voidsetPortletDependencyCssEnabled(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.voidsetPortletDependencyJavaScriptEnabled(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.voidsetPortletFilters(Map<String, PortletFilter> portletFilters) Sets the filters of the portlet.voidsetPortletId(String portletId) Sets the portlet ID of this portlet.voidsetPortletInfo(PortletInfo portletInfo) Sets the portlet info of the portlet.voidsetPortletLayoutListenerClass(String portletLayoutListenerClass) Sets the name of the portlet layout listener class of the portlet.voidsetPortletModes(Map<String, Set<String>> portletModes) Sets the portlet modes of the portlet.voidsetPortletName(String portletName) Sets the name of the portlet.voidsetPortletURLClass(String portletURLClass) Sets the name of the portlet URL class of the portlet.voidsetPreferencesCompanyWide(boolean preferencesCompanyWide) Set totrueif preferences are shared across the entire company.voidsetPreferencesOwnedByGroup(boolean preferencesOwnedByGroup) Set totrueif preferences are owned by the group when the portlet is shown in a group layout.voidsetPreferencesUniquePerLayout(boolean preferencesUniquePerLayout) Set totrueif preferences are unique per layout.voidsetPreferencesValidator(String preferencesValidator) Sets the name of the preferences validator class of the portlet.voidsetPrimaryKey(long primaryKey) Sets the primary key of this portlet.voidsetPrivateRequestAttributes(boolean privateRequestAttributes) Set totrueif the portlet does not share request attributes with the portal or portlets from another WAR.voidsetPrivateSessionAttributes(boolean privateSessionAttributes) Set totrueif the portlet does not share session attributes with the portal.voidsetProcessingEvents(Set<QName> processingEvents) Sets the processing events of the portlet.voidsetPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters) Sets the public render parameters of the portlet.voidsetPublishingEvents(Set<QName> publishingEvents) Sets the publishing events of the portlet.voidsetReady(boolean ready) Set totrueif the portlet is ready to be used.voidsetRenderTimeout(int renderTimeout) Sets the render timeout of the portlet.voidsetRenderWeight(int renderWeight) Sets the render weight of the portlet.voidsetRequiresNamespacedParameters(boolean requiresNamespacedParameters) Set totrueif the portlet will only process namespaced parameters.voidsetResourceBundle(String resourceBundle) Sets the resource bundle of the portlet.voidsetRestoreCurrentView(boolean restoreCurrentView) Set totrueif the portlet restores to the current view from the maximized state.voidsetRoleMappers(Map<String, String> roleMappers) Sets the role mappers of the portlet.voidSets the roles of this portlet.voidsetRolesArray(String[] rolesArray) Sets an array of required roles of the portlet.voidsetSchedulerEntries(List<SchedulerEntry> schedulerEntries) Sets the scheduler entries of the portlet.voidsetScopeable(boolean scopeable) Set totrueif the portlet supports scoping of data.voidsetShowPortletAccessDenied(boolean showPortletAccessDenied) Set totrueif users are shown that they do not have access to the portlet.voidsetShowPortletInactive(boolean showPortletInactive) Set totrueif users are shown that the portlet is inactive.voidsetSinglePageApplication(boolean singlePageApplication) Set totrueif the portlet uses Single Page Application.voidsetSocialActivityInterpreterClasses(List<String> socialActivityInterpreterClasses) Sets the names of the classes that represent social activity interpreters associated with the portlet.voidsetSocialRequestInterpreterClass(String socialRequestInterpreterClass) Sets the name of the social request interpreter class of the portlet.voidsetStagedModelDataHandlerClasses(List<String> stagedModelDataHandlerClasses) Sets the names of the classes that represent staged model data handlers associated with the portlet.voidsetStatic(boolean staticPortlet) Set totrueif the portlet is a static portlet that is cannot be moved.voidsetStaticStart(boolean staticPortletStart) Set totrueif the portlet is a static portlet at the start of a list of portlets.voidsetStrutsPath(String strutsPath) Sets the struts path of the portlet.voidsetSupportedLocales(Set<String> supportedLocales) Sets the supported locales of the portlet.voidsetSystem(boolean system) Set totrueif the portlet is a system portlet that a user cannot manually add to their page.voidsetTemplateHandlerClass(String templateHandlerClass) Sets the name of the template handler class of the portlet.voidsetTrashHandlerClasses(List<String> trashHandlerClasses) Sets the names of the classes that represent trash handlers associated to the portlet.voidsetUndeployedPortlet(boolean undeployedPortlet) Set totrueif the portlet is an undeployed portlet.voidsetUnlinkedRoles(Set<String> unlinkedRoles) Sets the unlinked roles of the portlet.voidsetURLEncoderClass(String urlEncoderClass) Sets the name of the URL encoder class of the portlet.voidsetUseDefaultTemplate(boolean useDefaultTemplate) Set totrueif the portlet uses the default template.voidsetUserNotificationDefinitions(String userNotificationDefinitions) Sets the class loader resource path to the user notification definitions of the portlet.voidsetUserNotificationHandlerClasses(List<String> userNotificationHandlerClasses) Sets the names of the classes that represent user notification handlers associated with the portlet.voidsetUserPrincipalStrategy(String userPrincipalStrategy) Sets the user principal strategy of the portlet.voidsetVirtualPath(String virtualPath) Sets the virtual path of the portlet.voidsetWebDAVStorageClass(String webDAVStorageClass) Sets the name of the WebDAV storage class of the portlet.voidsetWebDAVStorageToken(String webDAVStorageToken) Sets the name of the WebDAV storage token of the portlet.voidsetWindowStates(Map<String, Set<String>> windowStates) Sets the window states of the portlet.voidsetWorkflowHandlerClasses(List<String> workflowHandlerClasses) Sets the names of the classes that represent workflow handlers associated to the portlet.voidsetXmlRpcMethodClass(String xmlRpcMethodClass) Sets the name of the XML-RPC method class of the portlet.voidprotected PortletWrapperMethods 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, toUnescapedModelMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods 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, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface com.liferay.portal.kernel.model.ModelWrapper
getWrappedModel
-
Constructor Details
-
PortletWrapper
-
-
Method Details
-
getModelAttributes
- Specified by:
getModelAttributesin interfaceBaseModel<Portlet>
-
setModelAttributes
- Specified by:
setModelAttributesin interfaceBaseModel<Portlet>
-
addApplicationType
Adds an application type.- Specified by:
addApplicationTypein interfacePortlet- Parameters:
applicationType- an application type
-
addPortletDependency
Adds a portlet CSS/JavaScript resource dependency.- Specified by:
addPortletDependencyin interfacePortlet- Parameters:
portletDependency- the portlet CSS/JavaScript resource dependency
-
addProcessingEvent
Adds a processing event.- Specified by:
addProcessingEventin interfacePortlet
-
addPublicRenderParameter
Adds a public render parameter.- Specified by:
addPublicRenderParameterin interfacePortlet- Parameters:
publicRenderParameter- a public render parameter
-
addPublishingEvent
Adds a publishing event.- Specified by:
addPublishingEventin interfacePortlet
-
addSchedulerEntry
Adds a scheduler entry.- Specified by:
addSchedulerEntryin interfacePortlet
-
clone
Creates and returns a copy of this object. -
cloneWithOriginalValues
- Specified by:
cloneWithOriginalValuesin interfaceBaseModel<Portlet>- Specified by:
cloneWithOriginalValuesin interfacePortletModel
-
compareTo
Compares this portlet to the specified object.- Specified by:
compareToin interfaceComparable<Portlet>- Specified by:
compareToin interfacePortlet- Overrides:
compareToin 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:
equalsin interfacePortlet- Overrides:
equalsin classBaseModelWrapper<Portlet>- Parameters:
object- the object to compare this portlet against- Returns:
trueif the portlet is equal to the specified object
-
getActionTimeout
public int getActionTimeout()Returns the action timeout of the portlet.- Specified by:
getActionTimeoutin interfacePortlet- Returns:
- the action timeout of the portlet
-
getActionURLRedirect
public boolean getActionURLRedirect()Returnstrueif an action URL for this portlet should cause an auto redirect.- Specified by:
getActionURLRedirectin interfacePortlet- Returns:
trueif an action URL for this portlet should cause an auto redirect
-
getActive
public boolean getActive()Returns the active of this portlet.- Specified by:
getActivein interfacePortletModel- Returns:
- the active of this portlet
-
getAddDefaultResource
public boolean getAddDefaultResource()Returnstrueif default resources for the portlet are added to a page.- Specified by:
getAddDefaultResourcein interfacePortlet- Returns:
trueif default resources for the portlet are added to a page
-
getAjaxable
public boolean getAjaxable()Returnstrueif the portlet can be displayed via Ajax.- Specified by:
getAjaxablein interfacePortlet- Returns:
trueif the portlet can be displayed via Ajax
-
getAllPortletModes
Returns the portlet modes of the portlet.- Specified by:
getAllPortletModesin interfacePortlet- Returns:
- the portlet modes of the portlet
-
getAllWindowStates
Returns the window states of the portlet.- Specified by:
getAllWindowStatesin interfacePortlet- Returns:
- the window states of the portlet
-
getApplicationTypes
Returns the application types of the portlet.- Specified by:
getApplicationTypesin 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:
getAssetRendererFactoryClassesin 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:
getAutopropagatedParametersin 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:
getCategoryNamesin interfacePortlet- Returns:
- the category names of the portlet
-
getClonedInstance
Returnstrueif the portlet is found in a WAR file.- Specified by:
getClonedInstancein 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:
getCompanyIdin interfacePortletModel- Specified by:
getCompanyIdin interfaceShardedModel- Returns:
- the company ID of this portlet
-
getConfigurationActionClass
Returns the configuration action class of the portlet.- Specified by:
getConfigurationActionClassin interfacePortlet- Returns:
- the configuration action class of the portlet
-
getConfigurationActionInstance
Returns the configuration action instance of the portlet.- Specified by:
getConfigurationActionInstancein interfacePortlet- Returns:
- the configuration action instance of the portlet
-
getContextName
Returns the servlet context name of the portlet.- Specified by:
getContextNamein interfacePortlet- Returns:
- the servlet context name of the portlet
-
getContextPath
Returns the servlet context path of the portlet.- Specified by:
getContextPathin 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:
getControlPanelEntryCategoryin 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:
getControlPanelEntryClassin 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:
getControlPanelEntryInstancein 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:
getControlPanelEntryWeightin 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:
getCssClassWrapperin 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:
getCustomAttributesDisplayClassesin 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:
getCustomAttributesDisplayInstancesin interfacePortlet- Returns:
- the custom attribute display instances of the portlet
-
getDefaultPluginSetting
Get the default plugin settings of the portlet.- Specified by:
getDefaultPluginSettingin interfacePortlet- Returns:
- the plugin settings
-
getDefaultPreferences
Returns the default preferences of the portlet.- Specified by:
getDefaultPreferencesin interfacePortlet- Returns:
- the default preferences of the portlet
-
getDisplayName
Returns the display name of the portlet.- Specified by:
getDisplayNamein interfacePortlet- Returns:
- the display name of the portlet
-
getExpCache
Returns expiration cache of the portlet.- Specified by:
getExpCachein interfacePortlet- Returns:
- expiration cache of the portlet
-
getFriendlyURLMapperClass
Returns the name of the friendly URL mapper class of the portlet.- Specified by:
getFriendlyURLMapperClassin 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:
getFriendlyURLMapperInstancein interfacePortlet- Returns:
- the friendly URL mapper instance of the portlet
-
getFriendlyURLMapping
Returns the name of the friendly URL mapping of the portlet.- Specified by:
getFriendlyURLMappingin interfacePortlet- Returns:
- the name of the friendly URL mapping of the portlet
-
getFriendlyURLMapping
- Specified by:
getFriendlyURLMappingin interfacePortlet
-
getFriendlyURLRoutes
Returns the class loader resource path to the friendly URL routes of the portlet.- Specified by:
getFriendlyURLRoutesin 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:
getHeaderPortalCssin 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:
getHeaderPortalJavaScriptin 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:
getHeaderPortletCssin 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:
getHeaderPortletJavaScriptin 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:
getHeaderRequestAttributePrefixesin 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:
getHeaderTimeoutin 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:
getIdin interfacePortletModel- Returns:
- the ID of this portlet
-
getInclude
public boolean getInclude()Returnstrueto include the portlet and make it available to be made active.- Specified by:
getIncludein interfacePortlet- Returns:
trueto 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:
getIndexerClassesin interfacePortlet- Returns:
- the names of the classes that represent indexers associated with the portlet
-
getIndexerInstances
Returns the indexer instances of the portlet.- Specified by:
getIndexerInstancesin interfacePortlet- Returns:
- the indexer instances of the portlet
-
getInitParams
Returns the init parameters of the portlet.- Specified by:
getInitParamsin interfacePortlet- Returns:
- init parameters of the portlet
-
getInstanceable
public boolean getInstanceable()Returnstrueif the portlet can be added multiple times to a layout.- Specified by:
getInstanceablein interfacePortlet- Returns:
trueif the portlet can be added multiple times to a layout
-
getInstanceId
Returns the instance ID of the portlet.- Specified by:
getInstanceIdin interfacePortlet- Returns:
- the instance ID of the portlet
-
getLayoutCacheable
public boolean getLayoutCacheable()Returnstrueto allow the portlet to be cached within the layout.- Specified by:
getLayoutCacheablein interfacePortlet- Returns:
trueif the portlet can be cached within the layout
-
getMaximizeEdit
public boolean getMaximizeEdit()Returnstrueif the portlet goes into the maximized state when the user goes into the edit mode.- Specified by:
getMaximizeEditin interfacePortlet- Returns:
trueif the portlet goes into the maximized state when the user goes into the edit mode
-
getMaximizeHelp
public boolean getMaximizeHelp()Returnstrueif the portlet goes into the maximized state when the user goes into the help mode.- Specified by:
getMaximizeHelpin interfacePortlet- Returns:
trueif 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:
getMultipartFileSizeThresholdin interfacePortlet- Returns:
- the maximum size of buffered bytes before storing occurs
-
getMultipartLocation
Returns the directory for storing uploaded files.- Specified by:
getMultipartLocationin 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:
getMultipartMaxFileSizein 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:
getMultipartMaxRequestSizein 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:
getMvccVersionin interfaceMVCCModel- Specified by:
getMvccVersionin interfacePortletModel- Returns:
- the mvcc version of this portlet
-
getOpenSearchClass
Returns the name of the open search class of the portlet.- Specified by:
getOpenSearchClassin interfacePortlet- Returns:
- the name of the open search class of the portlet
-
getOpenSearchInstance
Returns the indexer instance of the portlet.- Specified by:
getOpenSearchInstancein interfacePortlet- Returns:
- the indexer instance of the portlet
-
getParentStrutsPath
Returns the parent struts path of the portlet.- Specified by:
getParentStrutsPathin interfacePortlet- Returns:
- the parent struts path of the portlet.
-
getPermissionPropagatorClass
Returns the name of the permission propagator class of the portlet.- Specified by:
getPermissionPropagatorClassin interfacePortlet- Returns:
- the name of the permission propagator class of the portlet
-
getPermissionPropagatorInstance
Returns the permission propagator instance of the portlet.- Specified by:
getPermissionPropagatorInstancein interfacePortlet- Returns:
- the permission propagator instance of the portlet
-
getPluginId
Returns the plugin ID of the portlet.- Specified by:
getPluginIdin interfacePortlet- Returns:
- the plugin ID of the portlet
-
getPluginPackage
Returns this portlet's plugin package.- Specified by:
getPluginPackagein interfacePortlet- Returns:
- this portlet's plugin package
-
getPluginType
Returns the plugin type of the portlet.- Specified by:
getPluginTypein interfacePortlet- Returns:
- the plugin type of the portlet
-
getPopMessageListenerClass
Returns the name of the POP message listener class of the portlet.- Specified by:
getPopMessageListenerClassin 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:
getPopMessageListenerInstancein interfacePortlet- Returns:
- the POP message listener instance of the portlet
-
getPopUpPrint
public boolean getPopUpPrint()Returnstrueif the portlet goes into the pop up state when the user goes into the print mode.- Specified by:
getPopUpPrintin interfacePortlet- Returns:
trueif the portlet goes into the pop up state when the user goes into the print mode
-
getPortletApp
Returns this portlet's application.- Specified by:
getPortletAppin interfacePortlet- Returns:
- this portlet's application
-
getPortletClass
Returns the name of the portlet class of the portlet.- Specified by:
getPortletClassin interfacePortlet- Returns:
- the name of the portlet class of the portlet
-
getPortletConfigurationListenerClass
- Specified by:
getPortletConfigurationListenerClassin interfacePortlet
-
getPortletConfigurationListenerInstance
- Specified by:
getPortletConfigurationListenerInstancein interfacePortlet
-
getPortletDataHandlerClass
Returns the name of the portlet data handler class of the portlet.- Specified by:
getPortletDataHandlerClassin 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:
getPortletDataHandlerInstancein interfacePortlet- Returns:
- the portlet data handler instance of the portlet
-
getPortletDependencies
Returns the portlet's CSS/JavaScript resource dependencies.- Specified by:
getPortletDependenciesin interfacePortlet- Returns:
- the portlet's CSS/JavaScript resource dependencies
-
getPortletFilters
Returns the filters of the portlet.- Specified by:
getPortletFiltersin interfacePortlet- Returns:
- filters of the portlet
-
getPortletId
Returns the portlet ID of this portlet.- Specified by:
getPortletIdin interfacePortletModel- Returns:
- the portlet ID of this portlet
-
getPortletInfo
Returns the portlet info of the portlet.- Specified by:
getPortletInfoin interfacePortlet- Returns:
- portlet info of the portlet
-
getPortletLayoutListenerClass
Returns the name of the portlet layout listener class of the portlet.- Specified by:
getPortletLayoutListenerClassin 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:
getPortletLayoutListenerInstancein interfacePortlet- Returns:
- the portlet layout listener instance of the portlet
-
getPortletModes
Returns the portlet modes of the portlet.- Specified by:
getPortletModesin interfacePortlet- Returns:
- portlet modes of the portlet
-
getPortletName
Returns the name of the portlet.- Specified by:
getPortletNamein interfacePortlet- Returns:
- the display name of the portlet
-
getPortletURLClass
Returns the name of the portlet URL class of the portlet.- Specified by:
getPortletURLClassin interfacePortlet- Returns:
- the name of the portlet URL class of the portlet
-
getPreferencesCompanyWide
public boolean getPreferencesCompanyWide()Returnstrueif preferences are shared across the entire company.- Specified by:
getPreferencesCompanyWidein interfacePortlet- Returns:
trueif preferences are shared across the entire company
-
getPreferencesOwnedByGroup
public boolean getPreferencesOwnedByGroup()Returnstrueif preferences are owned by the group when the portlet is shown in a group layout. Returnsfalseif preferences are owned by the user at all times.- Specified by:
getPreferencesOwnedByGroupin interfacePortlet- Returns:
trueif preferences are owned by the group when the portlet is shown in a group layout;falseif preferences are owned by the user at all times.
-
getPreferencesUniquePerLayout
public boolean getPreferencesUniquePerLayout()Returnstrueif preferences are unique per layout.- Specified by:
getPreferencesUniquePerLayoutin interfacePortlet- Returns:
trueif preferences are unique per layout
-
getPreferencesValidator
Returns the name of the preferences validator class of the portlet.- Specified by:
getPreferencesValidatorin 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:
getPrimaryKeyin interfacePortletModel- Returns:
- the primary key of this portlet
-
getPrivateRequestAttributes
public boolean getPrivateRequestAttributes()Returnstrueif the portlet does not share request attributes with the portal or portlets from another WAR.- Specified by:
getPrivateRequestAttributesin interfacePortlet- Returns:
trueif the portlet does not share request attributes with the portal or portlets from another WAR
-
getPrivateSessionAttributes
public boolean getPrivateSessionAttributes()Returnstrueif the portlet does not share session attributes with the portal.- Specified by:
getPrivateSessionAttributesin interfacePortlet- Returns:
trueif 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:
getProcessingEventin 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:
getProcessingEventsin interfacePortlet- Returns:
- the processing events of the portlet
-
getPublicRenderParameter
Returns the public render parameter from an identifier.- Specified by:
getPublicRenderParameterin 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:
getPublicRenderParameterin 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:
getPublicRenderParametersin interfacePortlet- Returns:
- the public render parameters of the portlet
-
getPublishingEvents
Returns the publishing events of the portlet.- Specified by:
getPublishingEventsin interfacePortlet- Returns:
- the publishing events of the portlet
-
getReady
public boolean getReady()Returnstrueif the portlet is ready to be used. -
getRenderTimeout
public int getRenderTimeout()Returns the render timeout of the portlet.- Specified by:
getRenderTimeoutin interfacePortlet- Returns:
- the render timeout of the portlet
-
getRenderWeight
public int getRenderWeight()Returns the render weight of the portlet.- Specified by:
getRenderWeightin interfacePortlet- Returns:
- the render weight of the portlet
-
getResourceBundle
Returns the resource bundle of the portlet.- Specified by:
getResourceBundlein interfacePortlet- Returns:
- resource bundle of the portlet
-
getRestoreCurrentView
public boolean getRestoreCurrentView()Returnstrueif the portlet restores to the current view from the maximized state.- Specified by:
getRestoreCurrentViewin interfacePortlet- Returns:
trueif the portlet restores to the current view from the maximized state
-
getRoleMappers
Returns the role mappers of the portlet.- Specified by:
getRoleMappersin interfacePortlet- Returns:
- role mappers of the portlet
-
getRoles
Returns the roles of this portlet.- Specified by:
getRolesin interfacePortletModel- Returns:
- the roles of this portlet
-
getRolesArray
Returns an array of required roles of the portlet.- Specified by:
getRolesArrayin interfacePortlet- Returns:
- an array of required roles of the portlet
-
getRootPortlet
Returns the root portlet of this portlet instance.- Specified by:
getRootPortletin interfacePortlet- Returns:
- the root portlet of this portlet instance
-
getRootPortletId
Returns the root portlet ID of the portlet.- Specified by:
getRootPortletIdin interfacePortlet- Returns:
- the root portlet ID of the portlet
-
getSchedulerEntries
Returns the scheduler entries of the portlet.- Specified by:
getSchedulerEntriesin interfacePortlet- Returns:
- the scheduler entries of the portlet
-
getScopeable
public boolean getScopeable()Returnstrueif the portlet supports scoping of data.- Specified by:
getScopeablein interfacePortlet- Returns:
trueif the portlet supports scoping of data
-
getShowPortletAccessDenied
public boolean getShowPortletAccessDenied()Returnstrueif users are shown that they do not have access to the portlet.- Specified by:
getShowPortletAccessDeniedin interfacePortlet- Returns:
trueif users are shown that they do not have access to the portlet
-
getShowPortletInactive
public boolean getShowPortletInactive()Returnstrueif users are shown that the portlet is inactive.- Specified by:
getShowPortletInactivein interfacePortlet- Returns:
trueif users are shown that the portlet is inactive
-
getSinglePageApplication
public boolean getSinglePageApplication()Returnstrueif the portlet uses Single Page Application.- Specified by:
getSinglePageApplicationin interfacePortlet- Returns:
trueif the portlet uses Single Page Application
-
getSocialActivityInterpreterClasses
Returns the names of the classes that represent social activity interpreters associated with the portlet.- Specified by:
getSocialActivityInterpreterClassesin 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:
getSocialActivityInterpreterInstancesin 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:
getSocialRequestInterpreterClassin 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:
getSocialRequestInterpreterInstancein 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:
getStagedModelDataHandlerClassesin 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:
getStagedModelDataHandlerInstancesin interfacePortlet- Returns:
- the staged model data handler instances of the portlet
-
getStatic
public boolean getStatic()Returnstrueif the portlet is a static portlet that is cannot be moved. -
getStaticEnd
public boolean getStaticEnd()Returnstrueif the portlet is a static portlet at the end of a list of portlets.- Specified by:
getStaticEndin interfacePortlet- Returns:
trueif 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:
getStaticResourcePathin interfacePortlet- Returns:
- the path for static resources served by this portlet
-
getStaticStart
public boolean getStaticStart()Returnstrueif the portlet is a static portlet at the start of a list of portlets.- Specified by:
getStaticStartin interfacePortlet- Returns:
trueif the portlet is a static portlet at the start of a list of portlets
-
getStrutsPath
Returns the struts path of the portlet.- Specified by:
getStrutsPathin interfacePortlet- Returns:
- the struts path of the portlet
-
getSupportedLocales
Returns the supported locales of the portlet.- Specified by:
getSupportedLocalesin interfacePortlet- Returns:
- the supported locales of the portlet
-
getSystem
public boolean getSystem()Returnstrueif 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:
getTemplateHandlerClassin interfacePortlet- Returns:
- the name of the template handler class of the portlet
-
getTemplateHandlerInstance
Returns the template handler instance of the portlet.- Specified by:
getTemplateHandlerInstancein interfacePortlet- Returns:
- the template handler instance of the portlet
-
getTimestamp
public long getTimestamp()Returns the timestamp of the portlet.- Specified by:
getTimestampin interfacePortlet- Returns:
- the timestamp of the portlet
-
getTrashHandlerClasses
Returns the names of the classes that represent trash handlers associated with the portlet.- Specified by:
getTrashHandlerClassesin 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:
getTrashHandlerInstancesin interfacePortlet- Returns:
- the trash handler instances of the portlet
-
getUndeployedPortlet
public boolean getUndeployedPortlet()Returnstrueif the portlet is an undeployed portlet.- Specified by:
getUndeployedPortletin interfacePortlet- Returns:
trueif the portlet is a placeholder of an undeployed portlet
-
getUnlinkedRoles
Returns the unlinked roles of the portlet.- Specified by:
getUnlinkedRolesin interfacePortlet- Returns:
- unlinked roles of the portlet
-
getURLEncoderClass
Returns the name of the URL encoder class of the portlet.- Specified by:
getURLEncoderClassin interfacePortlet- Returns:
- the name of the URL encoder class of the portlet
-
getURLEncoderInstance
Returns the URL encoder instance of the portlet.- Specified by:
getURLEncoderInstancein interfacePortlet- Returns:
- the URL encoder instance of the portlet
-
getUseDefaultTemplate
public boolean getUseDefaultTemplate()Returnstrueif the portlet uses the default template.- Specified by:
getUseDefaultTemplatein interfacePortlet- Returns:
trueif 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:
getUserNotificationDefinitionsin 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:
getUserNotificationHandlerClassesin 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:
getUserNotificationHandlerInstancesin interfacePortlet- Returns:
- the user notification handler instances of the portlet
-
getUserPrincipalStrategy
Returns the user principal strategy of the portlet.- Specified by:
getUserPrincipalStrategyin interfacePortlet- Returns:
- the user principal strategy of the portlet
-
getVirtualPath
Returns the virtual path of the portlet.- Specified by:
getVirtualPathin interfacePortlet- Returns:
- the virtual path of the portlet
-
getWebDAVStorageClass
Returns the name of the WebDAV storage class of the portlet.- Specified by:
getWebDAVStorageClassin 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:
getWebDAVStorageInstancein 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:
getWebDAVStorageTokenin interfacePortlet- Returns:
- the name of the WebDAV storage token of the portlet
-
getWindowStates
Returns the window states of the portlet.- Specified by:
getWindowStatesin interfacePortlet- Returns:
- window states of the portlet
-
getWorkflowHandlerClasses
Returns the names of the classes that represent workflow handlers associated with the portlet.- Specified by:
getWorkflowHandlerClassesin 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:
getWorkflowHandlerInstancesin interfacePortlet- Returns:
- the workflow handler instances of the portlet
-
getXmlRpcMethodClass
Returns the name of the XML-RPC method class of the portlet.- Specified by:
getXmlRpcMethodClassin 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:
getXmlRpcMethodInstancein interfacePortlet- Returns:
- the name of the XML-RPC method instance of the portlet
-
hasAddPortletPermission
public boolean hasAddPortletPermission(long userId) Returnstrueif the user has the permission to add the portlet to a layout.- Specified by:
hasAddPortletPermissionin interfacePortlet- Parameters:
userId- the primary key of the user- Returns:
trueif the user has the permission to add the portlet to a layout
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacePortlet- Overrides:
hashCodein classBaseModelWrapper<Portlet>
-
hasHeaderPortalCss
public boolean hasHeaderPortalCss()- Specified by:
hasHeaderPortalCssin interfacePortlet
-
hasHeaderPortalJavaScript
public boolean hasHeaderPortalJavaScript()- Specified by:
hasHeaderPortalJavaScriptin interfacePortlet
-
hasHeaderPortletCss
public boolean hasHeaderPortletCss()- Specified by:
hasHeaderPortletCssin interfacePortlet
-
hasHeaderPortletJavaScript
public boolean hasHeaderPortletJavaScript()- Specified by:
hasHeaderPortletJavaScriptin interfacePortlet
-
hasMultipleMimeTypes
public boolean hasMultipleMimeTypes()Returnstrueif the portlet supports more than one mime type.- Specified by:
hasMultipleMimeTypesin interfacePortlet- Returns:
trueif the portlet supports more than one mime type
-
hasPortletMode
Returnstrueif the portlet supports the specified mime type and portlet mode.- Specified by:
hasPortletModein interfacePortlet- Parameters:
mimeType- the mime typeportletMode- the portlet mode- Returns:
trueif the portlet supports the specified mime type and portlet mode
-
hasRoleWithName
Returnstrueif the portlet has a role with the specified name.- Specified by:
hasRoleWithNamein interfacePortlet- Parameters:
roleName- the role name- Returns:
trueif the portlet has a role with the specified name
-
hasWindowState
Returnstrueif the portlet supports the specified mime type and window state.- Specified by:
hasWindowStatein interfacePortlet- Parameters:
mimeType- the mime typewindowState- the window state- Returns:
trueif the portlet supports the specified mime type and window state
-
isActionURLRedirect
public boolean isActionURLRedirect()Returnstrueif an action URL for this portlet should cause an auto redirect.- Specified by:
isActionURLRedirectin interfacePortlet- Returns:
trueif an action URL for this portlet should cause an auto redirect
-
isActive
public boolean isActive()Returnstrueif this portlet is active.- Specified by:
isActivein interfacePortletModel- Returns:
trueif this portlet is active;falseotherwise
-
isAddDefaultResource
public boolean isAddDefaultResource()Returnstrueif default resources for the portlet are added to a page.- Specified by:
isAddDefaultResourcein interfacePortlet- Returns:
trueif default resources for the portlet are added to a page
-
isAjaxable
public boolean isAjaxable()Returnstrueif the portlet can be displayed via Ajax.- Specified by:
isAjaxablein interfacePortlet- Returns:
trueif the portlet can be displayed via Ajax
-
isAsyncSupported
public boolean isAsyncSupported()Returnstrueif the portlet supports asynchronous processing in resource requests.- Specified by:
isAsyncSupportedin interfacePortlet- Returns:
trueif the portlet supports asynchrounous processing in resource requests
-
isFullPageDisplayable
public boolean isFullPageDisplayable()- Specified by:
isFullPageDisplayablein interfacePortlet
-
isInclude
public boolean isInclude()Returnstrueto include the portlet and make it available to be made active. -
isInstanceable
public boolean isInstanceable()Returnstrueif the portlet can be added multiple times to a layout.- Specified by:
isInstanceablein interfacePortlet- Returns:
trueif the portlet can be added multiple times to a layout
-
isLayoutCacheable
public boolean isLayoutCacheable()Returnstrueto allow the portlet to be cached within the layout.- Specified by:
isLayoutCacheablein interfacePortlet- Returns:
trueif the portlet can be cached within the layout
-
isMaximizeEdit
public boolean isMaximizeEdit()Returnstrueif the portlet goes into the maximized state when the user goes into the edit mode.- Specified by:
isMaximizeEditin interfacePortlet- Returns:
trueif the portlet goes into the maximized state when the user goes into the edit mode
-
isMaximizeHelp
public boolean isMaximizeHelp()Returnstrueif the portlet goes into the maximized state when the user goes into the help mode.- Specified by:
isMaximizeHelpin interfacePortlet- Returns:
trueif the portlet goes into the maximized state when the user goes into the help mode
-
isPartialActionServeResource
public boolean isPartialActionServeResource()Returnstrueif 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:
isPartialActionServeResourcein interfacePortlet- Returns:
trueif 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()Returnstrueif the portlet goes into the pop up state when the user goes into the print mode.- Specified by:
isPopUpPrintin interfacePortlet- Returns:
trueif the portlet goes into the pop up state when the user goes into the print mode
-
isPortletDependencyCssEnabled
public boolean isPortletDependencyCssEnabled()Returnstrueif 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:
isPortletDependencyCssEnabledin interfacePortlet- Returns:
trueif the specified CSS resource dependencies are to be referenced in the page's header
-
isPortletDependencyJavaScriptEnabled
public boolean isPortletDependencyJavaScriptEnabled()Returnstrueif 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:
isPortletDependencyJavaScriptEnabledin interfacePortlet- Returns:
trueif the specified JavaScript resource dependencies are to be referenced in the page's header
-
isPreferencesCompanyWide
public boolean isPreferencesCompanyWide()Returnstrueif preferences are shared across the entire company.- Specified by:
isPreferencesCompanyWidein interfacePortlet- Returns:
trueif preferences are shared across the entire company
-
isPreferencesOwnedByGroup
public boolean isPreferencesOwnedByGroup()Returnstrueif preferences are owned by the group when the portlet is shown in a group layout. Returnsfalseif preferences are owned by the user at all times.- Specified by:
isPreferencesOwnedByGroupin interfacePortlet- Returns:
trueif preferences are owned by the group when the portlet is shown in a group layout;falseif preferences are owned by the user at all times.
-
isPreferencesUniquePerLayout
public boolean isPreferencesUniquePerLayout()Returnstrueif preferences are unique per layout.- Specified by:
isPreferencesUniquePerLayoutin interfacePortlet- Returns:
trueif preferences are unique per layout
-
isPrivateRequestAttributes
public boolean isPrivateRequestAttributes()Returnstrueif the portlet does not share request attributes with the portal or portlets from another WAR.- Specified by:
isPrivateRequestAttributesin interfacePortlet- Returns:
trueif the portlet does not share request attributes with the portal or portlets from another WAR
-
isPrivateSessionAttributes
public boolean isPrivateSessionAttributes()Returnstrueif the portlet does not share session attributes with the portal.- Specified by:
isPrivateSessionAttributesin interfacePortlet- Returns:
trueif the portlet does not share session attributes with the portal
-
isReady
public boolean isReady()Returnstrueif the portlet is ready to be used. -
isRequiresNamespacedParameters
public boolean isRequiresNamespacedParameters()Returnstrueif the portlet will only process namespaced parameters.- Specified by:
isRequiresNamespacedParametersin interfacePortlet- Returns:
trueif the portlet will only process namespaced parameters
-
isRestoreCurrentView
public boolean isRestoreCurrentView()Returnstrueif the portlet restores to the current view from the maximized state.- Specified by:
isRestoreCurrentViewin interfacePortlet- Returns:
trueif the portlet restores to the current view from the maximized state
-
isScopeable
public boolean isScopeable()Returnstrueif the portlet supports scoping of data.- Specified by:
isScopeablein interfacePortlet- Returns:
trueif the portlet supports scoping of data
-
isShowPortletAccessDenied
public boolean isShowPortletAccessDenied()Returnstrueif users are shown that they do not have access to the portlet.- Specified by:
isShowPortletAccessDeniedin interfacePortlet- Returns:
trueif users are shown that they do not have access to the portlet
-
isShowPortletInactive
public boolean isShowPortletInactive()Returnstrueif users are shown that the portlet is inactive.- Specified by:
isShowPortletInactivein interfacePortlet- Returns:
trueif users are shown that the portlet is inactive
-
isSinglePageApplication
public boolean isSinglePageApplication()Returnstrueif the portlet uses Single Page Application.- Specified by:
isSinglePageApplicationin interfacePortlet- Returns:
trueif the portlet uses Single Page Application
-
isStatic
public boolean isStatic()Returnstrueif the portlet is a static portlet that is cannot be moved. -
isStaticEnd
public boolean isStaticEnd()Returnstrueif the portlet is a static portlet at the end of a list of portlets.- Specified by:
isStaticEndin interfacePortlet- Returns:
trueif the portlet is a static portlet at the end of a list of portlets
-
isStaticStart
public boolean isStaticStart()Returnstrueif the portlet is a static portlet at the start of a list of portlets.- Specified by:
isStaticStartin interfacePortlet- Returns:
trueif the portlet is a static portlet at the start of a list of portlets
-
isSystem
public boolean isSystem()Returnstrueif the portlet is a system portlet that a user cannot manually add to their page. -
isUndeployedPortlet
public boolean isUndeployedPortlet()Returnstrueif the portlet is an undeployed portlet.- Specified by:
isUndeployedPortletin interfacePortlet- Returns:
trueif the portlet is a placeholder of an undeployed portlet
-
isUseDefaultTemplate
public boolean isUseDefaultTemplate()Returnstrueif the portlet uses the default template.- Specified by:
isUseDefaultTemplatein interfacePortlet- Returns:
trueif 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:PersistedModelUpdates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.- Specified by:
persistin interfacePersistedModel
-
setActionTimeout
public void setActionTimeout(int actionTimeout) Sets the action timeout of the portlet.- Specified by:
setActionTimeoutin interfacePortlet- Parameters:
actionTimeout- the action timeout of the portlet
-
setActionURLRedirect
public void setActionURLRedirect(boolean actionURLRedirect) Set totrueif an action URL for this portlet should cause an auto redirect.- Specified by:
setActionURLRedirectin 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:
setActivein interfacePortletModel- Parameters:
active- the active of this portlet
-
setAddDefaultResource
public void setAddDefaultResource(boolean addDefaultResource) Set totrueif default resources for the portlet are added to a page.- Specified by:
setAddDefaultResourcein 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 totrueif the portlet can be displayed via Ajax.- Specified by:
setAjaxablein interfacePortlet- Parameters:
ajaxable- boolean value for whether the portlet can be displayed via Ajax
-
setApplicationTypes
Sets the application types of the portlet.- Specified by:
setApplicationTypesin 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:
setAssetRendererFactoryClassesin interfacePortlet- Parameters:
assetRendererFactoryClasses- the names of the classes that represent asset types associated with the portlet
-
setAsyncSupported
public void setAsyncSupported(boolean asyncSupported) Set totrueif the portlet supports asynchronous processing in resource requests.- Specified by:
setAsyncSupportedin 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:
setAutopropagatedParametersin 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:
setCategoryNamesin interfacePortlet- Parameters:
categoryNames- the category names of the portlet
-
setCompanyId
public void setCompanyId(long companyId) Sets the company ID of this portlet.- Specified by:
setCompanyIdin interfacePortletModel- Specified by:
setCompanyIdin interfaceShardedModel- Parameters:
companyId- the company ID of this portlet
-
setConfigurationActionClass
Sets the configuration action class of the portlet.- Specified by:
setConfigurationActionClassin 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:
setControlPanelEntryCategoryin 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:
setControlPanelEntryClassin 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:
setControlPanelEntryWeightin 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:
setCssClassWrapperin 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:
setCustomAttributesDisplayClassesin 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:
setDefaultPluginSettingin interfacePortlet- Parameters:
pluginSetting- the plugin setting
-
setDefaultPreferences
Sets the default preferences of the portlet.- Specified by:
setDefaultPreferencesin interfacePortlet- Parameters:
defaultPreferences- the default preferences of the portlet
-
setDisplayName
Sets the display name of the portlet.- Specified by:
setDisplayNamein interfacePortlet- Parameters:
displayName- the display name of the portlet
-
setExpCache
Sets expiration cache of the portlet.- Specified by:
setExpCachein interfacePortlet- Parameters:
expCache- expiration cache of the portlet
-
setFriendlyURLMapperClass
Sets the name of the friendly URL mapper class of the portlet.- Specified by:
setFriendlyURLMapperClassin 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:
setFriendlyURLMappingin 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:
setFriendlyURLRoutesin 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:
setHeaderPortalCssin 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:
setHeaderPortalJavaScriptin 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:
setHeaderPortletCssin 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:
setHeaderPortletJavaScriptin 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:
setHeaderRequestAttributePrefixesin 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:
setHeaderTimeoutin 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:
setIdin interfacePortletModel- Parameters:
id- the ID of this portlet
-
setInclude
public void setInclude(boolean include) Set totrueto include the portlet and make it available to be made active.- Specified by:
setIncludein 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:
setIndexerClassesin 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:
setInitParamsin interfacePortlet- Parameters:
initParams- the init parameters of the portlet
-
setInstanceable
public void setInstanceable(boolean instanceable) Set totrueif the portlet can be added multiple times to a layout.- Specified by:
setInstanceablein interfacePortlet- Parameters:
instanceable- boolean value for whether the portlet can be added multiple times to a layout
-
setLayoutCacheable
public void setLayoutCacheable(boolean layoutCacheable) Set totrueto allow the portlet to be cached within the layout.- Specified by:
setLayoutCacheablein interfacePortlet- Parameters:
layoutCacheable- boolean value for whether the portlet can be cached within the layout
-
setMaximizeEdit
public void setMaximizeEdit(boolean maximizeEdit) Set totrueif the portlet goes into the maximized state when the user goes into the edit mode.- Specified by:
setMaximizeEditin 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 totrueif the portlet goes into the maximized state when the user goes into the help mode.- Specified by:
setMaximizeHelpin 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:
setMultipartFileSizeThresholdin interfacePortlet- Parameters:
multipartFileSizeThreshold- the maximum size of buffered bytes before storing occurs
-
setMultipartLocation
Sets the directory for storing uploaded files.- Specified by:
setMultipartLocationin 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:
setMultipartMaxFileSizein 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:
setMultipartMaxRequestSizein 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:
setMvccVersionin interfaceMVCCModel- Specified by:
setMvccVersionin interfacePortletModel- Parameters:
mvccVersion- the mvcc version of this portlet
-
setOpenSearchClass
Sets the name of the open search class of the portlet.- Specified by:
setOpenSearchClassin interfacePortlet- Parameters:
openSearchClass- the name of the open search class of the portlet
-
setParentStrutsPath
Sets the parent struts path of the portlet.- Specified by:
setParentStrutsPathin 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:
setPartialActionServeResourcein 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:
setPermissionPropagatorClassin interfacePortlet
-
setPluginPackage
Sets this portlet's plugin package.- Specified by:
setPluginPackagein interfacePortlet- Parameters:
pluginPackage- this portlet's plugin package
-
setPopMessageListenerClass
Sets the name of the POP message listener class of the portlet.- Specified by:
setPopMessageListenerClassin 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:
setPopUpPrintin 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:
setPortletAppin interfacePortlet- Parameters:
portletApp- this portlet's application
-
setPortletClass
Sets the name of the portlet class of the portlet.- Specified by:
setPortletClassin interfacePortlet- Parameters:
portletClass- the name of the portlet class of the portlet
-
setPortletConfigurationListenerClass
- Specified by:
setPortletConfigurationListenerClassin interfacePortlet
-
setPortletDataHandlerClass
Sets the name of the portlet data handler class of the portlet.- Specified by:
setPortletDataHandlerClassin 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:
setPortletDependencyCssEnabledin 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:
setPortletDependencyJavaScriptEnabledin 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:
setPortletFiltersin interfacePortlet- Parameters:
portletFilters- the filters of the portlet
-
setPortletId
Sets the portlet ID of this portlet.- Specified by:
setPortletIdin interfacePortletModel- Parameters:
portletId- the portlet ID of this portlet
-
setPortletInfo
Sets the portlet info of the portlet.- Specified by:
setPortletInfoin interfacePortlet- Parameters:
portletInfo- the portlet info of the portlet
-
setPortletLayoutListenerClass
Sets the name of the portlet layout listener class of the portlet.- Specified by:
setPortletLayoutListenerClassin interfacePortlet- Parameters:
portletLayoutListenerClass- the name of the portlet layout listener class of the portlet
-
setPortletModes
Sets the portlet modes of the portlet.- Specified by:
setPortletModesin interfacePortlet- Parameters:
portletModes- the portlet modes of the portlet
-
setPortletName
Sets the name of the portlet.- Specified by:
setPortletNamein interfacePortlet- Parameters:
portletName- the name of the portlet
-
setPortletURLClass
Sets the name of the portlet URL class of the portlet.- Specified by:
setPortletURLClassin interfacePortlet- Parameters:
portletURLClass- the name of the portlet URL class of the portlet
-
setPreferencesCompanyWide
public void setPreferencesCompanyWide(boolean preferencesCompanyWide) Set totrueif preferences are shared across the entire company.- Specified by:
setPreferencesCompanyWidein interfacePortlet- Parameters:
preferencesCompanyWide- boolean value for whether preferences are shared across the entire company
-
setPreferencesOwnedByGroup
public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup) Set totrueif preferences are owned by the group when the portlet is shown in a group layout. Set tofalseif preferences are owned by the user at all times.- Specified by:
setPreferencesOwnedByGroupin 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 totrueif preferences are unique per layout.- Specified by:
setPreferencesUniquePerLayoutin 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:
setPreferencesValidatorin 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:
setPrimaryKeyin interfacePortletModel- Parameters:
primaryKey- the primary key of this portlet
-
setPrivateRequestAttributes
public void setPrivateRequestAttributes(boolean privateRequestAttributes) Set totrueif the portlet does not share request attributes with the portal or portlets from another WAR.- Specified by:
setPrivateRequestAttributesin 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 totrueif the portlet does not share session attributes with the portal.- Specified by:
setPrivateSessionAttributesin 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:
setProcessingEventsin interfacePortlet- Parameters:
processingEvents- the processing events of the portlet
-
setPublicRenderParameters
Sets the public render parameters of the portlet.- Specified by:
setPublicRenderParametersin interfacePortlet- Parameters:
publicRenderParameters- the public render parameters of the portlet
-
setPublishingEvents
Sets the publishing events of the portlet.- Specified by:
setPublishingEventsin interfacePortlet- Parameters:
publishingEvents- the publishing events of the portlet
-
setReady
public void setReady(boolean ready) Set totrueif the portlet is ready to be used. -
setRenderTimeout
public void setRenderTimeout(int renderTimeout) Sets the render timeout of the portlet.- Specified by:
setRenderTimeoutin interfacePortlet- Parameters:
renderTimeout- the render timeout of the portlet
-
setRenderWeight
public void setRenderWeight(int renderWeight) Sets the render weight of the portlet.- Specified by:
setRenderWeightin interfacePortlet- Parameters:
renderWeight- int value for the render weight of the portlet
-
setRequiresNamespacedParameters
public void setRequiresNamespacedParameters(boolean requiresNamespacedParameters) Set totrueif the portlet will only process namespaced parameters.- Specified by:
setRequiresNamespacedParametersin interfacePortlet- Parameters:
requiresNamespacedParameters- boolean value for whether the portlet will only process namespaced parameters
-
setResourceBundle
Sets the resource bundle of the portlet.- Specified by:
setResourceBundlein interfacePortlet- Parameters:
resourceBundle- the resource bundle of the portlet
-
setRestoreCurrentView
public void setRestoreCurrentView(boolean restoreCurrentView) Set totrueif the portlet restores to the current view from the maximized state.- Specified by:
setRestoreCurrentViewin 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:
setRoleMappersin interfacePortlet- Parameters:
roleMappers- the role mappers of the portlet
-
setRoles
Sets the roles of this portlet.- Specified by:
setRolesin interfacePortletModel- Parameters:
roles- the roles of this portlet
-
setRolesArray
Sets an array of required roles of the portlet.- Specified by:
setRolesArrayin interfacePortlet- Parameters:
rolesArray- an array of required roles of the portlet
-
setSchedulerEntries
Sets the scheduler entries of the portlet.- Specified by:
setSchedulerEntriesin interfacePortlet- Parameters:
schedulerEntries- the scheduler entries of the portlet
-
setScopeable
public void setScopeable(boolean scopeable) Set totrueif the portlet supports scoping of data.- Specified by:
setScopeablein interfacePortlet- Parameters:
scopeable- boolean value for whether or not the the portlet supports scoping of data
-
setShowPortletAccessDenied
public void setShowPortletAccessDenied(boolean showPortletAccessDenied) Set totrueif users are shown that they do not have access to the portlet.- Specified by:
setShowPortletAccessDeniedin 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 totrueif users are shown that the portlet is inactive.- Specified by:
setShowPortletInactivein interfacePortlet- Parameters:
showPortletInactive- boolean value for whether users are shown that the portlet is inactive
-
setSinglePageApplication
public void setSinglePageApplication(boolean singlePageApplication) Set totrueif the portlet uses Single Page Application.- Specified by:
setSinglePageApplicationin 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:
setSocialActivityInterpreterClassesin 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:
setSocialRequestInterpreterClassin 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:
setStagedModelDataHandlerClassesin 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 totrueif the portlet is a static portlet that is cannot be moved. -
setStaticStart
public void setStaticStart(boolean staticPortletStart) Set totrueif the portlet is a static portlet at the start of a list of portlets.- Specified by:
setStaticStartin 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:
setStrutsPathin interfacePortlet- Parameters:
strutsPath- the struts path of the portlet
-
setSupportedLocales
Sets the supported locales of the portlet.- Specified by:
setSupportedLocalesin interfacePortlet- Parameters:
supportedLocales- the supported locales of the portlet
-
setSystem
public void setSystem(boolean system) Set totrueif 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:
setTemplateHandlerClassin 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:
setTrashHandlerClassesin interfacePortlet- Parameters:
trashHandlerClasses- the names of the classes that represent trash handlers associated with the portlet
-
setUndeployedPortlet
public void setUndeployedPortlet(boolean undeployedPortlet) Set totrueif the portlet is an undeployed portlet.- Specified by:
setUndeployedPortletin interfacePortlet- Parameters:
undeployedPortlet- boolean value for whether the portlet is an undeployed portlet
-
setUnlinkedRoles
Sets the unlinked roles of the portlet.- Specified by:
setUnlinkedRolesin interfacePortlet- Parameters:
unlinkedRoles- the unlinked roles of the portlet
-
setURLEncoderClass
Sets the name of the URL encoder class of the portlet.- Specified by:
setURLEncoderClassin interfacePortlet- Parameters:
urlEncoderClass- the name of the URL encoder class of the portlet
-
setUseDefaultTemplate
public void setUseDefaultTemplate(boolean useDefaultTemplate) Set totrueif the portlet uses the default template.- Specified by:
setUseDefaultTemplatein 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:
setUserNotificationDefinitionsin 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:
setUserNotificationHandlerClassesin 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:
setUserPrincipalStrategyin interfacePortlet- Parameters:
userPrincipalStrategy- the user principal strategy of the portlet
-
setVirtualPath
Sets the virtual path of the portlet.- Specified by:
setVirtualPathin interfacePortlet- Parameters:
virtualPath- the virtual path of the portlet
-
setWebDAVStorageClass
Sets the name of the WebDAV storage class of the portlet.- Specified by:
setWebDAVStorageClassin 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:
setWebDAVStorageTokenin interfacePortlet- Parameters:
webDAVStorageToken- the name of the WebDAV storage token of the portlet
-
setWindowStates
Sets the window states of the portlet.- Specified by:
setWindowStatesin 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:
setWorkflowHandlerClassesin 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:
setXmlRpcMethodClassin interfacePortlet- Parameters:
xmlRpcMethodClass- the name of the XML-RPC method class of the portlet
-
toXmlString
- Specified by:
toXmlStringin interfacePortletModel
-
unsetReady
public void unsetReady()- Specified by:
unsetReadyin interfacePortlet
-
wrap
- Specified by:
wrapin classBaseModelWrapper<Portlet>
-