|
Liferay 6.1.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.model.PortletWrapper
public class PortletWrapper
This class is a wrapper for Portlet.
Portlet,
Serialized Form| Field Summary |
|---|
| Fields inherited from interface com.liferay.portal.model.Portlet |
|---|
PORTLET_ID_ACCESSOR |
| Constructor Summary | |
|---|---|
PortletWrapper(Portlet portlet)
|
|
| Method Summary | |
|---|---|
void |
addProcessingEvent(QName processingEvent)
Adds a supported processing event. |
void |
addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
Adds a supported public render parameter. |
void |
addPublishingEvent(QName publishingEvent)
Adds a supported publishing event. |
void |
addSchedulerEntry(SchedulerEntry schedulerEntry)
Adds a scheduler entry. |
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 a list of all portlet modes supported by the portlet. |
Set<String> |
getAllWindowStates()
Returns a list of all window states supported by 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 |
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. |
ExpandoBridge |
getExpandoBridge()
Returns the expando bridge for this model instance. |
Integer |
getExpCache()
Returns expiration cache of the portlet. |
String |
getFacebookIntegration()
Returns the Facebook integration method of the portlet. |
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. |
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 name 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. |
Class<?> |
getModelClass()
|
String |
getModelClassName()
|
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. |
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. |
Serializable |
getPrimaryKeyObj()
Returns the primary key of this model instance. |
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 supported processing event from a namespace URI and a local part. |
Set<QName> |
getProcessingEvents()
Returns the supported processing events of the portlet. |
PublicRenderParameter |
getPublicRenderParameter(String identifier)
Returns the supported public render parameter from an identifier. |
PublicRenderParameter |
getPublicRenderParameter(String uri,
String localPart)
Returns the supported public render parameter from a namespace URI and a local part. |
Set<PublicRenderParameter> |
getPublicRenderParameters()
Returns the supported public render parameters of the portlet. |
Set<QName> |
getPublishingEvents()
Returns the supported publishing events of the portlet. |
boolean |
getReady()
Returns true if the portlet is ready to be used. |
boolean |
getRemoteable()
Returns true if the portlet supports remoting. |
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. |
String |
getSocialActivityInterpreterClass()
Returns the name of the social activity interpreter class of the portlet. |
SocialActivityInterpreter |
getSocialActivityInterpreterInstance()
Returns the name of the social activity interpreter instance 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. |
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. |
long |
getTimestamp()
Returns the timestamp 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. |
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. |
Portlet |
getWrappedModel()
|
Portlet |
getWrappedPortlet()
Deprecated. Renamed to getWrappedModel() |
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. |
int |
hashCode()
|
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 |
isCachedModel()
Returns true if this model instance was retrieved from the
entity cache. |
boolean |
isEscapedModel()
Returns true if this model instance is escaped. |
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 |
isNew()
Returns true if this model instance does not yet exist in
the database. |
boolean |
isPopUpPrint()
Returns true if the portlet goes into the pop up state when
the user goes into the print mode. |
boolean |
isPreferencesCompanyWide()
Returns true if preferences are shared across the entire
company. |
boolean |
isPreferencesOwnedByGroup()
Returns true if preferences are owned by the group when the
portlet is shown in a group layout. |
boolean |
isPreferencesUniquePerLayout()
Returns true if preferences are unique per layout. |
boolean |
isPrivateRequestAttributes()
Returns true if the portlet does not share request
attributes with the portal or portlets from another WAR. |
boolean |
isPrivateSessionAttributes()
Returns true if the portlet does not share session
attributes with the portal. |
boolean |
isReady()
Returns true if the portlet is ready to be used. |
boolean |
isRemoteable()
Returns true if the portlet supports remoting. |
boolean |
isRestoreCurrentView()
Returns true if the portlet restores to the current view
from the maximized state. |
boolean |
isScopeable()
Returns true if the portlet supports scoping of data. |
boolean |
isShowPortletAccessDenied()
Returns true if users are shown that they do not have access
to the portlet. |
boolean |
isShowPortletInactive()
Returns true if users are shown that the portlet is
inactive. |
boolean |
isStatic()
Returns true if the portlet is a static portlet that is
cannot be moved. |
boolean |
isStaticEnd()
Returns true if the portlet is a static portlet at the end
of a list of portlets. |
boolean |
isStaticStart()
Returns true if the portlet is a static portlet at the start
of a list of portlets. |
boolean |
isSystem()
Returns true if the portlet is a system portlet that a user
cannot manually add to their page. |
boolean |
isUndeployedPortlet()
Returns true if the portlet is an undeployed portlet. |
boolean |
isUseDefaultTemplate()
Returns true if the portlet uses the default template. |
void |
linkRoles()
Link the role names set in portlet.xml with the Liferay roles set in liferay-portlet.xml. |
void |
persist()
Updates this model instance in the database or adds it if it does not yet exist. |
void |
resetOriginalValues()
Reset all original fields to current values. |
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 |
setAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses)
Sets the name of the classes that represent asset types associated with the portlet. |
void |
setAtomCollectionAdapterClasses(List<String> atomCollectionAdapterClasses)
Sets the name 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 |
setCachedModel(boolean cachedModel)
Sets whether this model instance was retrieved from the entity cache. |
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 name 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 |
setExpandoBridgeAttributes(ServiceContext serviceContext)
Sets the expando bridge attributes for this model instance to the attributes stored in the service context. |
void |
setExpCache(Integer expCache)
Sets expiration cache of the portlet. |
void |
setFacebookIntegration(String facebookIntegration)
Sets the Facebook integration method of the portlet. |
void |
setFooterPortalCss(List<String> footerPortalCss)
Sets a list of CSS files that will be referenced from the page's footer relative to the portal's context path. |
void |
setFooterPortalJavaScript(List<String> footerPortalJavaScript)
Sets a list of JavaScript files that will be referenced from the page's footer relative to the portal's context path. |
void |
setFooterPortletCss(List<String> footerPortletCss)
Sets a list of CSS files that will be referenced from the page's footer relative to the portlet's context path. |
void |
setFooterPortletJavaScript(List<String> footerPortletJavaScript)
Sets a list of JavaScript files that will be referenced from the page's footer relative to the portlet's context path. |
void |
setFriendlyURLMapperClass(String friendlyURLMapperClass)
Sets the name of the friendly URL mapper class of the portlet. |
void |
setFriendlyURLMapping(String friendlyURLMapping)
Sets the name of the friendly URL mapping of the portlet. |
void |
setFriendlyURLRoutes(String friendlyURLRoutes)
Sets the class loader resource path to the friendly URL routes of the portlet. |
void |
setHeaderPortalCss(List<String> headerPortalCss)
Sets a list of CSS files that will be referenced from the page's header relative to the portal's context path. |
void |
setHeaderPortalJavaScript(List<String> headerPortalJavaScript)
Sets a list of JavaScript files that will be referenced from the page's header relative to the portal's context path. |
void |
setHeaderPortletCss(List<String> headerPortletCss)
Sets a list of CSS files that will be referenced from the page's header relative to the portlet's context path. |
void |
setHeaderPortletJavaScript(List<String> headerPortletJavaScript)
Sets a list of JavaScript files that will be referenced from the page's header relative to the portlet's context path. |
void |
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 name 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 |
setNew(boolean n)
Sets whether this model instance does not yet exist in the database. |
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 |
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)
Set to true if the portlet goes into the pop up state when
the user goes into the print mode. |
void |
setPortletApp(PortletApp portletApp)
Sets 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 |
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 |
setPrimaryKeyObj(Serializable primaryKeyObj)
Sets the primary key of this model instance. |
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 supported processing events of the portlet. |
void |
setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)
Sets the supported public render parameters of the portlet. |
void |
setPublishingEvents(Set<QName> publishingEvents)
Sets the supported publishing events of the portlet. |
void |
setReady(boolean ready)
Set to true if the portlet is ready to be used. |
void |
setRemoteable(boolean remoteable)
Set to true if the portlet supports remoting |
void |
setRenderTimeout(int renderTimeout)
Sets the render timeout of the portlet. |
void |
setRenderWeight(int renderWeight)
Sets the render weight of the portlet. |
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 |
setSocialActivityInterpreterClass(String socialActivityInterpreterClass)
Sets the name of the social activity interpreter class of the portlet. |
void |
setSocialRequestInterpreterClass(String socialRequestInterpreterClass)
Sets the name of the social request interpreter class of the portlet. |
void |
setStatic(boolean staticPortlet)
Set to true if the portlet is a static portlet that is
cannot be moved. |
void |
setStaticStart(boolean staticPortletStart)
Set to true if the portlet is a static portlet at the start
of a list of portlets. |
void |
setStrutsPath(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 |
setTimestamp(long timestamp)
Sets the timestamp of the portlet. |
void |
setUndeployedPortlet(boolean undeployedPortlet)
Set to true if the portlet is an undeployed portlet. |
void |
setUnlinkedRoles(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 |
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 name 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. |
CacheModel<Portlet> |
toCacheModel()
Returns a cache model object for this entity used by entity cache. |
Portlet |
toEscapedModel()
Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler. |
String |
toString()
|
String |
toXmlString()
Returns the XML representation of this model instance. |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public PortletWrapper(Portlet portlet)
| Method Detail |
|---|
public Class<?> getModelClass()
getModelClass in interface ClassedModelpublic String getModelClassName()
getModelClassName in interface ClassedModelpublic long getPrimaryKey()
getPrimaryKey in interface PortletModelpublic void setPrimaryKey(long primaryKey)
setPrimaryKey in interface PortletModelprimaryKey - the primary key of this portletpublic long getId()
getId in interface PortletModelpublic void setId(long id)
setId in interface PortletModelid - the ID of this portletpublic long getCompanyId()
getCompanyId in interface PortletModelpublic void setCompanyId(long companyId)
setCompanyId in interface PortletModelcompanyId - the company ID of this portletpublic String getPortletId()
getPortletId in interface PortletModelpublic void setPortletId(String portletId)
setPortletId in interface PortletModelportletId - the portlet ID of this portletpublic String getRoles()
getRoles in interface PortletModelpublic void setRoles(String roles)
setRoles in interface PortletsetRoles in interface PortletModelroles - the roles of this portletpublic boolean getActive()
getActive in interface PortletModelpublic boolean isActive()
true if this portlet is active.
isActive in interface PortletModeltrue if this portlet is active; false otherwisepublic void setActive(boolean active)
setActive in interface PortletModelactive - the active of this portletpublic boolean isNew()
BaseModeltrue if this model instance does not yet exist in
the database.
isNew in interface BaseModel<Portlet>isNew in interface PortletModeltrue if this model instance does not yet exist in
the database; false otherwisepublic void setNew(boolean n)
BaseModel
setNew in interface BaseModel<Portlet>setNew in interface PortletModeln - whether this model instance does not yet exist in the databasepublic boolean isCachedModel()
BaseModeltrue if this model instance was retrieved from the
entity cache.
isCachedModel in interface BaseModel<Portlet>isCachedModel in interface PortletModeltrue if this model instance was retrieved from the
entity cache; false otherwiseBaseModel.setCachedModel(boolean)public void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel in interface BaseModel<Portlet>setCachedModel in interface PortletModelcachedModel - whether this model instance was retrieved from the
entity cacheEntityCachepublic boolean isEscapedModel()
BaseModeltrue if this model instance is escaped.
isEscapedModel in interface BaseModel<Portlet>isEscapedModel in interface PortletModeltrue if this model instance is escaped;
false otherwisepublic Serializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj in interface BaseModel<Portlet>getPrimaryKeyObj in interface ClassedModelgetPrimaryKeyObj in interface PortletModelpublic void setPrimaryKeyObj(Serializable primaryKeyObj)
BaseModel
setPrimaryKeyObj in interface BaseModel<Portlet>setPrimaryKeyObj in interface ClassedModelsetPrimaryKeyObj in interface PortletModelprimaryKeyObj - the primary key of this model instancepublic ExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge in interface BaseModel<Portlet>getExpandoBridge in interface ClassedModelgetExpandoBridge in interface PortletModelpublic void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes in interface BaseModel<Portlet>setExpandoBridgeAttributes in interface PortletModelserviceContext - the service contextServiceContext.getExpandoBridgeAttributes(
)public Object clone()
Portlet
clone in interface BaseModel<Portlet>clone in interface Portletclone in interface PortletModelclone in class Objectpublic int compareTo(Portlet portlet)
Portlet
compareTo in interface PortletcompareTo in interface PortletModelcompareTo in interface Comparable<Portlet>portlet - the portlet to compare this portlet against
public int hashCode()
hashCode in interface PortletModelhashCode in class Objectpublic CacheModel<Portlet> toCacheModel()
BaseModel
toCacheModel in interface BaseModel<Portlet>toCacheModel in interface PortletModelpublic Portlet toEscapedModel()
BaseModelAutoEscapeBeanHandler.
toEscapedModel in interface BaseModel<Portlet>toEscapedModel in interface PortletModelAutoEscapeBeanHandlerpublic String toString()
toString in interface PortletModeltoString in class Objectpublic String toXmlString()
BaseModel
toXmlString in interface BaseModel<Portlet>toXmlString in interface PortletModel
public void persist()
throws SystemException
PersistedModel
persist in interface PersistedModelSystemException - if a system exception occurredpublic Portlet getRootPortlet()
getRootPortlet in interface Portletpublic String getRootPortletId()
getRootPortletId in interface Portletpublic String getInstanceId()
getInstanceId in interface Portletpublic String getPluginId()
getPluginId in interface Portletpublic String getPluginType()
getPluginType in interface Portletpublic PluginPackage getPluginPackage()
getPluginPackage in interface Portletpublic void setPluginPackage(PluginPackage pluginPackage)
setPluginPackage in interface PortletpluginPackage - this portlet's plugin packagepublic PluginSetting getDefaultPluginSetting()
getDefaultPluginSetting in interface Portletpublic void setDefaultPluginSetting(PluginSetting pluginSetting)
setDefaultPluginSetting in interface PortletpluginSetting - the plugin settingpublic long getTimestamp()
getTimestamp in interface Portletpublic void setTimestamp(long timestamp)
setTimestamp in interface Portlettimestamp - the timestamp of the portletpublic String getIcon()
getIcon in interface Portletpublic void setIcon(String icon)
setIcon in interface Portleticon - the icon of the portletpublic String getVirtualPath()
getVirtualPath in interface Portletpublic void setVirtualPath(String virtualPath)
setVirtualPath in interface PortletvirtualPath - the virtual path of the portletpublic String getStrutsPath()
getStrutsPath in interface Portletpublic void setStrutsPath(String strutsPath)
setStrutsPath in interface PortletstrutsPath - the struts path of the portletpublic String getParentStrutsPath()
getParentStrutsPath in interface Portletpublic void setParentStrutsPath(String parentStrutsPath)
setParentStrutsPath in interface PortletparentStrutsPath - the parent struts path of the portletpublic String getPortletName()
getPortletName in interface Portletpublic void setPortletName(String portletName)
setPortletName in interface PortletportletName - the name of the portletpublic String getDisplayName()
getDisplayName in interface Portletpublic void setDisplayName(String displayName)
setDisplayName in interface PortletdisplayName - the display name of the portletpublic String getPortletClass()
getPortletClass in interface Portletpublic void setPortletClass(String portletClass)
setPortletClass in interface PortletportletClass - the name of the portlet class of the portletpublic String getConfigurationActionClass()
getConfigurationActionClass in interface Portletpublic void setConfigurationActionClass(String configurationActionClass)
setConfigurationActionClass in interface PortletconfigurationActionClass - the configuration action class of the
portletpublic ConfigurationAction getConfigurationActionInstance()
getConfigurationActionInstance in interface Portletpublic List<String> getIndexerClasses()
getIndexerClasses in interface Portletpublic void setIndexerClasses(List<String> indexerClasses)
setIndexerClasses in interface PortletindexerClasses - the name of the classes that represent indexers
associated with the portletpublic List<Indexer> getIndexerInstances()
getIndexerInstances in interface Portletpublic String getOpenSearchClass()
getOpenSearchClass in interface Portletpublic void setOpenSearchClass(String openSearchClass)
setOpenSearchClass in interface PortletopenSearchClass - the name of the open search class of the portletpublic OpenSearch getOpenSearchInstance()
getOpenSearchInstance in interface Portletpublic void addSchedulerEntry(SchedulerEntry schedulerEntry)
addSchedulerEntry in interface Portletpublic List<SchedulerEntry> getSchedulerEntries()
getSchedulerEntries in interface Portletpublic void setSchedulerEntries(List<SchedulerEntry> schedulerEntries)
setSchedulerEntries in interface PortletschedulerEntries - the scheduler entries of the portletpublic String getPortletURLClass()
getPortletURLClass in interface Portletpublic void setPortletURLClass(String portletURLClass)
setPortletURLClass in interface PortletportletURLClass - the name of the portlet URL class of the portletpublic String getFriendlyURLMapperClass()
getFriendlyURLMapperClass in interface Portletpublic void setFriendlyURLMapperClass(String friendlyURLMapperClass)
setFriendlyURLMapperClass in interface PortletfriendlyURLMapperClass - the name of the friendly URL mapper class
of the portletpublic FriendlyURLMapper getFriendlyURLMapperInstance()
getFriendlyURLMapperInstance in interface Portletpublic String getFriendlyURLMapping()
getFriendlyURLMapping in interface Portletpublic void setFriendlyURLMapping(String friendlyURLMapping)
setFriendlyURLMapping in interface PortletfriendlyURLMapping - the name of the friendly URL mapping of the
portletpublic String getFriendlyURLRoutes()
getFriendlyURLRoutes in interface Portletpublic void setFriendlyURLRoutes(String friendlyURLRoutes)
setFriendlyURLRoutes in interface PortletfriendlyURLRoutes - the class loader resource path to the friendly
URL routes of the portletpublic String getURLEncoderClass()
getURLEncoderClass in interface Portletpublic void setURLEncoderClass(String urlEncoderClass)
setURLEncoderClass in interface PortleturlEncoderClass - the name of the URL encoder class of the portletpublic URLEncoder getURLEncoderInstance()
getURLEncoderInstance in interface Portletpublic String getPortletDataHandlerClass()
getPortletDataHandlerClass in interface Portletpublic void setPortletDataHandlerClass(String portletDataHandlerClass)
setPortletDataHandlerClass in interface PortletportletDataHandlerClass - the name of portlet data handler class of
the portletpublic PortletDataHandler getPortletDataHandlerInstance()
getPortletDataHandlerInstance in interface Portletpublic String getPortletLayoutListenerClass()
getPortletLayoutListenerClass in interface Portletpublic void setPortletLayoutListenerClass(String portletLayoutListenerClass)
setPortletLayoutListenerClass in interface PortletportletLayoutListenerClass - the name of the portlet layout listener
class of the portletpublic PortletLayoutListener getPortletLayoutListenerInstance()
getPortletLayoutListenerInstance in interface Portletpublic String getPollerProcessorClass()
getPollerProcessorClass in interface Portletpublic void setPollerProcessorClass(String pollerProcessorClass)
setPollerProcessorClass in interface PortletpollerProcessorClass - the name of the poller processor class of the
portletpublic PollerProcessor getPollerProcessorInstance()
getPollerProcessorInstance in interface Portletpublic String getPopMessageListenerClass()
getPopMessageListenerClass in interface Portletpublic void setPopMessageListenerClass(String popMessageListenerClass)
setPopMessageListenerClass in interface PortletpopMessageListenerClass - the name of the POP message listener class
of the portletpublic MessageListener getPopMessageListenerInstance()
getPopMessageListenerInstance in interface Portletpublic String getSocialActivityInterpreterClass()
getSocialActivityInterpreterClass in interface Portletpublic void setSocialActivityInterpreterClass(String socialActivityInterpreterClass)
setSocialActivityInterpreterClass in interface PortletsocialActivityInterpreterClass - the name of the activity
interpreter class of the portletpublic SocialActivityInterpreter getSocialActivityInterpreterInstance()
getSocialActivityInterpreterInstance in interface Portletpublic String getSocialRequestInterpreterClass()
getSocialRequestInterpreterClass in interface Portletpublic void setSocialRequestInterpreterClass(String socialRequestInterpreterClass)
setSocialRequestInterpreterClass in interface PortletsocialRequestInterpreterClass - the name of the request interpreter
class of the portletpublic SocialRequestInterpreter getSocialRequestInterpreterInstance()
getSocialRequestInterpreterInstance in interface Portletpublic String getWebDAVStorageToken()
getWebDAVStorageToken in interface Portletpublic void setWebDAVStorageToken(String webDAVStorageToken)
setWebDAVStorageToken in interface PortletwebDAVStorageToken - the name of the WebDAV storage token of the
portletpublic String getWebDAVStorageClass()
getWebDAVStorageClass in interface Portletpublic void setWebDAVStorageClass(String webDAVStorageClass)
setWebDAVStorageClass in interface PortletwebDAVStorageClass - the name of the WebDAV storage class of the
portletpublic WebDAVStorage getWebDAVStorageInstance()
getWebDAVStorageInstance in interface Portletpublic String getXmlRpcMethodClass()
getXmlRpcMethodClass in interface Portletpublic void setXmlRpcMethodClass(String xmlRpcMethodClass)
setXmlRpcMethodClass in interface PortletxmlRpcMethodClass - the name of the XML-RPC method class of the
portletpublic Method getXmlRpcMethodInstance()
getXmlRpcMethodInstance in interface Portletpublic String getControlPanelEntryCategory()
getControlPanelEntryCategory in interface Portletpublic void setControlPanelEntryCategory(String controlPanelEntryCategory)
setControlPanelEntryCategory in interface PortletcontrolPanelEntryCategory - the name of the category of the Control
Panel where the portlet will be shownpublic double getControlPanelEntryWeight()
getControlPanelEntryWeight in interface Portletpublic 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 String getControlPanelEntryClass()
getControlPanelEntryClass in interface Portletpublic 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 ControlPanelEntry getControlPanelEntryInstance()
getControlPanelEntryInstance in interface Portletpublic List<String> getAssetRendererFactoryClasses()
getAssetRendererFactoryClasses in interface Portletpublic void setAssetRendererFactoryClasses(List<String> assetRendererFactoryClasses)
setAssetRendererFactoryClasses in interface PortletassetRendererFactoryClasses - the names of the classes that
represent asset types associated with the portletpublic List<AssetRendererFactory> getAssetRendererFactoryInstances()
getAssetRendererFactoryInstances in interface Portletpublic List<String> getAtomCollectionAdapterClasses()
getAtomCollectionAdapterClasses in interface Portletpublic void setAtomCollectionAdapterClasses(List<String> atomCollectionAdapterClasses)
setAtomCollectionAdapterClasses in interface PortletatomCollectionAdapterClasses - the names of the classes that
represent atom collection adapters associated with the portletpublic List<AtomCollectionAdapter<?>> getAtomCollectionAdapterInstances()
getAtomCollectionAdapterInstances in interface Portletpublic List<String> getCustomAttributesDisplayClasses()
getCustomAttributesDisplayClasses in interface Portletpublic void setCustomAttributesDisplayClasses(List<String> customAttributesDisplayClasses)
setCustomAttributesDisplayClasses in interface PortletcustomAttributesDisplayClasses - the names of the classes that
represent custom attribute displays associated with the portletpublic List<CustomAttributesDisplay> getCustomAttributesDisplayInstances()
getCustomAttributesDisplayInstances in interface Portletpublic String getPermissionPropagatorClass()
getPermissionPropagatorClass in interface Portletpublic void setPermissionPropagatorClass(String permissionPropagatorClass)
setPermissionPropagatorClass in interface PortletpollerProcessorClass - the name of the permission propagator class
of the portletpublic PermissionPropagator getPermissionPropagatorInstance()
getPermissionPropagatorInstance in interface Portletpublic List<String> getWorkflowHandlerClasses()
getWorkflowHandlerClasses in interface Portletpublic void setWorkflowHandlerClasses(List<String> workflowHandlerClasses)
setWorkflowHandlerClasses in interface PortletworkflowHandlerClasses - the names of the classes that represent
workflow handlers associated with the portletpublic List<WorkflowHandler> getWorkflowHandlerInstances()
getWorkflowHandlerInstances in interface Portletpublic String getDefaultPreferences()
getDefaultPreferences in interface Portletpublic void setDefaultPreferences(String defaultPreferences)
setDefaultPreferences in interface PortletdefaultPreferences - the default preferences of the portletpublic String getPreferencesValidator()
getPreferencesValidator in interface Portletpublic void setPreferencesValidator(String preferencesValidator)
setPreferencesValidator in interface PortletpreferencesValidator - the name of the preferences validator class
of the 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 isPreferencesCompanyWide()
true if preferences are shared across the entire
company.
isPreferencesCompanyWide in interface Portlettrue if preferences are shared across the entire
companypublic 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 boolean getPreferencesUniquePerLayout()
true if preferences are unique per layout.
getPreferencesUniquePerLayout in interface Portlettrue if preferences are unique per layoutpublic boolean isPreferencesUniquePerLayout()
true if preferences are unique per layout.
isPreferencesUniquePerLayout in interface Portlettrue if preferences are unique per layoutpublic void setPreferencesUniquePerLayout(boolean preferencesUniquePerLayout)
true if preferences are unique per layout.
setPreferencesUniquePerLayout in interface PortletpreferencesUniquePerLayout - boolean value for whether preferences
are unique per layoutpublic 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 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 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 boolean getUseDefaultTemplate()
true if the portlet uses the default template.
getUseDefaultTemplate in interface Portlettrue if the portlet uses the default templatepublic boolean isUseDefaultTemplate()
true if the portlet uses the default template.
isUseDefaultTemplate in interface Portlettrue if the portlet uses the default templatepublic 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 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 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 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 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 isShowPortletInactive()
true if users are shown that the portlet is
inactive.
isShowPortletInactive in interface Portlettrue if users are shown that the portlet is inactivepublic 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 void setPopUpPrint(boolean popUpPrint)
true if the portlet goes into the pop up state when
the user goes into the print mode.
setPopUpPrint in interface PortletpopUpPrint - boolean value for whether the portlet goes into the pop
up state when the user goes into the print modepublic 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 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 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 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 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 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 boolean getRemoteable()
true if the portlet supports remoting.
getRemoteable in interface Portlettrue if the portlet supports remotingpublic boolean isRemoteable()
true if the portlet supports remoting.
isRemoteable in interface Portlettrue if the portlet supports remotingpublic void setRemoteable(boolean remoteable)
true if the portlet supports remoting
setRemoteable in interface Portletremoteable - boolean value for whether or not the the portlet
supports remotingpublic boolean getScopeable()
true if the portlet supports scoping of data.
getScopeable in interface Portlettrue if the portlet supports scoping of datapublic boolean isScopeable()
true if the portlet supports scoping of data.
isScopeable in interface Portlettrue if the portlet supports scoping of datapublic 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 String getUserPrincipalStrategy()
getUserPrincipalStrategy in interface Portletpublic void setUserPrincipalStrategy(String userPrincipalStrategy)
setUserPrincipalStrategy in interface PortletuserPrincipalStrategy - the user principal strategy of the portletpublic 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 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 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 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 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 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 Set<String> getAutopropagatedParameters()
getAutopropagatedParameters in interface Portletpublic void setAutopropagatedParameters(Set<String> autopropagatedParameters)
setAutopropagatedParameters in interface PortletautopropagatedParameters - the names of the parameters that will be
automatically propagated through the portletpublic int getActionTimeout()
getActionTimeout in interface Portletpublic void setActionTimeout(int actionTimeout)
setActionTimeout in interface PortletactionTimeout - the action timeout of the portletpublic int getRenderTimeout()
getRenderTimeout in interface Portletpublic void setRenderTimeout(int renderTimeout)
setRenderTimeout in interface PortletrenderTimeout - the render timeout of the portletpublic int getRenderWeight()
getRenderWeight in interface Portletpublic void setRenderWeight(int renderWeight)
setRenderWeight in interface PortletrenderWeight - int value for the render weight of the portletpublic boolean getAjaxable()
true if the portlet can be displayed via Ajax.
getAjaxable in interface Portlettrue if the portlet can be displayed via Ajaxpublic boolean isAjaxable()
true if the portlet can be displayed via Ajax.
isAjaxable in interface Portlettrue if the portlet can be displayed via Ajaxpublic 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 List<String> getHeaderPortalCss()
getHeaderPortalCss in interface 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 List<String> getHeaderPortletCss()
getHeaderPortletCss in interface Portletpublic 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 List<String> getHeaderPortalJavaScript()
getHeaderPortalJavaScript in interface Portletpublic 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 List<String> getHeaderPortletJavaScript()
getHeaderPortletJavaScript in interface Portletpublic 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 List<String> getFooterPortalCss()
getFooterPortalCss in interface 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 List<String> getFooterPortletCss()
getFooterPortletCss in interface Portletpublic 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 List<String> getFooterPortalJavaScript()
getFooterPortalJavaScript in interface Portletpublic 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 List<String> getFooterPortletJavaScript()
getFooterPortletJavaScript in interface Portletpublic 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 String getCssClassWrapper()
getCssClassWrapper in interface Portletpublic 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 String getFacebookIntegration()
getFacebookIntegration in interface Portletpublic void setFacebookIntegration(String facebookIntegration)
setFacebookIntegration in interface PortletfacebookIntegration - the Facebook integration method of the portletpublic 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 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 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 String[] getRolesArray()
getRolesArray in interface Portletpublic void setRolesArray(String[] rolesArray)
setRolesArray in interface PortletrolesArray - an array of required roles of the portletpublic Set<String> getUnlinkedRoles()
getUnlinkedRoles in interface Portletpublic void setUnlinkedRoles(Set<String> unlinkedRoles)
setUnlinkedRoles in interface PortletunlinkedRoles - the unlinked roles of the portletpublic Map<String,String> getRoleMappers()
getRoleMappers in interface Portletpublic void setRoleMappers(Map<String,String> roleMappers)
setRoleMappers in interface PortletroleMappers - the role mappers of the portletpublic void linkRoles()
linkRoles in interface Portletpublic boolean hasRoleWithName(String roleName)
true if the portlet has a role with the specified
name.
hasRoleWithName in interface Portlettrue if the portlet has a role with the specified
namepublic boolean hasAddPortletPermission(long userId)
true if the user has the permission to add the
portlet to a layout.
hasAddPortletPermission in interface Portlettrue if the user has the permission to add the
portlet to a layoutpublic boolean getSystem()
true if the portlet is a system portlet that a user
cannot manually add to their page.
getSystem in interface Portlettrue if the portlet is a system portlet that a user
cannot manually add to their pagepublic boolean isSystem()
true if the portlet is a system portlet that a user
cannot manually add to their page.
isSystem in interface Portlettrue if the portlet is a system portlet that a user
cannot manually add to their pagepublic void setSystem(boolean system)
true if the portlet is a system portlet that a user
cannot manually add to their page.
setSystem in interface Portletsystem - boolean value for whether the portlet is a system portlet
that a user cannot manually add to their pagepublic 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 boolean isInclude()
true to include the portlet and make it available to
be made active.
isInclude in interface Portlettrue to include the portlet and make it available to
be made activepublic 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 boolean getReady()
true if the portlet is ready to be used.
getReady in interface Portlettrue if the portlet is ready to be usedpublic boolean isReady()
true if the portlet is ready to be used.
isReady in interface Portlettrue if the portlet is ready to be usedpublic void setReady(boolean ready)
true if the portlet is ready to be used.
setReady in interface Portletready - whether the portlet is ready to be usedpublic Map<String,String> getInitParams()
getInitParams in interface Portletpublic void setInitParams(Map<String,String> initParams)
setInitParams in interface PortletinitParams - the init parameters of the portletpublic Integer getExpCache()
getExpCache in interface Portletpublic void setExpCache(Integer expCache)
setExpCache in interface PortletexpCache - expiration cache of the portletpublic Map<String,Set<String>> getPortletModes()
getPortletModes in interface Portletpublic void setPortletModes(Map<String,Set<String>> portletModes)
setPortletModes in interface PortletportletModes - the portlet modes of the portlet
public boolean hasPortletMode(String mimeType,
PortletMode portletMode)
true if the portlet supports the specified mime type
and portlet mode.
hasPortletMode in interface Portlettrue if the portlet supports the specified mime type
and portlet modepublic Set<String> getAllPortletModes()
getAllPortletModes 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 Map<String,Set<String>> getWindowStates()
getWindowStates in interface Portletpublic void setWindowStates(Map<String,Set<String>> windowStates)
setWindowStates in interface PortletwindowStates - the window states of the portlet
public boolean hasWindowState(String mimeType,
WindowState windowState)
true if the portlet supports the specified mime type
and window state.
hasWindowState in interface Portlettrue if the portlet supports the specified mime type
and window statepublic Set<String> getAllWindowStates()
getAllWindowStates in interface Portletpublic Set<String> getSupportedLocales()
getSupportedLocales in interface Portletpublic void setSupportedLocales(Set<String> supportedLocales)
setSupportedLocales in interface PortletsupportedLocales - the supported locales of the portletpublic String getResourceBundle()
getResourceBundle in interface Portletpublic void setResourceBundle(String resourceBundle)
setResourceBundle in interface PortletresourceBundle - the resource bundle of the portletpublic PortletInfo getPortletInfo()
getPortletInfo in interface Portletpublic void setPortletInfo(PortletInfo portletInfo)
setPortletInfo in interface PortletportletInfo - the portlet info of the portletpublic Map<String,PortletFilter> getPortletFilters()
getPortletFilters in interface Portletpublic void setPortletFilters(Map<String,PortletFilter> portletFilters)
setPortletFilters in interface PortletportletFilters - the filters of the portletpublic void addProcessingEvent(QName processingEvent)
addProcessingEvent in interface Portlet
public QName getProcessingEvent(String uri,
String localPart)
getProcessingEvent in interface Portletpublic Set<QName> getProcessingEvents()
getProcessingEvents in interface Portletpublic void setProcessingEvents(Set<QName> processingEvents)
setProcessingEvents in interface PortletprocessingEvents - the supported processing events of the portletpublic void addPublishingEvent(QName publishingEvent)
addPublishingEvent in interface Portletpublic Set<QName> getPublishingEvents()
getPublishingEvents in interface Portletpublic void setPublishingEvents(Set<QName> publishingEvents)
setPublishingEvents in interface PortletpublishingEvents - the supported publishing events of the portletpublic void addPublicRenderParameter(PublicRenderParameter publicRenderParameter)
addPublicRenderParameter in interface PortletpublicRenderParameter - a supported public render parameterpublic PublicRenderParameter getPublicRenderParameter(String identifier)
getPublicRenderParameter in interface Portlet
public PublicRenderParameter getPublicRenderParameter(String uri,
String localPart)
getPublicRenderParameter in interface Portletpublic Set<PublicRenderParameter> getPublicRenderParameters()
getPublicRenderParameters in interface Portletpublic void setPublicRenderParameters(Set<PublicRenderParameter> publicRenderParameters)
setPublicRenderParameters in interface PortletpublicRenderParameters - the supported public render parameters of
the portletpublic String getContextPath()
getContextPath in interface Portletpublic String getStaticResourcePath()
getStaticResourcePath in interface Portletpublic PortletApp getPortletApp()
getPortletApp in interface Portletpublic void setPortletApp(PortletApp portletApp)
setPortletApp in interface PortletportletApp - this portlet's applicationpublic Portlet getClonedInstance(String portletId)
true if the portlet is found in a WAR file.
getClonedInstance in interface PortletportletId - the cloned instance portlet ID
public boolean getStatic()
true if the portlet is a static portlet that is
cannot be moved.
getStatic in interface Portlettrue if the portlet is a static portlet that is
cannot be movedpublic boolean isStatic()
true if the portlet is a static portlet that is
cannot be moved.
isStatic in interface Portlettrue if the portlet is a static portlet that is
cannot be movedpublic void setStatic(boolean staticPortlet)
true if the portlet is a static portlet that is
cannot be moved.
setStatic in interface PortletstaticPortlet - boolean value for whether the portlet is a static
portlet that cannot be movedpublic 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 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 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 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 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 getUndeployedPortlet()
true if the portlet is an undeployed portlet.
getUndeployedPortlet in interface Portlettrue if the portlet is a placeholder of an
undeployed portletpublic boolean isUndeployedPortlet()
true if the portlet is an undeployed portlet.
isUndeployedPortlet in interface Portlettrue if the portlet is a placeholder of an
undeployed 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 boolean equals(Object obj)
equals in interface Portletequals in class Objectobj - the object to compare this portlet against
true if the portlet is equal to the specified objectpublic Portlet getWrappedPortlet()
getWrappedModel()
public Portlet getWrappedModel()
getWrappedModel in interface ModelWrapper<Portlet>public void resetOriginalValues()
BaseModel
resetOriginalValues in interface BaseModel<Portlet>
|
Liferay 6.1.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||