Package com.axemble.vdoc.sdk.impl

Class EzsExecutionContext

java.lang.Object

com.axemble.vdoc.sdk.impl.base.BaseServletExecutionContext

com.axemble.vdoc.sdk.impl.EzsExecutionContext

All Implemented Interfaces:

IExecutionContext, InternalSiteExecutionContext, ISiteExecutionContext

public class EzsExecutionContext
extends com.axemble.vdoc.sdk.impl.base.BaseServletExecutionContext
implements InternalSiteExecutionContext

Author:

vlygeros

Nested Class Summary

Nested classes/interfaces inherited from class com.axemble.vdoc.sdk.impl.base.BaseServletExecutionContext

com.axemble.vdoc.sdk.impl.base.BaseServletExecutionContext.InitialPreferences, com.axemble.vdoc.sdk.impl.base.BaseServletExecutionContext.Preferences, com.axemble.vdoc.sdk.impl.base.BaseServletExecutionContext.Request, com.axemble.vdoc.sdk.impl.base.BaseServletExecutionContext.RequestDispatcher, com.axemble.vdoc.sdk.impl.base.BaseServletExecutionContext.Response, com.axemble.vdoc.sdk.impl.base.BaseServletExecutionContext.Session

Nested classes/interfaces inherited from interface com.axemble.vdoc.sdk.interfaces.runtime.IExecutionContext

IExecutionContext.IError, IExecutionContext.IPreferences, IExecutionContext.IRequest, IExecutionContext.IRequestDispatcher, IExecutionContext.IResponse, IExecutionContext.ISession

Nested classes/interfaces inherited from interface com.axemble.vdoc.sdk.interfaces.runtime.InternalSiteExecutionContext

InternalSiteExecutionContext.IContextParameters

Nested classes/interfaces inherited from interface com.axemble.vdoc.sdk.interfaces.runtime.ISiteExecutionContext

ISiteExecutionContext.IRenderModes

Field Summary

Fields inherited from class com.axemble.vdoc.sdk.impl.base.BaseServletExecutionContext

ajaxMode, eventMode, locale, properties, request, response, skin

Constructor Summary

Constructors

Constructor	Description
EzsExecutionContext(IBaseSiteModule module, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)

Method Summary

Modifier and Type	Method	Description
String	getActionURL()
IAlias	getAlias()	Gets the current alias.
String	getBaseSiteUrl()	Gets the base site url.
IContent	getContent()	Gets the current content.
IContentContainer	getContentContainer()	Gets the current content container.
String	getContentContainerKeyId()
String	getContentContainerKeyUniqueId()
INavigateContext	getContext()
com.axemble.easysite.ui.runtime.ContextHandler	getContextHandler()
com.axemble.vdp.ui.framework.foundation.controllers.ICustomController	getCustomController()
Object	getInternalContextHandler()
IMarkerModel	getMarkerModel()	Gets the current marker model.
IBaseSiteModule	getModule()	Gets the site module.
IPageContainer	getPageContainer()	Gets the current page container.
IPlugin	getPlugin()	Gets the current plugin.
Map<String,Object>	getPluginContext()	Gets the current plugin context
com.axemble.vdoc.sdk.impl.base.BasePluginController	getPluginController()
String	getRedirect()
int	getRenderMode()	Gets the current render mode.
ISite	getSite()	Gets the current site.
String	getSiteUrl()	Gets the site url.
String	getSkinRelativePath()
ITopic	getTopic()	Gets the current topic.
void	setAlias(IAlias alias)
void	setContent(IContent content)
void	setContentContainer(IContentContainer contentContainer)
void	setContentContainerKeyId(String keyId)
void	setContentContainerKeyUniqueId(String keyUniqueId)
void	setCustomController(com.axemble.vdp.ui.framework.foundation.controllers.ICustomController customController)
void	setInternalContextHandler(Object contextHandler)
void	setPageContainer(IPageContainer pageContainer)
void	setPlugin(IPlugin plugin)
void	setRedirect(String redirect)
void	setSite(ISite site)
void	setTopic(ITopic topic)

Methods inherited from class com.axemble.vdoc.sdk.impl.base.BaseServletExecutionContext

clear, getLocale, getPreferences, getProperties, getRequest, getResponse, getSkin, getTimeZone, isAjaxMode, isEventMode, setAjaxMode, setEventMode, setLocale, setProperties, setRequest, setResponse, setSkin, setTimeZone

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.runtime.IExecutionContext

clear, getLocale, getPreferences, getProperties, getRequest, getResponse, getSkin, getTimeZone, isAjaxMode, isEventMode

Constructor Details

EzsExecutionContext

