lumis.portal.presentation.mode

Interface IPortalModeSPI

All Superinterfaces:

IPortalMode, Serializable

All Known Implementing Classes:

AbstractPortalMode, ContentAdministrationPortalMode, ContentPublicationPortalMode, ContextValidatingPortalMode, NavigationPortalMode, PortalStudioPortalMode, SettingsPortalMode

public interface IPortalModeSPI
extends IPortalMode

The PortalMode interface used internally by the portal framework. IPortalMode implementations must also implement this interface.

Since:

6.0.0

Version:

$Revision: 17842 $ $Date: 2015-10-22 18:40:03 +0000 (Thu, 22 Oct 2015) $

Method Summary

Modifier and Type	Method and Description
Set<String>	getAttributeNames() Returns the set of attribute names for the current PortalMode.
Class<? extends AbstractLayoutFileMarkupFilter>	getMarkupFilterClass() Returns markup filter for parser to use to render page.
IPermissionProvider	getPermissionProvider() Returns the permission provider of the current mode.
Class<? extends HTMLFragmentComponent>	getRenderComponentClass() Returns the component render.
boolean	validateAccess(IPortalMode currentMode, HttpServletRequest httpServletRequest, IPageWebResourceRequest webResourceRequest) Checks whether the current user has access to the given portal mode.

Methods inherited from interface lumis.portal.presentation.mode.IPortalMode

getDescription, getId, getModeRootUrl, getName

Method Detail

getPermissionProvider

IPermissionProvider getPermissionProvider()

Returns the permission provider of the current mode.

Returns:

the permission provider of the current mode.

Since:

6.0.0

getAttributeNames

Set<String> getAttributeNames()

Returns the set of attribute names for the current PortalMode.

Returns:

the set of attribute names for the current PortalMode.

Since:

6.0.0

getRenderComponentClass

Class<? extends HTMLFragmentComponent> getRenderComponentClass()

Returns the component render.

Returns:

the component render.

Since:

6.0.0

getMarkupFilterClass

Class<? extends AbstractLayoutFileMarkupFilter> getMarkupFilterClass()

Returns markup filter for parser to use to render page.

Returns:

markup filter for parser to use to render page.

Since:

7.1.0

validateAccess

boolean validateAccess(IPortalMode currentMode,
                       HttpServletRequest httpServletRequest,
                       IPageWebResourceRequest webResourceRequest)
                throws PortalException

Checks whether the current user has access to the given portal mode.

Parameters:

currentMode - the portal mode.

httpServletRequest - the HTTP servlet request.

webResourceRequest - the page web resource request

Returns:

whether the current user has access to the given portal mode.

Throws:

PortalException

Since:

7.1.0