public class PortletWrapper extends BaseModelWrapper<Portlet> implements ModelWrapper<Portlet>, Portlet
This class is a wrapper for Portlet.
Portlet,
Serialized FormmodelID_ACCESSOR, PORTLET_ID_ACCESSOR| Constructor and Description |
|---|
PortletWrapper(Portlet portlet) |
| Modifier and Type | Method and Description |
|---|---|
void |
addApplicationType(ApplicationType applicationType)
Adds an application type.
|
void |
addPortletDependency(PortletDependency portletDependency)
Adds a portlet CSS/JavaScript resource dependency.
|
void |
addProcessingEvent(QName processingEvent)
Adds a processing event.
|
void |
addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
Adds a public render parameter.
|
void |
addPublishingEvent(QName publishingEvent)
Adds a publishing event.
|
void |
addSchedulerEntry(SchedulerEntry schedulerEntry)
Adds a scheduler entry.
|
Object |
clone()
Creates and returns a copy of this object.
|
int |
compareTo(Portlet portlet)
Compares this portlet to the specified object.
|
boolean |
equals(Object obj)
Checks whether this portlet is equal to the specified object.
|
int |
getActionTimeout()
Returns the action timeout of the portlet.
|
boolean |
getActionURLRedirect()
Returns
true if an action URL for this portlet should cause
an auto redirect. |
boolean |
getActive()
Returns the active of this portlet.
|
boolean |
getAddDefaultResource()
Returns
true if default resources for the portlet are added
to a page. |
boolean |
getAjaxable()
Returns
true if the portlet can be displayed via Ajax. |
Set<String> |
getAllPortletModes()
Returns the portlet modes of the portlet.
|
Set<String> |
getAllWindowStates()
Returns the window states of the portlet.
|
Set<ApplicationType> |
getApplicationTypes()
Returns the application types of the portlet.
|
List<String> |
getAssetRendererFactoryClasses()
Returns the names of the classes that represent asset types associated
with the portlet.
|
List<AssetRendererFactory<?>> |
getAssetRendererFactoryInstances()
Returns the asset type instances of the portlet.
|
List<String> |
getAtomCollectionAdapterClasses()
Returns the names of the classes that represent atom collection adapters
associated with the portlet.
|
List<AtomCollectionAdapter<?>> |
getAtomCollectionAdapterInstances()
Returns the atom collection adapter instances of the portlet.
|
Set<String> |
getAutopropagatedParameters()
Returns the names of the parameters that will be automatically propagated
through the portlet.
|
Portlet |
getClonedInstance(String portletId)
Returns
true if the portlet is found in a WAR file. |
long |
getCompanyId()
Returns the company ID of this portlet.
|
String |
getConfigurationActionClass()
Returns the configuration action class of the portlet.
|
ConfigurationAction |
getConfigurationActionInstance()
Returns the configuration action instance of the portlet.
|
String |
getContextName()
Returns the servlet context name of the portlet.
|
String |
getContextPath()
Returns the servlet context path of the portlet.
|
String |
getControlPanelEntryCategory()
Returns the name of the category of the Control Panel where the portlet
will be shown.
|
String |
getControlPanelEntryClass()
Returns the name of the class that will control when the portlet will be
shown in the Control Panel.
|
ControlPanelEntry |
getControlPanelEntryInstance()
Returns an instance of the class that will control when the portlet will
be shown in the Control Panel.
|
double |
getControlPanelEntryWeight()
Returns the relative weight of the portlet with respect to the other
portlets in the same category of the Control Panel.
|
String |
getCssClassWrapper()
Returns the name of the CSS class that will be injected in the DIV that
wraps this portlet.
|
List<String> |
getCustomAttributesDisplayClasses()
Returns the names of the classes that represent custom attribute displays
associated with the portlet.
|
List<CustomAttributesDisplay> |
getCustomAttributesDisplayInstances()
Returns the custom attribute display instances of the portlet.
|
PluginSetting |
getDefaultPluginSetting()
Get the default plugin settings of the portlet.
|
String |
getDefaultPreferences()
Returns the default preferences of the portlet.
|
String |
getDisplayName()
Returns the display name of the portlet.
|
Integer |
getExpCache()
Returns expiration cache of the portlet.
|
String |
getFacebookIntegration()
Deprecated.
As of Judson (7.1.x), with no direct replacement
|
List<String> |
getFooterPortalCss()
Returns a list of CSS files that will be referenced from the page's
footer relative to the portal's context path.
|
List<String> |
getFooterPortalJavaScript()
Returns a list of JavaScript files that will be referenced from the
page's footer relative to the portal's context path.
|
List<String> |
getFooterPortletCss()
Returns a list of CSS files that will be referenced from the page's
footer relative to the portlet's context path.
|
List<String> |
getFooterPortletJavaScript()
Returns a list of JavaScript files that will be referenced from the
page's footer relative to the portlet's context path.
|
String |
getFriendlyURLMapperClass()
Returns the name of the friendly URL mapper class of the portlet.
|
FriendlyURLMapper |
getFriendlyURLMapperInstance()
Returns the friendly URL mapper instance of the portlet.
|
String |
getFriendlyURLMapping()
Returns the name of the friendly URL mapping of the portlet.
|
String |
getFriendlyURLRoutes()
Returns the class loader resource path to the friendly URL routes of the
portlet.
|
List<String> |
getHeaderPortalCss()
Returns a list of CSS files that will be referenced from the page's
header relative to the portal's context path.
|
List<String> |
getHeaderPortalJavaScript()
Returns a list of JavaScript files that will be referenced from the
page's header relative to the portal's context path.
|
List<String> |
getHeaderPortletCss()
Returns a list of CSS files that will be referenced from the page's
header relative to the portlet's context path.
|
List<String> |
getHeaderPortletJavaScript()
Returns a list of JavaScript files that will be referenced from the
page's header relative to the portlet's context path.
|
List<String> |
getHeaderRequestAttributePrefixes()
Returns a list of attribute name prefixes that will be referenced after
the HEADER_PHASE completes for each portlet.
|
int |
getHeaderTimeout()
Returns the header timeout of the portlet.
|
String |
getIcon()
Returns the icon of the portlet.
|
long |
getId()
Returns the ID of this portlet.
|
boolean |
getInclude()
Returns
true to include the portlet and make it available to
be made active. |
List<String> |
getIndexerClasses()
Returns the names of the classes that represent indexers associated with
the portlet.
|
List<Indexer<?>> |
getIndexerInstances()
Returns the indexer instances of the portlet.
|
Map<String,String> |
getInitParams()
Returns the init parameters of the portlet.
|
boolean |
getInstanceable()
Returns
true if the portlet can be added multiple times to a
layout. |
String |
getInstanceId()
Returns the instance ID of the portlet.
|
boolean |
getLayoutCacheable()
Returns
true to allow the portlet to be cached within the
layout. |
boolean |
getMaximizeEdit()
Returns
true if the portlet goes into the maximized state
when the user goes into the edit mode. |
boolean |
getMaximizeHelp()
Returns
true if the portlet goes into the maximized state
when the user goes into the help mode. |
Map<String,Object> |
getModelAttributes() |
int |
getMultipartFileSizeThreshold()
Returns the maximum size of buffered bytes before storing occurs.
|
String |
getMultipartLocation()
Returns the directory for storing uploaded files.
|
long |
getMultipartMaxFileSize()
Returns the maximum number of bytes permitted for an uploaded file.
|
long |
getMultipartMaxRequestSize()
Returns the maximum number of bytes permitted for a multipart request.
|
long |
getMvccVersion()
Returns the mvcc version of this portlet.
|
String |
getOpenSearchClass()
Returns the name of the open search class of the portlet.
|
OpenSearch |
getOpenSearchInstance()
Returns the indexer instance of the portlet.
|
String |
getParentStrutsPath()
Returns the parent struts path of the portlet.
|
String |
getPermissionPropagatorClass()
Returns the name of the permission propagator class of the portlet.
|
PermissionPropagator |
getPermissionPropagatorInstance()
Returns the permission propagator instance of the portlet.
|
String |
getPluginId()
Returns the plugin ID of the portlet.
|
PluginPackage |
getPluginPackage()
Returns this portlet's plugin package.
|
String |
getPluginType()
Returns the plugin type of the portlet.
|
String |
getPollerProcessorClass()
Returns the name of the poller processor class of the portlet.
|
PollerProcessor |
getPollerProcessorInstance()
Returns the poller processor instance of the portlet.
|
String |
getPopMessageListenerClass()
Returns the name of the POP message listener class of the portlet.
|
MessageListener |
getPopMessageListenerInstance()
Returns the POP message listener instance of the portlet.
|
boolean |
getPopUpPrint()
Returns
true if the portlet goes into the pop up state when
the user goes into the print mode. |
PortletApp |
getPortletApp()
Returns this portlet's application.
|
String |
getPortletClass()
Returns the name of the portlet class of the portlet.
|
String |
getPortletDataHandlerClass()
Returns the name of the portlet data handler class of the portlet.
|
PortletDataHandler |
getPortletDataHandlerInstance()
Returns the portlet data handler instance of the portlet.
|
List<PortletDependency> |
getPortletDependencies()
Returns the portlet's CSS/JavaScript resource dependencies.
|
Map<String,PortletFilter> |
getPortletFilters()
Returns the filters of the portlet.
|
String |
getPortletId()
Returns the portlet ID of this portlet.
|
PortletInfo |
getPortletInfo()
Returns the portlet info of the portlet.
|
String |
getPortletLayoutListenerClass()
Returns the name of the portlet layout listener class of the portlet.
|
PortletLayoutListener |
getPortletLayoutListenerInstance()
Returns the portlet layout listener instance of the portlet.
|
Map<String,Set<String>> |
getPortletModes()
Returns the portlet modes of the portlet.
|
String |
getPortletName()
Returns the name of the portlet.
|
String |
getPortletURLClass()
Returns the name of the portlet URL class of the portlet.
|
boolean |
getPreferencesCompanyWide()
Returns
true if preferences are shared across the entire
company. |
boolean |
getPreferencesOwnedByGroup()
Returns
true if preferences are owned by the group when the
portlet is shown in a group layout. |
boolean |
getPreferencesUniquePerLayout()
Returns
true if preferences are unique per layout. |
String |
getPreferencesValidator()
Returns the name of the preferences validator class of the portlet.
|
long |
getPrimaryKey()
Returns the primary key of this portlet.
|
boolean |
getPrivateRequestAttributes()
Returns
true if the portlet does not share request
attributes with the portal or portlets from another WAR. |
boolean |
getPrivateSessionAttributes()
Returns
true if the portlet does not share session
attributes with the portal. |
QName |
getProcessingEvent(String uri,
String localPart)
Returns the processing event from a namespace URI and a local part.
|
Set<QName> |
getProcessingEvents()
Returns the processing events of the portlet.
|
PublicRenderParameter |
getPublicRenderParameter(String identifier)
Returns the public render parameter from an identifier.
|
PublicRenderParameter |
getPublicRenderParameter(String uri,
String localPart)
Returns the spublic render parameter from a namespace URI and a local
part.
|
Set<PublicRenderParameter> |
getPublicRenderParameters()
Returns the public render parameters of the portlet.
|
Set<QName> |
getPublishingEvents()
Returns the publishing events of the portlet.
|
boolean |
getReady()
Returns
true if the portlet is ready to be used. |
int |
getRenderTimeout()
Returns the render timeout of the portlet.
|
int |
getRenderWeight()
Returns the render weight of the portlet.
|
String |
getResourceBundle()
Returns the resource bundle of the portlet.
|
boolean |
getRestoreCurrentView()
Returns
true if the portlet restores to the current view
from the maximized state. |
Map<String,String> |
getRoleMappers()
Returns the role mappers of the portlet.
|
String |
getRoles()
Returns the roles of this portlet.
|
String[] |
getRolesArray()
Returns an array of required roles of the portlet.
|
Portlet |
getRootPortlet()
Returns the root portlet of this portlet instance.
|
String |
getRootPortletId()
Returns the root portlet ID of the portlet.
|
List<SchedulerEntry> |
getSchedulerEntries()
Returns the scheduler entries of the portlet.
|
boolean |
getScopeable()
Returns
true if the portlet supports scoping of data. |
boolean |
getShowPortletAccessDenied()
Returns
true if users are shown that they do not have access
to the portlet. |
boolean |
getShowPortletInactive()
Returns
true if users are shown that the portlet is
inactive. |
boolean |
getSinglePageApplication()
Returns
true if the portlet uses Single Page Application. |
List<String> |
getSocialActivityInterpreterClasses()
Returns the names of the classes that represent social activity
interpreters associated with the portlet.
|
List<SocialActivityInterpreter> |
getSocialActivityInterpreterInstances()
Returns the social activity interpreter instances of the portlet.
|
String |
getSocialRequestInterpreterClass()
Returns the name of the social request interpreter class of the portlet.
|
SocialRequestInterpreter |
getSocialRequestInterpreterInstance()
Returns the name of the social request interpreter instance of the
portlet.
|
List<String> |
getStagedModelDataHandlerClasses()
Returns the names of the classes that represent staged model data
handlers associated with the portlet.
|
List<StagedModelDataHandler<?>> |
getStagedModelDataHandlerInstances()
Returns the staged model data handler instances of the portlet.
|
boolean |
getStatic()
Returns
true if the portlet is a static portlet that is
cannot be moved. |
boolean |
getStaticEnd()
Returns
true if the portlet is a static portlet at the end
of a list of portlets. |
String |
getStaticResourcePath()
Returns the path for static resources served by this portlet.
|
boolean |
getStaticStart()
Returns
true if the portlet is a static portlet at the start
of a list of portlets. |
String |
getStrutsPath()
Returns the struts path of the portlet.
|
Set<String> |
getSupportedLocales()
Returns the supported locales of the portlet.
|
boolean |
getSystem()
Returns
true if the portlet is a system portlet that a user
cannot manually add to their page. |
String |
getTemplateHandlerClass()
Returns the name of the template handler class of the portlet.
|
TemplateHandler |
getTemplateHandlerInstance()
Returns the template handler instance of the portlet.
|
long |
getTimestamp()
Returns the timestamp of the portlet.
|
List<String> |
getTrashHandlerClasses()
Returns the names of the classes that represent trash handlers associated
with the portlet.
|
List<TrashHandler> |
getTrashHandlerInstances()
Returns the trash handler instances of the portlet.
|
boolean |
getUndeployedPortlet()
Returns
true if the portlet is an undeployed portlet. |
Set<String> |
getUnlinkedRoles()
Returns the unlinked roles of the portlet.
|
String |
getURLEncoderClass()
Returns the name of the URL encoder class of the portlet.
|
URLEncoder |
getURLEncoderInstance()
Returns the URL encoder instance of the portlet.
|
boolean |
getUseDefaultTemplate()
Returns
true if the portlet uses the default template. |
long |
getUserId()
Returns the user ID of the portlet.
|
String |
getUserNotificationDefinitions()
Returns the class loader resource path to the use notification
definitions of the portlet.
|
List<String> |
getUserNotificationHandlerClasses()
Returns the names of the classes that represent user notification
handlers associated with the portlet.
|
List<UserNotificationHandler> |
getUserNotificationHandlerInstances()
Returns the user notification handler instances of the portlet.
|
String |
getUserPrincipalStrategy()
Returns the user principal strategy of the portlet.
|
String |
getVirtualPath()
Returns the virtual path of the portlet.
|
String |
getWebDAVStorageClass()
Returns the name of the WebDAV storage class of the portlet.
|
WebDAVStorage |
getWebDAVStorageInstance()
Returns the name of the WebDAV storage instance of the portlet.
|
String |
getWebDAVStorageToken()
Returns the name of the WebDAV storage token of the portlet.
|
Map<String,Set<String>> |
getWindowStates()
Returns the window states of the portlet.
|
List<String> |
getWorkflowHandlerClasses()
Returns the names of the classes that represent workflow handlers
associated with the portlet.
|
List<WorkflowHandler<?>> |
getWorkflowHandlerInstances()
Returns the workflow handler instances of the portlet.
|
String |
getXmlRpcMethodClass()
Returns the name of the XML-RPC method class of the portlet.
|
Method |
getXmlRpcMethodInstance()
Returns the name of the XML-RPC method instance of the portlet.
|
boolean |
hasAddPortletPermission(long userId)
Returns
true if the user has the permission to add the
portlet to a layout. |
boolean |
hasFooterPortalCss() |
boolean |
hasFooterPortalJavaScript() |
boolean |
hasFooterPortletCss() |
boolean |
hasFooterPortletJavaScript() |
int |
hashCode() |
boolean |
hasHeaderPortalCss() |
boolean |
hasHeaderPortalJavaScript() |
boolean |
hasHeaderPortletCss() |
boolean |
hasHeaderPortletJavaScript() |
boolean |
hasMultipleMimeTypes()
Returns
true if the portlet supports more than one mime
type. |
boolean |
hasPortletMode(String mimeType,
PortletMode portletMode)
Returns
true if the portlet supports the specified mime type
and portlet mode. |
boolean |
hasRoleWithName(String roleName)
Returns
true if the portlet has a role with the specified
name. |
boolean |
hasWindowState(String mimeType,
WindowState windowState)
Returns
true if the portlet supports the specified mime type
and window state. |
boolean |
isActionURLRedirect()
Returns
true if an action URL for this portlet should cause
an auto redirect. |
boolean |
isActive()
Returns
true if this portlet is active. |
boolean |
isAddDefaultResource()
Returns
true if default resources for the portlet are added
to a page. |
boolean |
isAjaxable()
Returns
true if the portlet can be displayed via Ajax. |
boolean |
isAsyncSupported()
Returns
true if the portlet supports asynchronous processing
in resource requests. |
boolean |
isFullPageDisplayable() |
boolean |
isInclude()
Returns
true to include the portlet and make it available to
be made active. |
boolean |
isInstanceable()
Returns
true if the portlet can be added multiple times to a
layout. |
boolean |
isLayoutCacheable()
Returns
true to allow the portlet to be cached within the
layout. |
boolean |
isMaximizeEdit()
Returns
true if the portlet goes into the maximized state
when the user goes into the edit mode. |
boolean |
isMaximizeHelp()
Returns
true if the portlet goes into the maximized state
when the user goes into the help mode. |
boolean |
isPartialActionServeResource()
Returns
true if the portlet's
serveResource(ResourceRequest,ResourceResponse) method
should be invoked during a partial action triggered by a different
portlet on the same portal page. |
boolean |
isPopUpPrint()
Returns
true if the portlet goes into the pop up state when
the user goes into the print mode. |
boolean |
isPortletDependencyCssEnabled()
Returns
true if the CSS resource dependencies specified in
portlet.xml, @Dependency,
HeaderResponse.addDependency(String, String,
String), or HeaderResponse.addDependency(String,
String, String, String) are to be referenced in the page's header. |
boolean |
isPortletDependencyJavaScriptEnabled()
Returns
true if the JavaScript resource dependencies
specified in portlet.xml, @Dependency, HeaderResponse.addDependency(String, String, String), or
HeaderResponse.addDependency(String, String, String,
String) are to be referenced in the page's header. |
boolean |
isPreferencesCompanyWide()
Returns
true if preferences are shared across the entire
company. |
boolean |
isPreferencesOwnedByGroup()
Returns
true if preferences are owned by the group when the
portlet is shown in a group layout. |
boolean |
isPreferencesUniquePerLayout()
Returns
true if preferences are unique per layout. |
boolean |
isPrivateRequestAttributes()
Returns
true if the portlet does not share request
attributes with the portal or portlets from another WAR. |
boolean |
isPrivateSessionAttributes()
Returns
true if the portlet does not share session
attributes with the portal. |
boolean |
isReady()
Returns
true if the portlet is ready to be used. |
boolean |
isRequiresNamespacedParameters()
Returns
true if the portlet will only process namespaced
parameters. |
boolean |
isRestoreCurrentView()
Returns
true if the portlet restores to the current view
from the maximized state. |
boolean |
isScopeable()
Returns
true if the portlet supports scoping of data. |
boolean |
isShowPortletAccessDenied()
Returns
true if users are shown that they do not have access
to the portlet. |
boolean |
isShowPortletInactive()
Returns
true if users are shown that the portlet is
inactive. |
boolean |
isSinglePageApplication()
Returns
true if the portlet uses Single Page Application. |
boolean |
isStatic()
Returns
true if the portlet is a static portlet that is
cannot be moved. |
boolean |
isStaticEnd()
Returns
true if the portlet is a static portlet at the end
of a list of portlets. |
boolean |
isStaticStart()
Returns
true if the portlet is a static portlet at the start
of a list of portlets. |
boolean |
isSystem()
Returns
true if the portlet is a system portlet that a user
cannot manually add to their page. |
boolean |
isUndeployedPortlet()
Returns
true if the portlet is an undeployed portlet. |
boolean |
isUseDefaultTemplate()
Returns
true if the portlet uses the default template. |
void |
linkRoles()
Link the role names set in portlet.xml with the Liferay roles set in
liferay-portlet.xml.
|
void |
persist()
NOTE FOR DEVELOPERS:
Never modify or reference this class directly.
|
void |
setActionTimeout(int actionTimeout)
Sets the action timeout of the portlet.
|
void |
setActionURLRedirect(boolean actionURLRedirect)
Set to
true if an action URL for this portlet should cause
an auto redirect. |
void |
setActive(boolean active)
Sets whether this portlet is active.
|
void |
setAddDefaultResource(boolean addDefaultResource)
Set to
true if default resources for the portlet are added
to a page. |
void |
setAjaxable(boolean ajaxable)
Set to
true if the portlet can be displayed via Ajax. |
void |
setApplicationTypes(Set<ApplicationType> applicationTypes)
Sets the application types of the portlet.
|
void |
setAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses)
Sets the names of the classes that represent asset types associated with
the portlet.
|
void |
setAsyncSupported(boolean asyncSupported)
Set to
true if the portlet supports asynchronous processing
in resource requests. |
void |
setAtomCollectionAdapterClasses(List<String> atomCollectionAdapterClasses)
Sets the names of the classes that represent atom collection adapters
associated with the portlet.
|
void |
setAutopropagatedParameters(Set<String> autopropagatedParameters)
Sets the names of the parameters that will be automatically propagated
through the portlet.
|
void |
setCompanyId(long companyId)
Sets the company ID of this portlet.
|
void |
setConfigurationActionClass(String configurationActionClass)
Sets the configuration action class of the portlet.
|
void |
setControlPanelEntryCategory(String controlPanelEntryCategory)
Set the name of the category of the Control Panel where the portlet will
be shown.
|
void |
setControlPanelEntryClass(String controlPanelEntryClass)
Sets the name of the class that will control when the portlet will be
shown in the Control Panel.
|
void |
setControlPanelEntryWeight(double controlPanelEntryWeight)
Sets the relative weight of the portlet with respect to the other
portlets in the same category of the Control Panel.
|
void |
setCssClassWrapper(String cssClassWrapper)
Sets the name of the CSS class that will be injected in the DIV that
wraps this portlet.
|
void |
setCustomAttributesDisplayClasses(List<String> customAttributesDisplayClasses)
Sets the names of the classes that represent custom attribute displays
associated with the portlet.
|
void |
setDefaultPluginSetting(PluginSetting pluginSetting)
Sets the default plugin settings of the portlet.
|
void |
setDefaultPreferences(String defaultPreferences)
Sets the default preferences of the portlet.
|
void |
setDisplayName(String displayName)
Sets the display name of the portlet.
|
void |
setExpCache(Integer expCache)
Sets expiration cache of the portlet.
|
void |
setFacebookIntegration(String facebookIntegration)
Deprecated.
As of Judson (7.1.x), with no direct replacement
|
void |
setFooterPortalCss(List<String> footerPortalCss)
Sets a list of CSS files that will be referenced from the page's footer
relative to the portal's context path.
|
void |
setFooterPortalJavaScript(List<String> footerPortalJavaScript)
Sets a list of JavaScript files that will be referenced from the page's
footer relative to the portal's context path.
|
void |
setFooterPortletCss(List<String> footerPortletCss)
Sets a list of CSS files that will be referenced from the page's footer
relative to the portlet's context path.
|
void |
setFooterPortletJavaScript(List<String> footerPortletJavaScript)
Sets a list of JavaScript files that will be referenced from the page's
footer relative to the portlet's context path.
|
void |
setFriendlyURLMapperClass(String friendlyURLMapperClass)
Sets the name of the friendly URL mapper class of the portlet.
|
void |
setFriendlyURLMapping(String friendlyURLMapping)
Sets the name of the friendly URL mapping of the portlet.
|
void |
setFriendlyURLRoutes(String friendlyURLRoutes)
Sets the class loader resource path to the friendly URL routes of the
portlet.
|
void |
setHeaderPortalCss(List<String> headerPortalCss)
Sets a list of CSS files that will be referenced from the page's header
relative to the portal's context path.
|
void |
setHeaderPortalJavaScript(List<String> headerPortalJavaScript)
Sets a list of JavaScript files that will be referenced from the page's
header relative to the portal's context path.
|
void |
setHeaderPortletCss(List<String> headerPortletCss)
Sets a list of CSS files that will be referenced from the page's header
relative to the portlet's context path.
|
void |
setHeaderPortletJavaScript(List<String> headerPortletJavaScript)
Sets a list of JavaScript files that will be referenced from the page's
header relative to the portlet's context path.
|
void |
setHeaderRequestAttributePrefixes(List<String> headerRequestAttributePrefixes)
Sets a list of attribute name prefixes that will be referenced after the
HEADER_PHASE completes for each portlet.
|
void |
setHeaderTimeout(int headerTimeout)
Sets the header timeout of the portlet.
|
void |
setIcon(String icon)
Sets the icon of the portlet.
|
void |
setId(long id)
Sets the ID of this portlet.
|
void |
setInclude(boolean include)
Set to
true to include the portlet and make it available to
be made active. |
void |
setIndexerClasses(List<String> indexerClasses)
Sets the names of the classes that represent indexers associated with the
portlet.
|
void |
setInitParams(Map<String,String> initParams)
Sets the init parameters of the portlet.
|
void |
setInstanceable(boolean instanceable)
Set to
true if the portlet can be added multiple times to a
layout. |
void |
setLayoutCacheable(boolean layoutCacheable)
Set to
true to allow the portlet to be cached within the
layout. |
void |
setMaximizeEdit(boolean maximizeEdit)
Set to
true if the portlet goes into the maximized state
when the user goes into the edit mode. |
void |
setMaximizeHelp(boolean maximizeHelp)
Set to
true if the portlet goes into the maximized state
when the user goes into the help mode. |
void |
setModelAttributes(Map<String,Object> attributes) |
void |
setMultipartFileSizeThreshold(int multipartFileSizeThreshold)
Sets the maximum size of buffered bytes before storing occurs.
|
void |
setMultipartLocation(String multipartLocation)
Sets the directory for storing uploaded files.
|
void |
setMultipartMaxFileSize(long multipartMaxFileSize)
Sets the maximum number of bytes permitted for an uploaded file.
|
void |
setMultipartMaxRequestSize(long multipartMaxRequestSize)
Sets the maximum number of bytes permitted for a multipart request.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this portlet.
|
void |
setOpenSearchClass(String openSearchClass)
Sets the name of the open search class of the portlet.
|
void |
setParentStrutsPath(String parentStrutsPath)
Sets the parent struts path of the portlet.
|
void |
setPartialActionServeResource(boolean partialActionServeResource)
Sets whether the portlet's serve resource should be invoked during a
partial action triggered by a different portlet on the same portal page.
|
void |
setPermissionPropagatorClass(String permissionPropagatorClass)
Sets the name of the permission propagator class of the portlet.
|
void |
setPluginPackage(PluginPackage pluginPackage)
Sets this portlet's plugin package.
|
void |
setPollerProcessorClass(String pollerProcessorClass)
Sets the name of the poller processor class of the portlet.
|
void |
setPopMessageListenerClass(String popMessageListenerClass)
Sets the name of the POP message listener class of the portlet.
|
void |
setPopUpPrint(boolean popUpPrint)
Sets whether the portlet goes into the pop up state when the user goes
into the print mode.
|
void |
setPortletApp(PortletApp portletApp)
Sets this portlet's application.
|
void |
setPortletClass(String portletClass)
Sets the name of the portlet class of the portlet.
|
void |
setPortletDataHandlerClass(String portletDataHandlerClass)
Sets the name of the portlet data handler class of the portlet.
|
void |
setPortletDependencyCssEnabled(boolean portletDependencyCssEnabled)
Sets whether the CSS resource dependencies specified in
portlet.xml, @Dependency,
HeaderResponse.addDependency(String, String,
String), or HeaderResponse.addDependency(String,
String, String, String) are to be referenced in the page's header. |
void |
setPortletDependencyJavaScriptEnabled(boolean portletDependencyJavaScriptEnabled)
Sets whether the JavaScript resource dependencies specified in
portlet.xml, @Dependency,
HeaderResponse.addDependency(String, String,
String), or HeaderResponse.addDependency(String,
String, String, String) are to be referenced in the page's header. |
void |
setPortletFilters(Map<String,PortletFilter> portletFilters)
Sets the filters of the portlet.
|
void |
setPortletId(String portletId)
Sets the portlet ID of this portlet.
|
void |
setPortletInfo(PortletInfo portletInfo)
Sets the portlet info of the portlet.
|
void |
setPortletLayoutListenerClass(String portletLayoutListenerClass)
Sets the name of the portlet layout listener class of the portlet.
|
void |
setPortletModes(Map<String,Set<String>> portletModes)
Sets the portlet modes of the portlet.
|
void |
setPortletName(String portletName)
Sets the name of the portlet.
|
void |
setPortletURLClass(String portletURLClass)
Sets the name of the portlet URL class of the portlet.
|
void |
setPreferencesCompanyWide(boolean preferencesCompanyWide)
Set to
true if preferences are shared across the entire
company. |
void |
setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
Set to
true if preferences are owned by the group when the
portlet is shown in a group layout. |
void |
setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
Set to
true if preferences are unique per layout. |
void |
setPreferencesValidator(String preferencesValidator)
Sets the name of the preferences validator class of the portlet.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this portlet.
|
void |
setPrivateRequestAttributes(boolean privateRequestAttributes)
Set to
true if the portlet does not share request attributes
with the portal or portlets from another WAR. |
void |
setPrivateSessionAttributes(boolean privateSessionAttributes)
Set to
true if the portlet does not share session attributes
with the portal. |
void |
setProcessingEvents(Set<QName> processingEvents)
Sets the processing events of the portlet.
|
void |
setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)
Sets the public render parameters of the portlet.
|
void |
setPublishingEvents(Set<QName> publishingEvents)
Sets the publishing events of the portlet.
|
void |
setReady(boolean ready)
Set to
true if the portlet is ready to be used. |
void |
setRenderTimeout(int renderTimeout)
Sets the render timeout of the portlet.
|
void |
setRenderWeight(int renderWeight)
Sets the render weight of the portlet.
|
void |
setRequiresNamespacedParameters(boolean requiresNamespacedParameters)
Set to
true if the portlet will only process namespaced
parameters. |
void |
setResourceBundle(String resourceBundle)
Sets the resource bundle of the portlet.
|
void |
setRestoreCurrentView(boolean restoreCurrentView)
Set to
true if the portlet restores to the current view from
the maximized state. |
void |
setRoleMappers(Map<String,String> roleMappers)
Sets the role mappers of the portlet.
|
void |
setRoles(String roles)
Sets the roles of this portlet.
|
void |
setRolesArray(String[] rolesArray)
Sets an array of required roles of the portlet.
|
void |
setSchedulerEntries(List<SchedulerEntry> schedulerEntries)
Sets the scheduler entries of the portlet.
|
void |
setScopeable(boolean scopeable)
Set to
true if the portlet supports scoping of data. |
void |
setShowPortletAccessDenied(boolean showPortletAccessDenied)
Set to
true if users are shown that they do not have access
to the portlet. |
void |
setShowPortletInactive(boolean showPortletInactive)
Set to
true if users are shown that the portlet is inactive. |
void |
setSinglePageApplication(boolean singlePageApplication)
Set to
true if the portlet uses Single Page Application. |
void |
setSocialActivityInterpreterClasses(List<String> socialActivityInterpreterClasses)
Sets the names of the classes that represent social activity interpreters
associated with the portlet.
|
void |
setSocialRequestInterpreterClass(String socialRequestInterpreterClass)
Sets the name of the social request interpreter class of the portlet.
|
void |
setStagedModelDataHandlerClasses(List<String> stagedModelDataHandlerClasses)
Sets the names of the classes that represent staged model data handlers
associated with the portlet.
|
void |
setStatic(boolean staticPortlet)
Set to
true if the portlet is a static portlet that is
cannot be moved. |
void |
setStaticStart(boolean staticPortletStart)
Set to
true if the portlet is a static portlet at the start
of a list of portlets. |
void |
setStrutsPath(String strutsPath)
Sets the struts path of the portlet.
|
void |
setSupportedLocales(Set<String> supportedLocales)
Sets the supported locales of the portlet.
|
void |
setSystem(boolean system)
Set to
true if the portlet is a system portlet that a user
cannot manually add to their page. |
void |
setTemplateHandlerClass(String templateHandlerClass)
Sets the name of the template handler class of the portlet.
|
void |
setTrashHandlerClasses(List<String> trashHandlerClasses)
Sets the names of the classes that represent trash handlers associated to
the portlet.
|
void |
setUndeployedPortlet(boolean undeployedPortlet)
Set to
true if the portlet is an undeployed portlet. |
void |
setUnlinkedRoles(Set<String> unlinkedRoles)
Sets the unlinked roles of the portlet.
|
void |
setURLEncoderClass(String urlEncoderClass)
Sets the name of the URL encoder class of the portlet.
|
void |
setUseDefaultTemplate(boolean useDefaultTemplate)
Set to
true if the portlet uses the default template. |
void |
setUserNotificationDefinitions(String userNotificationDefinitions)
Sets the class loader resource path to the user notification definitions
of the portlet.
|
void |
setUserNotificationHandlerClasses(List<String> userNotificationHandlerClasses)
Sets the names of the classes that represent user notification handlers
associated with the portlet.
|
void |
setUserPrincipalStrategy(String userPrincipalStrategy)
Sets the user principal strategy of the portlet.
|
void |
setVirtualPath(String virtualPath)
Sets the virtual path of the portlet.
|
void |
setWebDAVStorageClass(String webDAVStorageClass)
Sets the name of the WebDAV storage class of the portlet.
|
void |
setWebDAVStorageToken(String webDAVStorageToken)
Sets the name of the WebDAV storage token of the portlet.
|
void |
setWindowStates(Map<String,Set<String>> windowStates)
Sets the window states of the portlet.
|
void |
setWorkflowHandlerClasses(List<String> workflowHandlerClasses)
Sets the names of the classes that represent workflow handlers associated
to the portlet.
|
void |
setXmlRpcMethodClass(String xmlRpcMethodClass)
Sets the name of the XML-RPC method class of the portlet.
|
void |
unsetReady() |
protected PortletWrapper |
wrap(Portlet portlet) |
getExpandoBridge, getModelClass, getModelClassName, getPrimaryKeyObj, getWrappedModel, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlStringgetWrappedModelgetExpandoBridge, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlStringgetModelClass, getModelClassNamepublic PortletWrapper(Portlet portlet)
public Map<String,Object> getModelAttributes()
getModelAttributes in interface BaseModel<Portlet>public void setModelAttributes(Map<String,Object> attributes)
setModelAttributes in interface BaseModel<Portlet>public void addApplicationType(ApplicationType applicationType)
addApplicationType in interface PortletapplicationType - an application typepublic void addPortletDependency(PortletDependency portletDependency)
addPortletDependency in interface PortletportletDependency - the portlet CSS/JavaScript resource dependencypublic void addProcessingEvent(QName processingEvent)
addProcessingEvent in interface Portletpublic void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
addPublicRenderParameter in interface PortletpublicRenderParameter - a public render parameterpublic void addPublishingEvent(QName publishingEvent)
addPublishingEvent in interface Portletpublic void addSchedulerEntry(SchedulerEntry schedulerEntry)
addSchedulerEntry in interface Portletpublic Object clone()
public int compareTo(Portlet portlet)
compareTo in interface PortletcompareTo in interface Comparable<Portlet>compareTo in class BaseModelWrapper<Portlet>portlet - the portlet to compare this portlet againstpublic boolean equals(Object obj)
equals in interface Portletequals in class BaseModelWrapper<Portlet>obj - the object to compare this portlet againsttrue if the portlet is equal to the specified objectpublic int getActionTimeout()
getActionTimeout in interface Portletpublic boolean getActionURLRedirect()
true if an action URL for this portlet should cause
an auto redirect.getActionURLRedirect in interface Portlettrue if an action URL for this portlet should cause
an auto redirectpublic boolean getActive()
getActive in interface PortletModelpublic boolean getAddDefaultResource()
true if default resources for the portlet are added
to a page.getAddDefaultResource in interface Portlettrue if default resources for the portlet are added
to a pagepublic boolean getAjaxable()
true if the portlet can be displayed via Ajax.getAjaxable in interface Portlettrue if the portlet can be displayed via Ajaxpublic Set<String> getAllPortletModes()
getAllPortletModes in interface Portletpublic Set<String> getAllWindowStates()
getAllWindowStates in interface Portletpublic Set<ApplicationType> getApplicationTypes()
getApplicationTypes in interface Portletpublic List<String> getAssetRendererFactoryClasses()
getAssetRendererFactoryClasses in interface Portletpublic List<AssetRendererFactory<?>> getAssetRendererFactoryInstances()
getAssetRendererFactoryInstances in interface Portletpublic List<String> getAtomCollectionAdapterClasses()
getAtomCollectionAdapterClasses in interface Portletpublic List<AtomCollectionAdapter<?>> getAtomCollectionAdapterInstances()
getAtomCollectionAdapterInstances in interface Portletpublic Set<String> getAutopropagatedParameters()
getAutopropagatedParameters in interface Portletpublic Portlet getClonedInstance(String portletId)
true if the portlet is found in a WAR file.getClonedInstance in interface PortletportletId - the cloned instance portlet IDpublic long getCompanyId()
getCompanyId in interface PortletModelgetCompanyId in interface ShardedModelpublic String getConfigurationActionClass()
getConfigurationActionClass in interface Portletpublic ConfigurationAction getConfigurationActionInstance()
getConfigurationActionInstance in interface Portletpublic String getContextName()
getContextName in interface Portletpublic String getContextPath()
getContextPath in interface Portletpublic String getControlPanelEntryCategory()
getControlPanelEntryCategory in interface Portletpublic String getControlPanelEntryClass()
getControlPanelEntryClass in interface Portletpublic ControlPanelEntry getControlPanelEntryInstance()
getControlPanelEntryInstance in interface Portletpublic double getControlPanelEntryWeight()
getControlPanelEntryWeight in interface Portletpublic String getCssClassWrapper()
getCssClassWrapper in interface Portletpublic List<String> getCustomAttributesDisplayClasses()
getCustomAttributesDisplayClasses in interface Portletpublic List<CustomAttributesDisplay> getCustomAttributesDisplayInstances()
getCustomAttributesDisplayInstances in interface Portletpublic PluginSetting getDefaultPluginSetting()
getDefaultPluginSetting in interface Portletpublic String getDefaultPreferences()
getDefaultPreferences in interface Portletpublic String getDisplayName()
getDisplayName in interface Portletpublic Integer getExpCache()
getExpCache in interface Portlet@Deprecated public String getFacebookIntegration()
getFacebookIntegration in interface Portletpublic List<String> getFooterPortalCss()
getFooterPortalCss in interface Portletpublic List<String> getFooterPortalJavaScript()
getFooterPortalJavaScript in interface Portletpublic List<String> getFooterPortletCss()
getFooterPortletCss in interface Portletpublic List<String> getFooterPortletJavaScript()
getFooterPortletJavaScript in interface Portletpublic String getFriendlyURLMapperClass()
getFriendlyURLMapperClass in interface Portletpublic FriendlyURLMapper getFriendlyURLMapperInstance()
getFriendlyURLMapperInstance in interface Portletpublic String getFriendlyURLMapping()
getFriendlyURLMapping in interface Portletpublic String getFriendlyURLRoutes()
getFriendlyURLRoutes in interface Portletpublic List<String> getHeaderPortalCss()
getHeaderPortalCss in interface Portletpublic List<String> getHeaderPortalJavaScript()
getHeaderPortalJavaScript in interface Portletpublic List<String> getHeaderPortletCss()
getHeaderPortletCss in interface Portletpublic List<String> getHeaderPortletJavaScript()
getHeaderPortletJavaScript in interface Portletpublic List<String> getHeaderRequestAttributePrefixes()
getHeaderRequestAttributePrefixes in interface Portletpublic int getHeaderTimeout()
getHeaderTimeout in interface Portletpublic String getIcon()
public long getId()
getId in interface PortletModelpublic boolean getInclude()
true to include the portlet and make it available to
be made active.getInclude in interface Portlettrue to include the portlet and make it available to
be made activepublic List<String> getIndexerClasses()
getIndexerClasses in interface Portletpublic List<Indexer<?>> getIndexerInstances()
getIndexerInstances in interface Portletpublic Map<String,String> getInitParams()
getInitParams in interface Portletpublic boolean getInstanceable()
true if the portlet can be added multiple times to a
layout.getInstanceable in interface Portlettrue if the portlet can be added multiple times to a
layoutpublic String getInstanceId()
getInstanceId in interface Portletpublic boolean getLayoutCacheable()
true to allow the portlet to be cached within the
layout.getLayoutCacheable in interface Portlettrue if the portlet can be cached within the layoutpublic boolean getMaximizeEdit()
true if the portlet goes into the maximized state
when the user goes into the edit mode.getMaximizeEdit in interface Portlettrue if the portlet goes into the maximized state
when the user goes into the edit modepublic boolean getMaximizeHelp()
true if the portlet goes into the maximized state
when the user goes into the help mode.getMaximizeHelp in interface Portlettrue if the portlet goes into the maximized state
when the user goes into the help modepublic int getMultipartFileSizeThreshold()
getMultipartFileSizeThreshold in interface Portletpublic String getMultipartLocation()
getMultipartLocation in interface Portletpublic long getMultipartMaxFileSize()
getMultipartMaxFileSize in interface Portletpublic long getMultipartMaxRequestSize()
getMultipartMaxRequestSize in interface Portletpublic long getMvccVersion()
getMvccVersion in interface MVCCModelgetMvccVersion in interface PortletModelpublic String getOpenSearchClass()
getOpenSearchClass in interface Portletpublic OpenSearch getOpenSearchInstance()
getOpenSearchInstance in interface Portletpublic String getParentStrutsPath()
getParentStrutsPath in interface Portletpublic String getPermissionPropagatorClass()
getPermissionPropagatorClass in interface Portletpublic PermissionPropagator getPermissionPropagatorInstance()
getPermissionPropagatorInstance in interface Portletpublic String getPluginId()
getPluginId in interface Portletpublic PluginPackage getPluginPackage()
getPluginPackage in interface Portletpublic String getPluginType()
getPluginType in interface Portletpublic String getPollerProcessorClass()
getPollerProcessorClass in interface Portletpublic PollerProcessor getPollerProcessorInstance()
getPollerProcessorInstance in interface Portletpublic String getPopMessageListenerClass()
getPopMessageListenerClass in interface Portletpublic MessageListener getPopMessageListenerInstance()
getPopMessageListenerInstance in interface Portletpublic boolean getPopUpPrint()
true if the portlet goes into the pop up state when
the user goes into the print mode.getPopUpPrint in interface Portlettrue if the portlet goes into the pop up state when
the user goes into the print modepublic PortletApp getPortletApp()
getPortletApp in interface Portletpublic String getPortletClass()
getPortletClass in interface Portletpublic String getPortletDataHandlerClass()
getPortletDataHandlerClass in interface Portletpublic PortletDataHandler getPortletDataHandlerInstance()
getPortletDataHandlerInstance in interface Portletpublic List<PortletDependency> getPortletDependencies()
getPortletDependencies in interface Portletpublic Map<String,PortletFilter> getPortletFilters()
getPortletFilters in interface Portletpublic String getPortletId()
getPortletId in interface PortletModelpublic PortletInfo getPortletInfo()
getPortletInfo in interface Portletpublic String getPortletLayoutListenerClass()
getPortletLayoutListenerClass in interface Portletpublic PortletLayoutListener getPortletLayoutListenerInstance()
getPortletLayoutListenerInstance in interface Portletpublic Map<String,Set<String>> getPortletModes()
getPortletModes in interface Portletpublic String getPortletName()
getPortletName in interface Portletpublic String getPortletURLClass()
getPortletURLClass in interface Portletpublic boolean getPreferencesCompanyWide()
true if preferences are shared across the entire
company.getPreferencesCompanyWide in interface Portlettrue if preferences are shared across the entire
companypublic boolean getPreferencesOwnedByGroup()
true if preferences are owned by the group when the
portlet is shown in a group layout. Returns false if
preferences are owned by the user at all times.getPreferencesOwnedByGroup in interface Portlettrue if preferences are owned by the group when the
portlet is shown in a group layout; false if
preferences are owned by the user at all times.public boolean getPreferencesUniquePerLayout()
true if preferences are unique per layout.getPreferencesUniquePerLayout in interface Portlettrue if preferences are unique per layoutpublic String getPreferencesValidator()
getPreferencesValidator in interface Portletpublic long getPrimaryKey()
getPrimaryKey in interface PortletModelpublic boolean getPrivateRequestAttributes()
true if the portlet does not share request
attributes with the portal or portlets from another WAR.getPrivateRequestAttributes in interface Portlettrue if the portlet does not share request
attributes with the portal or portlets from another WARpublic boolean getPrivateSessionAttributes()
true if the portlet does not share session
attributes with the portal.getPrivateSessionAttributes in interface Portlettrue if the portlet does not share session
attributes with the portalpublic QName getProcessingEvent(String uri, String localPart)
getProcessingEvent in interface Portleturi - the namespace URIlocalPart - the local partpublic Set<QName> getProcessingEvents()
getProcessingEvents in interface Portletpublic PublicRenderParameter getPublicRenderParameter(String identifier)
getPublicRenderParameter in interface Portletidentifier - the identifierpublic PublicRenderParameter getPublicRenderParameter(String uri, String localPart)
getPublicRenderParameter in interface Portleturi - the namespace URIlocalPart - the local partpublic Set<PublicRenderParameter> getPublicRenderParameters()
getPublicRenderParameters in interface Portletpublic Set<QName> getPublishingEvents()
getPublishingEvents in interface Portletpublic boolean getReady()
true if the portlet is ready to be used.public int getRenderTimeout()
getRenderTimeout in interface Portletpublic int getRenderWeight()
getRenderWeight in interface Portletpublic String getResourceBundle()
getResourceBundle in interface Portletpublic boolean getRestoreCurrentView()
true if the portlet restores to the current view
from the maximized state.getRestoreCurrentView in interface Portlettrue if the portlet restores to the current view
from the maximized statepublic Map<String,String> getRoleMappers()
getRoleMappers in interface Portletpublic String getRoles()
getRoles in interface PortletModelpublic String[] getRolesArray()
getRolesArray in interface Portletpublic Portlet getRootPortlet()
getRootPortlet in interface Portletpublic String getRootPortletId()
getRootPortletId in interface Portletpublic List<SchedulerEntry> getSchedulerEntries()
getSchedulerEntries in interface Portletpublic boolean getScopeable()
true if the portlet supports scoping of data.getScopeable in interface Portlettrue if the portlet supports scoping of datapublic boolean getShowPortletAccessDenied()
true if users are shown that they do not have access
to the portlet.getShowPortletAccessDenied in interface Portlettrue if users are shown that they do not have access
to the portletpublic boolean getShowPortletInactive()
true if users are shown that the portlet is
inactive.getShowPortletInactive in interface Portlettrue if users are shown that the portlet is inactivepublic boolean getSinglePageApplication()
true if the portlet uses Single Page Application.getSinglePageApplication in interface Portlettrue if the portlet uses Single Page Applicationpublic List<String> getSocialActivityInterpreterClasses()
getSocialActivityInterpreterClasses in interface Portletpublic List<SocialActivityInterpreter> getSocialActivityInterpreterInstances()
getSocialActivityInterpreterInstances in interface Portletpublic String getSocialRequestInterpreterClass()
getSocialRequestInterpreterClass in interface Portletpublic SocialRequestInterpreter getSocialRequestInterpreterInstance()
getSocialRequestInterpreterInstance in interface Portletpublic List<String> getStagedModelDataHandlerClasses()
getStagedModelDataHandlerClasses in interface Portletpublic List<StagedModelDataHandler<?>> getStagedModelDataHandlerInstances()
getStagedModelDataHandlerInstances in interface Portletpublic boolean getStatic()
true if the portlet is a static portlet that is
cannot be moved.public boolean getStaticEnd()
true if the portlet is a static portlet at the end
of a list of portlets.getStaticEnd in interface Portlettrue if the portlet is a static portlet at the end
of a list of portletspublic String getStaticResourcePath()
getStaticResourcePath in interface Portletpublic boolean getStaticStart()
true if the portlet is a static portlet at the start
of a list of portlets.getStaticStart in interface Portlettrue if the portlet is a static portlet at the start
of a list of portletspublic String getStrutsPath()
getStrutsPath in interface Portletpublic Set<String> getSupportedLocales()
getSupportedLocales in interface Portletpublic boolean getSystem()
true if the portlet is a system portlet that a user
cannot manually add to their page.public String getTemplateHandlerClass()
getTemplateHandlerClass in interface Portletpublic TemplateHandler getTemplateHandlerInstance()
getTemplateHandlerInstance in interface Portletpublic long getTimestamp()
getTimestamp in interface Portletpublic List<String> getTrashHandlerClasses()
getTrashHandlerClasses in interface Portletpublic List<TrashHandler> getTrashHandlerInstances()
getTrashHandlerInstances in interface Portletpublic boolean getUndeployedPortlet()
true if the portlet is an undeployed portlet.getUndeployedPortlet in interface Portlettrue if the portlet is a placeholder of an
undeployed portletpublic Set<String> getUnlinkedRoles()
getUnlinkedRoles in interface Portletpublic String getURLEncoderClass()
getURLEncoderClass in interface Portletpublic URLEncoder getURLEncoderInstance()
getURLEncoderInstance in interface Portletpublic boolean getUseDefaultTemplate()
true if the portlet uses the default template.getUseDefaultTemplate in interface Portlettrue if the portlet uses the default templatepublic long getUserId()
public String getUserNotificationDefinitions()
getUserNotificationDefinitions in interface Portletpublic List<String> getUserNotificationHandlerClasses()
getUserNotificationHandlerClasses in interface Portletpublic List<UserNotificationHandler> getUserNotificationHandlerInstances()
getUserNotificationHandlerInstances in interface Portletpublic String getUserPrincipalStrategy()
getUserPrincipalStrategy in interface Portletpublic String getVirtualPath()
getVirtualPath in interface Portletpublic String getWebDAVStorageClass()
getWebDAVStorageClass in interface Portletpublic WebDAVStorage getWebDAVStorageInstance()
getWebDAVStorageInstance in interface Portletpublic String getWebDAVStorageToken()
getWebDAVStorageToken in interface Portletpublic Map<String,Set<String>> getWindowStates()
getWindowStates in interface Portletpublic List<String> getWorkflowHandlerClasses()
getWorkflowHandlerClasses in interface Portletpublic List<WorkflowHandler<?>> getWorkflowHandlerInstances()
getWorkflowHandlerInstances in interface Portletpublic String getXmlRpcMethodClass()
getXmlRpcMethodClass in interface Portletpublic Method getXmlRpcMethodInstance()
getXmlRpcMethodInstance in interface Portletpublic boolean hasAddPortletPermission(long userId)
true if the user has the permission to add the
portlet to a layout.hasAddPortletPermission in interface PortletuserId - the primary key of the usertrue if the user has the permission to add the
portlet to a layoutpublic boolean hasFooterPortalCss()
hasFooterPortalCss in interface Portletpublic boolean hasFooterPortalJavaScript()
hasFooterPortalJavaScript in interface Portletpublic boolean hasFooterPortletCss()
hasFooterPortletCss in interface Portletpublic boolean hasFooterPortletJavaScript()
hasFooterPortletJavaScript in interface Portletpublic int hashCode()
hashCode in interface PortlethashCode in class BaseModelWrapper<Portlet>public boolean hasHeaderPortalCss()
hasHeaderPortalCss in interface Portletpublic boolean hasHeaderPortalJavaScript()
hasHeaderPortalJavaScript in interface Portletpublic boolean hasHeaderPortletCss()
hasHeaderPortletCss in interface Portletpublic boolean hasHeaderPortletJavaScript()
hasHeaderPortletJavaScript in interface Portletpublic boolean hasMultipleMimeTypes()
true if the portlet supports more than one mime
type.hasMultipleMimeTypes in interface Portlettrue if the portlet supports more than one mime typepublic boolean hasPortletMode(String mimeType,
PortletMode portletMode)
true if the portlet supports the specified mime type
and portlet mode.hasPortletMode in interface PortletmimeType - the mime typeportletMode - the portlet modetrue if the portlet supports the specified mime type
and portlet modepublic boolean hasRoleWithName(String roleName)
true if the portlet has a role with the specified
name.hasRoleWithName in interface PortletroleName - the role nametrue if the portlet has a role with the specified
namepublic boolean hasWindowState(String mimeType,
WindowState windowState)
true if the portlet supports the specified mime type
and window state.hasWindowState in interface PortletmimeType - the mime typewindowState - the window statetrue if the portlet supports the specified mime type
and window statepublic boolean isActionURLRedirect()
true if an action URL for this portlet should cause
an auto redirect.isActionURLRedirect in interface Portlettrue if an action URL for this portlet should cause
an auto redirectpublic boolean isActive()
true if this portlet is active.isActive in interface PortletModeltrue if this portlet is active; false otherwisepublic boolean isAddDefaultResource()
true if default resources for the portlet are added
to a page.isAddDefaultResource in interface Portlettrue if default resources for the portlet are added
to a pagepublic boolean isAjaxable()
true if the portlet can be displayed via Ajax.isAjaxable in interface Portlettrue if the portlet can be displayed via Ajaxpublic boolean isAsyncSupported()
true if the portlet supports asynchronous processing
in resource requests.isAsyncSupported in interface Portlettrue if the portlet supports asynchrounous
processing in resource requestspublic boolean isFullPageDisplayable()
isFullPageDisplayable in interface Portletpublic boolean isInclude()
true to include the portlet and make it available to
be made active.public boolean isInstanceable()
true if the portlet can be added multiple times to a
layout.isInstanceable in interface Portlettrue if the portlet can be added multiple times to a
layoutpublic boolean isLayoutCacheable()
true to allow the portlet to be cached within the
layout.isLayoutCacheable in interface Portlettrue if the portlet can be cached within the layoutpublic boolean isMaximizeEdit()
true if the portlet goes into the maximized state
when the user goes into the edit mode.isMaximizeEdit in interface Portlettrue if the portlet goes into the maximized state
when the user goes into the edit modepublic boolean isMaximizeHelp()
true if the portlet goes into the maximized state
when the user goes into the help mode.isMaximizeHelp in interface Portlettrue if the portlet goes into the maximized state
when the user goes into the help modepublic boolean isPartialActionServeResource()
true if the portlet's
serveResource(ResourceRequest,ResourceResponse) method
should be invoked during a partial action triggered by a different
portlet on the same portal page.isPartialActionServeResource in interface Portlettrue if the portlet's
serveResource(ResourceRequest,ResourceResponse)
method should be invoked during a partial action triggered by a
different portlet on the same portal pagepublic boolean isPopUpPrint()
true if the portlet goes into the pop up state when
the user goes into the print mode.isPopUpPrint in interface Portlettrue if the portlet goes into the pop up state when
the user goes into the print modepublic boolean isPortletDependencyCssEnabled()
true if the CSS resource dependencies specified in
portlet.xml, @Dependency,
HeaderResponse.addDependency(String, String,
String), or HeaderResponse.addDependency(String,
String, String, String) are to be referenced in the page's header.isPortletDependencyCssEnabled in interface Portlettrue if the specified CSS resource dependencies are
to be referenced in the page's headerpublic boolean isPortletDependencyJavaScriptEnabled()
true if the JavaScript resource dependencies
specified in portlet.xml, @Dependency, HeaderResponse.addDependency(String, String, String), or
HeaderResponse.addDependency(String, String, String,
String) are to be referenced in the page's header.isPortletDependencyJavaScriptEnabled in interface Portlettrue if the specified JavaScript resource
dependencies are to be referenced in the page's headerpublic boolean isPreferencesCompanyWide()
true if preferences are shared across the entire
company.isPreferencesCompanyWide in interface Portlettrue if preferences are shared across the entire
companypublic boolean isPreferencesOwnedByGroup()
true if preferences are owned by the group when the
portlet is shown in a group layout. Returns false if
preferences are owned by the user at all times.isPreferencesOwnedByGroup in interface Portlettrue if preferences are owned by the group when the
portlet is shown in a group layout; false if
preferences are owned by the user at all times.public boolean isPreferencesUniquePerLayout()
true if preferences are unique per layout.isPreferencesUniquePerLayout in interface Portlettrue if preferences are unique per layoutpublic boolean isPrivateRequestAttributes()
true if the portlet does not share request
attributes with the portal or portlets from another WAR.isPrivateRequestAttributes in interface Portlettrue if the portlet does not share request
attributes with the portal or portlets from another WARpublic boolean isPrivateSessionAttributes()
true if the portlet does not share session
attributes with the portal.isPrivateSessionAttributes in interface Portlettrue if the portlet does not share session
attributes with the portalpublic boolean isReady()
true if the portlet is ready to be used.public boolean isRequiresNamespacedParameters()
true if the portlet will only process namespaced
parameters.isRequiresNamespacedParameters in interface Portlettrue if the portlet will only process namespaced
parameterspublic boolean isRestoreCurrentView()
true if the portlet restores to the current view
from the maximized state.isRestoreCurrentView in interface Portlettrue if the portlet restores to the current view
from the maximized statepublic boolean isScopeable()
true if the portlet supports scoping of data.isScopeable in interface Portlettrue if the portlet supports scoping of datapublic boolean isShowPortletAccessDenied()
true if users are shown that they do not have access
to the portlet.isShowPortletAccessDenied in interface Portlettrue if users are shown that they do not have access
to the portletpublic boolean isShowPortletInactive()
true if users are shown that the portlet is
inactive.isShowPortletInactive in interface Portlettrue if users are shown that the portlet is inactivepublic boolean isSinglePageApplication()
true if the portlet uses Single Page Application.isSinglePageApplication in interface Portlettrue if the portlet uses Single Page Applicationpublic boolean isStatic()
true if the portlet is a static portlet that is
cannot be moved.public boolean isStaticEnd()
true if the portlet is a static portlet at the end
of a list of portlets.isStaticEnd in interface Portlettrue if the portlet is a static portlet at the end
of a list of portletspublic boolean isStaticStart()
true if the portlet is a static portlet at the start
of a list of portlets.isStaticStart in interface Portlettrue if the portlet is a static portlet at the start
of a list of portletspublic boolean isSystem()
true if the portlet is a system portlet that a user
cannot manually add to their page.public boolean isUndeployedPortlet()
true if the portlet is an undeployed portlet.isUndeployedPortlet in interface Portlettrue if the portlet is a placeholder of an
undeployed portletpublic boolean isUseDefaultTemplate()
true if the portlet uses the default template.isUseDefaultTemplate in interface Portlettrue if the portlet uses the default templatepublic void linkRoles()
public void persist()
Portlet interface instead.persist in interface PersistedModelpublic void setActionTimeout(int actionTimeout)
setActionTimeout in interface PortletactionTimeout - the action timeout of the portletpublic void setActionURLRedirect(boolean actionURLRedirect)
true if an action URL for this portlet should cause
an auto redirect.setActionURLRedirect in interface PortletactionURLRedirect - boolean value for whether an action URL for this
portlet should cause an auto redirectpublic void setActive(boolean active)
setActive in interface PortletModelactive - the active of this portletpublic void setAddDefaultResource(boolean addDefaultResource)
true if default resources for the portlet are added
to a page.setAddDefaultResource in interface PortletaddDefaultResource - boolean value for whether or not default
resources for the portlet are added to a pagepublic void setAjaxable(boolean ajaxable)
true if the portlet can be displayed via Ajax.setAjaxable in interface Portletajaxable - boolean value for whether the portlet can be displayed
via Ajaxpublic void setApplicationTypes(Set<ApplicationType> applicationTypes)
setApplicationTypes in interface PortletapplicationTypes - the application types of the portletpublic void setAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses)
setAssetRendererFactoryClasses in interface PortletassetRendererFactoryClasses - the names of the classes that
represent asset types associated with the portletpublic void setAsyncSupported(boolean asyncSupported)
true if the portlet supports asynchronous processing
in resource requests.setAsyncSupported in interface PortletasyncSupported - boolean value for whether the portlet supports
asynchronous processing in resource requestspublic void setAtomCollectionAdapterClasses(List<String> atomCollectionAdapterClasses)
setAtomCollectionAdapterClasses in interface PortletatomCollectionAdapterClasses - the names of the classes that
represent atom collection adapters associated with the portletpublic void setAutopropagatedParameters(Set<String> autopropagatedParameters)
setAutopropagatedParameters in interface PortletautopropagatedParameters - the names of the parameters that will be
automatically propagated through the portletpublic void setCompanyId(long companyId)
setCompanyId in interface PortletModelsetCompanyId in interface ShardedModelcompanyId - the company ID of this portletpublic void setConfigurationActionClass(String configurationActionClass)
setConfigurationActionClass in interface PortletconfigurationActionClass - the configuration action class of the
portletpublic void setControlPanelEntryCategory(String controlPanelEntryCategory)
setControlPanelEntryCategory in interface PortletcontrolPanelEntryCategory - the name of the category of the Control
Panel where the portlet will be shownpublic void setControlPanelEntryClass(String controlPanelEntryClass)
setControlPanelEntryClass in interface PortletcontrolPanelEntryClass - the name of the class that will control
when the portlet will be shown in the Control Panelpublic void setControlPanelEntryWeight(double controlPanelEntryWeight)
setControlPanelEntryWeight in interface PortletcontrolPanelEntryWeight - the relative weight of the portlet with
respect to the other portlets in the same category of the Control
Panelpublic void setCssClassWrapper(String cssClassWrapper)
setCssClassWrapper in interface PortletcssClassWrapper - the name of the CSS class that will be injected in
the DIV that wraps this portletpublic void setCustomAttributesDisplayClasses(List<String> customAttributesDisplayClasses)
setCustomAttributesDisplayClasses in interface PortletcustomAttributesDisplayClasses - the names of the classes that
represent custom attribute displays associated with the portletpublic void setDefaultPluginSetting(PluginSetting pluginSetting)
setDefaultPluginSetting in interface PortletpluginSetting - the plugin settingpublic void setDefaultPreferences(String defaultPreferences)
setDefaultPreferences in interface PortletdefaultPreferences - the default preferences of the portletpublic void setDisplayName(String displayName)
setDisplayName in interface PortletdisplayName - the display name of the portletpublic void setExpCache(Integer expCache)
setExpCache in interface PortletexpCache - expiration cache of the portlet@Deprecated public void setFacebookIntegration(String facebookIntegration)
setFacebookIntegration in interface PortletfacebookIntegration - the Facebook integration method of the
portletpublic void setFooterPortalCss(List<String> footerPortalCss)
setFooterPortalCss in interface PortletfooterPortalCss - a list of CSS files that will be referenced from
the page's footer relative to the portal's context pathpublic void setFooterPortalJavaScript(List<String> footerPortalJavaScript)
setFooterPortalJavaScript in interface PortletfooterPortalJavaScript - a list of JavaScript files that will be
referenced from the page's footer relative to the portal's context
pathpublic void setFooterPortletCss(List<String> footerPortletCss)
setFooterPortletCss in interface PortletfooterPortletCss - a list of CSS files that will be referenced from
the page's footer relative to the portlet's context pathpublic void setFooterPortletJavaScript(List<String> footerPortletJavaScript)
setFooterPortletJavaScript in interface PortletfooterPortletJavaScript - a list of JavaScript files that will be
referenced from the page's footer relative to the portlet's
context pathpublic void setFriendlyURLMapperClass(String friendlyURLMapperClass)
setFriendlyURLMapperClass in interface PortletfriendlyURLMapperClass - the name of the friendly URL mapper class
of the portletpublic void setFriendlyURLMapping(String friendlyURLMapping)
setFriendlyURLMapping in interface PortletfriendlyURLMapping - the name of the friendly URL mapping of the
portletpublic void setFriendlyURLRoutes(String friendlyURLRoutes)
setFriendlyURLRoutes in interface PortletfriendlyURLRoutes - the class loader resource path to the friendly
URL routes of the portletpublic void setHeaderPortalCss(List<String> headerPortalCss)
setHeaderPortalCss in interface PortletheaderPortalCss - a list of CSS files that will be referenced from
the page's header relative to the portal's context pathpublic void setHeaderPortalJavaScript(List<String> headerPortalJavaScript)
setHeaderPortalJavaScript in interface PortletheaderPortalJavaScript - a list of JavaScript files that will be
referenced from the page's header relative to the portal's context
pathpublic void setHeaderPortletCss(List<String> headerPortletCss)
setHeaderPortletCss in interface PortletheaderPortletCss - a list of CSS files that will be referenced from
the page's header relative to the portlet's context pathpublic void setHeaderPortletJavaScript(List<String> headerPortletJavaScript)
setHeaderPortletJavaScript in interface PortletheaderPortletJavaScript - a list of JavaScript files that will be
referenced from the page's header relative to the portlet's
context pathpublic void setHeaderRequestAttributePrefixes(List<String> headerRequestAttributePrefixes)
setHeaderRequestAttributePrefixes in interface PortletheaderRequestAttributePrefixes - 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.public void setHeaderTimeout(int headerTimeout)
setHeaderTimeout in interface PortletheaderTimeout - the header timeout of the portletpublic void setIcon(String icon)
public void setId(long id)
setId in interface PortletModelid - the ID of this portletpublic void setInclude(boolean include)
true to include the portlet and make it available to
be made active.setInclude in interface Portletinclude - boolean value for whether to include the portlet and make
it available to be made activepublic void setIndexerClasses(List<String> indexerClasses)
setIndexerClasses in interface PortletindexerClasses - the names of the classes that represent indexers
associated with the portletpublic void setInitParams(Map<String,String> initParams)
setInitParams in interface PortletinitParams - the init parameters of the portletpublic void setInstanceable(boolean instanceable)
true if the portlet can be added multiple times to a
layout.setInstanceable in interface Portletinstanceable - boolean value for whether the portlet can be added
multiple times to a layoutpublic void setLayoutCacheable(boolean layoutCacheable)
true to allow the portlet to be cached within the
layout.setLayoutCacheable in interface PortletlayoutCacheable - boolean value for whether the portlet can be
cached within the layoutpublic void setMaximizeEdit(boolean maximizeEdit)
true if the portlet goes into the maximized state
when the user goes into the edit mode.setMaximizeEdit in interface PortletmaximizeEdit - boolean value for whether the portlet goes into the
maximized state when the user goes into the edit modepublic void setMaximizeHelp(boolean maximizeHelp)
true if the portlet goes into the maximized state
when the user goes into the help mode.setMaximizeHelp in interface PortletmaximizeHelp - boolean value for whether the portlet goes into the
maximized state when the user goes into the help modepublic void setMultipartFileSizeThreshold(int multipartFileSizeThreshold)
setMultipartFileSizeThreshold in interface PortletmultipartFileSizeThreshold - the maximum size of buffered bytes
before storing occurspublic void setMultipartLocation(String multipartLocation)
setMultipartLocation in interface PortletmultipartLocation - the directory for storing uploaded filespublic void setMultipartMaxFileSize(long multipartMaxFileSize)
setMultipartMaxFileSize in interface PortletmultipartMaxFileSize - the maximum number of bytes permitted for an
uploaded filepublic void setMultipartMaxRequestSize(long multipartMaxRequestSize)
setMultipartMaxRequestSize in interface PortletmultipartMaxRequestSize - the maximum number of bytes permitted for
a multipart requestpublic void setMvccVersion(long mvccVersion)
setMvccVersion in interface MVCCModelsetMvccVersion in interface PortletModelmvccVersion - the mvcc version of this portletpublic void setOpenSearchClass(String openSearchClass)
setOpenSearchClass in interface PortletopenSearchClass - the name of the open search class of the portletpublic void setParentStrutsPath(String parentStrutsPath)
setParentStrutsPath in interface PortletparentStrutsPath - the parent struts path of the portletpublic void setPartialActionServeResource(boolean partialActionServeResource)
setPartialActionServeResource in interface PortletpartialActionServeResource - whether the portlet's
serveResource(ResourceRequest,ResourceResponse)
method should be invoked during a partial action triggered by a
different portlet on the same portal pagepublic void setPermissionPropagatorClass(String permissionPropagatorClass)
setPermissionPropagatorClass in interface Portletpublic void setPluginPackage(PluginPackage pluginPackage)
setPluginPackage in interface PortletpluginPackage - this portlet's plugin packagepublic void setPollerProcessorClass(String pollerProcessorClass)
setPollerProcessorClass in interface PortletpollerProcessorClass - the name of the poller processor class of the
portletpublic void setPopMessageListenerClass(String popMessageListenerClass)
setPopMessageListenerClass in interface PortletpopMessageListenerClass - the name of the POP message listener class
of the portletpublic void setPopUpPrint(boolean popUpPrint)
setPopUpPrint in interface PortletpopUpPrint - whether the portlet goes into the pop up state when the
user goes into the print modepublic void setPortletApp(PortletApp portletApp)
setPortletApp in interface PortletportletApp - this portlet's applicationpublic void setPortletClass(String portletClass)
setPortletClass in interface PortletportletClass - the name of the portlet class of the portletpublic void setPortletDataHandlerClass(String portletDataHandlerClass)
setPortletDataHandlerClass in interface PortletportletDataHandlerClass - the name of portlet data handler class of
the portletpublic void setPortletDependencyCssEnabled(boolean portletDependencyCssEnabled)
portlet.xml, @Dependency,
HeaderResponse.addDependency(String, String,
String), or HeaderResponse.addDependency(String,
String, String, String) are to be referenced in the page's header.setPortletDependencyCssEnabled in interface PortletportletDependencyCssEnabled - whether the CSS resource dependencies
that are specified in portlet.xml,public void setPortletDependencyJavaScriptEnabled(boolean portletDependencyJavaScriptEnabled)
portlet.xml, @Dependency,
HeaderResponse.addDependency(String, String,
String), or HeaderResponse.addDependency(String,
String, String, String) are to be referenced in the page's header.setPortletDependencyJavaScriptEnabled in interface PortletportletDependencyJavaScriptEnabled - whether the JavaScript resource
dependencies specified in portlet.xml, @Dependency, HeaderResponse.addDependency(String, String,
String), or HeaderResponse.addDependency(String, String, String,
String) are to be referenced in the page's headerpublic void setPortletFilters(Map<String,PortletFilter> portletFilters)
setPortletFilters in interface PortletportletFilters - the filters of the portletpublic void setPortletId(String portletId)
setPortletId in interface PortletModelportletId - the portlet ID of this portletpublic void setPortletInfo(PortletInfo portletInfo)
setPortletInfo in interface PortletportletInfo - the portlet info of the portletpublic void setPortletLayoutListenerClass(String portletLayoutListenerClass)
setPortletLayoutListenerClass in interface PortletportletLayoutListenerClass - the name of the portlet layout listener
class of the portletpublic void setPortletModes(Map<String,Set<String>> portletModes)
setPortletModes in interface PortletportletModes - the portlet modes of the portletpublic void setPortletName(String portletName)
setPortletName in interface PortletportletName - the name of the portletpublic void setPortletURLClass(String portletURLClass)
setPortletURLClass in interface PortletportletURLClass - the name of the portlet URL class of the portletpublic void setPreferencesCompanyWide(boolean preferencesCompanyWide)
true if preferences are shared across the entire
company.setPreferencesCompanyWide in interface PortletpreferencesCompanyWide - boolean value for whether preferences are
shared across the entire companypublic void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup)
true if preferences are owned by the group when the
portlet is shown in a group layout. Set to false if
preferences are owned by the user at all times.setPreferencesOwnedByGroup in interface PortletpreferencesOwnedByGroup - 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 timespublic void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
true if preferences are unique per layout.setPreferencesUniquePerLayout in interface PortletpreferencesUniquePerLayout - boolean value for whether preferences
are unique per layoutpublic void setPreferencesValidator(String preferencesValidator)
setPreferencesValidator in interface PortletpreferencesValidator - the name of the preferences validator class
of the portletpublic void setPrimaryKey(long primaryKey)
setPrimaryKey in interface PortletModelprimaryKey - the primary key of this portletpublic void setPrivateRequestAttributes(boolean privateRequestAttributes)
true if the portlet does not share request attributes
with the portal or portlets from another WAR.setPrivateRequestAttributes in interface PortletprivateRequestAttributes - boolean value for whether the portlet
shares request attributes with the portal or portlets from another
WARpublic void setPrivateSessionAttributes(boolean privateSessionAttributes)
true if the portlet does not share session attributes
with the portal.setPrivateSessionAttributes in interface PortletprivateSessionAttributes - boolean value for whether the portlet
shares session attributes with the portalpublic void setProcessingEvents(Set<QName> processingEvents)
setProcessingEvents in interface PortletprocessingEvents - the processing events of the portletpublic void setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)
setPublicRenderParameters in interface PortletpublicRenderParameters - the public render parameters of the portletpublic void setPublishingEvents(Set<QName> publishingEvents)
setPublishingEvents in interface PortletpublishingEvents - the publishing events of the portletpublic void setReady(boolean ready)
true if the portlet is ready to be used.public void setRenderTimeout(int renderTimeout)
setRenderTimeout in interface PortletrenderTimeout - the render timeout of the portletpublic void setRenderWeight(int renderWeight)
setRenderWeight in interface PortletrenderWeight - int value for the render weight of the portletpublic void setRequiresNamespacedParameters(boolean requiresNamespacedParameters)
true if the portlet will only process namespaced
parameters.setRequiresNamespacedParameters in interface PortletrequiresNamespacedParameters - boolean value for whether the portlet
will only process namespaced parameterspublic void setResourceBundle(String resourceBundle)
setResourceBundle in interface PortletresourceBundle - the resource bundle of the portletpublic void setRestoreCurrentView(boolean restoreCurrentView)
true if the portlet restores to the current view from
the maximized state.setRestoreCurrentView in interface PortletrestoreCurrentView - boolean value for whether the portlet restores
to the current view from the maximized statepublic void setRoleMappers(Map<String,String> roleMappers)
setRoleMappers in interface PortletroleMappers - the role mappers of the portletpublic void setRoles(String roles)
setRoles in interface PortletModelroles - the roles of this portletpublic void setRolesArray(String[] rolesArray)
setRolesArray in interface PortletrolesArray - an array of required roles of the portletpublic void setSchedulerEntries(List<SchedulerEntry> schedulerEntries)
setSchedulerEntries in interface PortletschedulerEntries - the scheduler entries of the portletpublic void setScopeable(boolean scopeable)
true if the portlet supports scoping of data.setScopeable in interface Portletscopeable - boolean value for whether or not the the portlet
supports scoping of datapublic void setShowPortletAccessDenied(boolean showPortletAccessDenied)
true if users are shown that they do not have access
to the portlet.setShowPortletAccessDenied in interface PortletshowPortletAccessDenied - boolean value for whether users are shown
that they do not have access to the portletpublic void setShowPortletInactive(boolean showPortletInactive)
true if users are shown that the portlet is inactive.setShowPortletInactive in interface PortletshowPortletInactive - boolean value for whether users are shown that
the portlet is inactivepublic void setSinglePageApplication(boolean singlePageApplication)
true if the portlet uses Single Page Application.setSinglePageApplication in interface PortletsinglePageApplication - boolean value for whether or not the the
portlet uses Single Page Applicationpublic void setSocialActivityInterpreterClasses(List<String> socialActivityInterpreterClasses)
setSocialActivityInterpreterClasses in interface PortletsocialActivityInterpreterClasses - the names of the classes that
represent social activity interpreters associated with the portletpublic void setSocialRequestInterpreterClass(String socialRequestInterpreterClass)
setSocialRequestInterpreterClass in interface PortletsocialRequestInterpreterClass - the name of the request interpreter
class of the portletpublic void setStagedModelDataHandlerClasses(List<String> stagedModelDataHandlerClasses)
setStagedModelDataHandlerClasses in interface PortletstagedModelDataHandlerClasses - the names of the classes that
represent staged model data handlers associated with the portletpublic void setStatic(boolean staticPortlet)
true if the portlet is a static portlet that is
cannot be moved.public void setStaticStart(boolean staticPortletStart)
true if the portlet is a static portlet at the start
of a list of portlets.setStaticStart in interface PortletstaticPortletStart - boolean value for whether the portlet is a
static portlet at the start of a list of portletspublic void setStrutsPath(String strutsPath)
setStrutsPath in interface PortletstrutsPath - the struts path of the portletpublic void setSupportedLocales(Set<String> supportedLocales)
setSupportedLocales in interface PortletsupportedLocales - the supported locales of the portletpublic void setSystem(boolean system)
true if the portlet is a system portlet that a user
cannot manually add to their page.public void setTemplateHandlerClass(String templateHandlerClass)
setTemplateHandlerClass in interface PortlettemplateHandlerClass - the name of template handler class of the
portletpublic void setTrashHandlerClasses(List<String> trashHandlerClasses)
setTrashHandlerClasses in interface PortlettrashHandlerClasses - the names of the classes that represent trash
handlers associated with the portletpublic void setUndeployedPortlet(boolean undeployedPortlet)
true if the portlet is an undeployed portlet.setUndeployedPortlet in interface PortletundeployedPortlet - boolean value for whether the portlet is an
undeployed portletpublic void setUnlinkedRoles(Set<String> unlinkedRoles)
setUnlinkedRoles in interface PortletunlinkedRoles - the unlinked roles of the portletpublic void setURLEncoderClass(String urlEncoderClass)
setURLEncoderClass in interface PortleturlEncoderClass - the name of the URL encoder class of the portletpublic void setUseDefaultTemplate(boolean useDefaultTemplate)
true if the portlet uses the default template.setUseDefaultTemplate in interface PortletuseDefaultTemplate - boolean value for whether the portlet uses the
default templatepublic void setUserNotificationDefinitions(String userNotificationDefinitions)
setUserNotificationDefinitions in interface PortletuserNotificationDefinitions - the class loader resource path to the
user notification definitions of the portletpublic void setUserNotificationHandlerClasses(List<String> userNotificationHandlerClasses)
setUserNotificationHandlerClasses in interface PortletuserNotificationHandlerClasses - the names of the classes that
represent user notification handlers associated with the portletpublic void setUserPrincipalStrategy(String userPrincipalStrategy)
setUserPrincipalStrategy in interface PortletuserPrincipalStrategy - the user principal strategy of the portletpublic void setVirtualPath(String virtualPath)
setVirtualPath in interface PortletvirtualPath - the virtual path of the portletpublic void setWebDAVStorageClass(String webDAVStorageClass)
setWebDAVStorageClass in interface PortletwebDAVStorageClass - the name of the WebDAV storage class of the
portletpublic void setWebDAVStorageToken(String webDAVStorageToken)
setWebDAVStorageToken in interface PortletwebDAVStorageToken - the name of the WebDAV storage token of the
portletpublic void setWindowStates(Map<String,Set<String>> windowStates)
setWindowStates in interface PortletwindowStates - the window states of the portletpublic void setWorkflowHandlerClasses(List<String> workflowHandlerClasses)
setWorkflowHandlerClasses in interface PortletworkflowHandlerClasses - the names of the classes that represent
workflow handlers associated with the portletpublic void setXmlRpcMethodClass(String xmlRpcMethodClass)
setXmlRpcMethodClass in interface PortletxmlRpcMethodClass - the name of the XML-RPC method class of the
portletpublic void unsetReady()
unsetReady in interface Portletprotected PortletWrapper wrap(Portlet portlet)
wrap in class BaseModelWrapper<Portlet>