public EzsExecutionContext(IBaseSiteModule module,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Method Details

getModule

public IBaseSiteModule getModule()

Description copied from interface: ISiteExecutionContext

Gets the site module.

Specified by:

getModule in interface ISiteExecutionContext

Returns:

A IBaseSiteModule object.

getSite

public ISite getSite()

Description copied from interface: ISiteExecutionContext

Gets the current site.

Specified by:

getSite in interface ISiteExecutionContext

Returns:

A ISite object.

setSite

public void setSite(ISite site)

Specified by:

setSite in interface InternalSiteExecutionContext

getPageContainer

public IPageContainer getPageContainer()

Description copied from interface: ISiteExecutionContext

Gets the current page container.

Specified by:

getPageContainer in interface ISiteExecutionContext

Returns:

A IPageContainer object.

setPageContainer

public void setPageContainer(IPageContainer pageContainer)

Specified by:

setPageContainer in interface InternalSiteExecutionContext

getContentContainer

public IContentContainer getContentContainer()

Description copied from interface: ISiteExecutionContext

Gets the current content container.

Specified by:

getContentContainer in interface ISiteExecutionContext

Returns:

A IContentContainer object.

setContentContainer

public void setContentContainer(IContentContainer contentContainer)

Specified by:

setContentContainer in interface InternalSiteExecutionContext

getTopic

public ITopic getTopic()

Description copied from interface: ISiteExecutionContext

Gets the current topic.

Specified by:

getTopic in interface ISiteExecutionContext

Returns:

A ITopic object.

setTopic

public void setTopic(ITopic topic)

Specified by:

setTopic in interface InternalSiteExecutionContext

getPlugin

public IPlugin getPlugin()

Description copied from interface: ISiteExecutionContext

Gets the current plugin.

Specified by:

getPlugin in interface ISiteExecutionContext

Returns:

A IPlugin object.

setPlugin

public void setPlugin(IPlugin plugin)

Specified by:

setPlugin in interface InternalSiteExecutionContext

getPluginContext

public Map<String,Object> getPluginContext()

Description copied from interface: ISiteExecutionContext

Gets the current plugin context

Specified by:

getPluginContext in interface ISiteExecutionContext

Returns:

A Map object

getPluginController

public com.axemble.vdoc.sdk.impl.base.BasePluginController getPluginController()

getContent

public IContent getContent()

Description copied from interface: ISiteExecutionContext

Gets the current content.

Specified by:

getContent in interface ISiteExecutionContext

Returns:

A IContent object.

setContent

public void setContent(IContent content)

Specified by:

setContent in interface InternalSiteExecutionContext

getAlias

public IAlias getAlias()

Description copied from interface: ISiteExecutionContext

Gets the current alias.

Specified by:

getAlias in interface ISiteExecutionContext

Returns:

A IAlias object.

setAlias

public void setAlias(IAlias alias)

Specified by:

setAlias in interface InternalSiteExecutionContext

getRedirect

public String getRedirect()

Specified by:

getRedirect in interface InternalSiteExecutionContext

setRedirect

public void setRedirect(String redirect)

Specified by:

setRedirect in interface InternalSiteExecutionContext

getRenderMode

public int getRenderMode()

Description copied from interface: ISiteExecutionContext

Gets the current render mode.

The returned value could take one of the following values:

• IRenderModes.DEFAULT: final mode of the page.
• IRenderModes.EDIT: design mode of the page.
• IRenderModes.DRAFT: preview of the page.

Specified by:

getRenderMode in interface ISiteExecutionContext

Returns:

A int value.

getMarkerModel

public IMarkerModel getMarkerModel()

Description copied from interface: ISiteExecutionContext

Gets the current marker model.

Specified by:

getMarkerModel in interface ISiteExecutionContext

Returns:

A IMarkerModel object.

getContextHandler

public com.axemble.easysite.ui.runtime.ContextHandler getContextHandler()

getInternalContextHandler

public Object getInternalContextHandler()

Specified by:

getInternalContextHandler in interface InternalSiteExecutionContext

getContentContainerKeyId

public String getContentContainerKeyId()

Specified by:

getContentContainerKeyId in interface InternalSiteExecutionContext

getContentContainerKeyUniqueId

public String getContentContainerKeyUniqueId()

Specified by:

getContentContainerKeyUniqueId in interface InternalSiteExecutionContext

setContentContainerKeyId

public void setContentContainerKeyId(String keyId)

Specified by:

setContentContainerKeyId in interface InternalSiteExecutionContext

setContentContainerKeyUniqueId

public void setContentContainerKeyUniqueId(String keyUniqueId)

Specified by:

setContentContainerKeyUniqueId in interface InternalSiteExecutionContext

setInternalContextHandler

public void setInternalContextHandler(Object contextHandler)

Specified by:

setInternalContextHandler in interface InternalSiteExecutionContext

getSkinRelativePath

public String getSkinRelativePath()

Specified by:

getSkinRelativePath in interface InternalSiteExecutionContext

getBaseSiteUrl

public String getBaseSiteUrl()

Description copied from interface: ISiteExecutionContext

Gets the base site url.

Specified by:

getBaseSiteUrl in interface ISiteExecutionContext

Returns:

a java.lang.String value.

getSiteUrl

public String getSiteUrl()

Description copied from interface: ISiteExecutionContext

Gets the site url.

Specified by:

getSiteUrl in interface ISiteExecutionContext

Returns:

a java.lang.String value.

getContext

public INavigateContext getContext()

Specified by:

getContext in interface IExecutionContext

getCustomController

public com.axemble.vdp.ui.framework.foundation.controllers.ICustomController getCustomController()

setCustomController

public void setCustomController(com.axemble.vdp.ui.framework.foundation.controllers.ICustomController customController)

getActionURL

public String getActionURL()

Specified by:

getActionURL in interface IExecutionContext