Package com.axemble.vdoc.sdk.interfaces.runtime

Interface ISiteExecutionContext

All Superinterfaces:

IExecutionContext

All Known Subinterfaces:

InternalSiteExecutionContext

All Known Implementing Classes:

EzsExecutionContext

public interface ISiteExecutionContext
extends IExecutionContext

The site execution context interface.

Since:

2.1

Version:

1.0, 09/09/2009

Author:

vlygeros

See Also:

• IExecutionContext

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ISiteExecutionContext.IRenderModes	The render mode interface.

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

Method Summary

Modifier and Type	Method	Description
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.
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
int	getRenderMode()	Gets the current render mode.
ISite	getSite()	Gets the current site.
String	getSiteUrl()	Gets the site url.
ITopic	getTopic()	Gets the current topic.

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

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

Method Details

getModule

IBaseSiteModule getModule()

Gets the site module.

Returns:

A IBaseSiteModule object.

getSite

ISite getSite()

Gets the current site.

Returns:

A ISite object.

getTopic

ITopic getTopic()

Gets the current topic.

Returns:

A ITopic object.

getPlugin

IPlugin getPlugin()

Gets the current plugin.

Returns:

A IPlugin object.

getPluginContext

Map<String,Object> getPluginContext()

Gets the current plugin context

Returns:

A Map object

getAlias

IAlias getAlias()

Gets the current alias.

Returns:

A IAlias object.

getContentContainer

IContentContainer getContentContainer()

Gets the current content container.

Returns:

A IContentContainer object.

getPageContainer

IPageContainer getPageContainer()

Gets the current page container.

Returns:

A IPageContainer object.

getContent

IContent getContent()

Gets the current content.

Returns:

A IContent object.

getRenderMode

int getRenderMode()

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.

Returns:

A int value.

getMarkerModel

IMarkerModel getMarkerModel()

Gets the current marker model.

Returns:

A IMarkerModel object.

getBaseSiteUrl

String getBaseSiteUrl()

Gets the base site url.

Returns:

a java.lang.String value.

getSiteUrl

String getSiteUrl()

Gets the site url.

Returns:

a java.lang.String value.