Package com.aquima.web.api.rendering

Interface ITemplateContext

All Known Implementing Classes:

TemplateContext

public interface ITemplateContext

This interfaces represents the context during the output generation.

Since:

9.2

Author:

A.Pragt

Method Summary

Modifier and Type	Method	Description
String	getApiBasePath()	This method returns the base path for the web api
PageContent	getCurrentPage()	This method returns the current page of the session.
String	getCurrentPageJson()	This method returns the current page serialized in json format.
String	getSessionId()	This method returns the current sessionId.
int	getSessionTimeout()	This method returns the session timeout in seconds.
String	getTheme()	This method returns the current theme name.
String	getWebResourceBasePath()	This method returns the base path for web resources.
boolean	isDevelopmentMode()	This method returns an indicator for development mode.

Method Details

getTheme

String getTheme()

This method returns the current theme name.

Returns:

The current theme name, never null.

getApiBasePath

String getApiBasePath()

This method returns the base path for the web api

Returns:

The base path, never null.

getWebResourceBasePath

String getWebResourceBasePath()

This method returns the base path for web resources.

Returns:

The base path, never null.

getCurrentPage

PageContent getCurrentPage()

This method returns the current page of the session.

Returns:

The current page.

getCurrentPageJson

String getCurrentPageJson()

This method returns the current page serialized in json format.

Returns:

The current page.

getSessionId

String getSessionId()

This method returns the current sessionId.

Returns:

The sessionId.

isDevelopmentMode

boolean isDevelopmentMode()

This method returns an indicator for development mode.

Returns:

Development mode indicator.

getSessionTimeout

int getSessionTimeout()

This method returns the session timeout in seconds.

Returns:

The session timeout, negative for unlimited.