de.innovationgate.wgpublisher.webtml.utils

Interface TMLDesignContext

All Known Implementing Classes:

DesignContext, IndependentDesignContext, WebTMLDesignContext

public interface TMLDesignContext

This object represents the current design context of a TMLContext.

Method Summary

Methods

Modifier and Type	Method and Description
void	addWarning(TMLContext cx, java.lang.String msg, boolean severe, java.lang.Throwable cause) Adds a WebTML warning to the design context
TMLDesignContext	createContextDelegate(de.innovationgate.webgate.api.WGDatabase designdb, java.lang.String baseReference) Creates a delegate of this design context type for the given design reference information
DesignResourceReference	getBaseReference() Returnrs the base reference of the design that uses this design context
de.innovationgate.webgate.api.WGDatabase	getDesignDB() Returns the design application for this design context
java.lang.String	getMediaKey() Returns the WebTML media key of the design that uses this design context
de.innovationgate.wga.common.beans.csconfig.v1.Version	getMinimumWGAVersion() Gets the minimum version for OpenWGA of the design that uses this design context
TMLOption	getOption(java.lang.String name) Returns a WebTML option of the current design context
java.util.List<java.lang.String>	getOptionNames() Returns the names of WebTML options known on this design context
TMLPortlet	getPortlet() Returns the portlet associated with this design context
BaseTagStatus	getTag() Returns the associated WebTML tag with this design context
de.innovationgate.wga.common.beans.csconfig.v1.Version	getVersionCompliance() Gets the version compliance of the design that uses this design context
java.lang.Object	removeLocalVar(java.lang.String name) Removes a local WebTML variable.
void	removeOption(java.lang.String name)
java.lang.Object	retrieveLocalVar(java.lang.String name) Retrieves the value of a local WebTML variable.
void	setDownwardOption(java.lang.String name, java.lang.Object value, java.lang.String scope) Defines a WebTML option on the scope of the current design context
void	setLocalVar(java.lang.String name, java.lang.Object value) Sets a local WebTML variable to the scope of this design context
void	setLocalVarOnModule(java.lang.String name, java.lang.Object value) Sets a local WebTML variable to WebTML module scope (if available).
void	setOption(java.lang.String name, java.lang.Object value, java.lang.String scope) Defines a WebTML option on WebTML module scope (if available).

Method Detail

getTag

BaseTagStatus getTag()

Returns the associated WebTML tag with this design context

getPortlet

TMLPortlet getPortlet()
                      throws de.innovationgate.webgate.api.WGAPIException

Returns the portlet associated with this design context

Throws:

de.innovationgate.webgate.api.WGAPIException

setLocalVarOnModule

void setLocalVarOnModule(java.lang.String name,
                       java.lang.Object value)
                         throws de.innovationgate.webgate.api.WGAPIException

Sets a local WebTML variable to WebTML module scope (if available).

Parameters:

name - Variable name

value - Variable value

Throws:

de.innovationgate.webgate.api.WGAPIException

setLocalVar

void setLocalVar(java.lang.String name,
               java.lang.Object value)
                 throws de.innovationgate.webgate.api.WGAPIException

Sets a local WebTML variable to the scope of this design context

Parameters:

name - Variable name

value - Variable value

Throws:

de.innovationgate.webgate.api.WGAPIException

retrieveLocalVar

java.lang.Object retrieveLocalVar(java.lang.String name)
                                  throws de.innovationgate.webgate.api.WGAPIException

Retrieves the value of a local WebTML variable. Must return NullPlaceHolder instance of no variable was found.

Parameters:

name - Variable name

Throws:

de.innovationgate.webgate.api.WGAPIException

removeLocalVar

java.lang.Object removeLocalVar(java.lang.String name)
                                throws de.innovationgate.webgate.api.WGAPIException

Removes a local WebTML variable. In an environment with cascaded scopes removes the variable of the given name on the nearest scope in the hierarchy. Must return NullPlaceHolder instance of no variable was found.

Parameters:

name - Variable name

Returns:

Value of removed variable

Throws:

de.innovationgate.webgate.api.WGAPIException

getOption

TMLOption getOption(java.lang.String name)
                    throws de.innovationgate.webgate.api.WGException

Returns a WebTML option of the current design context

Parameters:

name - Option name

Throws:

de.innovationgate.webgate.api.WGException

setOption

void setOption(java.lang.String name,
             java.lang.Object value,
             java.lang.String scope)
               throws de.innovationgate.webgate.api.WGException

Defines a WebTML option on WebTML module scope (if available).

Parameters:

name - Option name

value - Option value

scope - Option inheritance scope. Use TMLOption.SCOPE_... constants

Throws:

de.innovationgate.webgate.api.WGException

setDownwardOption

void setDownwardOption(java.lang.String name,
                     java.lang.Object value,
                     java.lang.String scope)
                       throws de.innovationgate.webgate.api.WGException

Defines a WebTML option on the scope of the current design context

Parameters:

name - Option name

value - Option value

scope - Option inheritance scope. Use TMLOption.SCOPE_... constants

Throws:

de.innovationgate.webgate.api.WGException

getOptionNames

java.util.List<java.lang.String> getOptionNames()
                                                throws de.innovationgate.webgate.api.WGException

Returns the names of WebTML options known on this design context

Throws:

de.innovationgate.webgate.api.WGException

removeOption

void removeOption(java.lang.String name)
                  throws de.innovationgate.webgate.api.WGException

Parameters:

Removes - a WebTML option on the current design context

Throws:

de.innovationgate.webgate.api.WGException

getDesignDB

de.innovationgate.webgate.api.WGDatabase getDesignDB()

Returns the design application for this design context

getBaseReference

DesignResourceReference getBaseReference()

Returnrs the base reference of the design that uses this design context

getVersionCompliance

de.innovationgate.wga.common.beans.csconfig.v1.Version getVersionCompliance()

Gets the version compliance of the design that uses this design context

getMinimumWGAVersion

de.innovationgate.wga.common.beans.csconfig.v1.Version getMinimumWGAVersion()

Gets the minimum version for OpenWGA of the design that uses this design context

getMediaKey

java.lang.String getMediaKey()
                             throws de.innovationgate.webgate.api.WGException

Returns the WebTML media key of the design that uses this design context

Throws:

de.innovationgate.webgate.api.WGException

addWarning

void addWarning(TMLContext cx,
              java.lang.String msg,
              boolean severe,
              java.lang.Throwable cause)

Adds a WebTML warning to the design context

Parameters:

cx - WebTML context

msg - Message

severe - Whether the message indicates a cancelled tag execution

cause - Optional cause exception

createContextDelegate

TMLDesignContext createContextDelegate(de.innovationgate.webgate.api.WGDatabase designdb,
                                     java.lang.String baseReference)

Creates a delegate of this design context type for the given design reference information

Parameters:

designdb - The design application

baseReference - The base reference