de.innovationgate.wga.server.api

Class DesignContext

java.lang.Object

de.innovationgate.wga.server.api.DesignContext

All Implemented Interfaces:

TMLDesignContext

public class DesignContext
extends java.lang.Object
implements TMLDesignContext

A design context implementation for the server API, used when outside any WebTML/TMLScript environment

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
boolean	equals(java.lang.Object obj)
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
int	hashCode()
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).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTag

public BaseTagStatus getTag()

Description copied from interface: TMLDesignContext

Returns the associated WebTML tag with this design context

Specified by:

getTag in interface TMLDesignContext

getDesignDB

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

Description copied from interface: TMLDesignContext

Returns the design application for this design context

Specified by:

getDesignDB in interface TMLDesignContext

getBaseReference

public DesignResourceReference getBaseReference()

Description copied from interface: TMLDesignContext

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

Specified by:

getBaseReference in interface TMLDesignContext

getVersionCompliance

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

Description copied from interface: TMLDesignContext

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

Specified by:

getVersionCompliance in interface TMLDesignContext

addWarning

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

Description copied from interface: TMLDesignContext

Adds a WebTML warning to the design context

Specified by:

addWarning in interface TMLDesignContext

Parameters:

cx - WebTML context

msg - Message

severe - Whether the message indicates a cancelled tag execution

cause - Optional cause exception

createContextDelegate

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

Description copied from interface: TMLDesignContext

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

Specified by:

createContextDelegate in interface TMLDesignContext

Parameters:

designdb - The design application

baseReference - The base reference

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getPortlet

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

Description copied from interface: TMLDesignContext

Returns the portlet associated with this design context

Specified by:

getPortlet in interface TMLDesignContext

Throws:

de.innovationgate.webgate.api.WGAPIException

getOption

public TMLOption getOption(java.lang.String name)

Description copied from interface: TMLDesignContext

Returns a WebTML option of the current design context

Specified by:

getOption in interface TMLDesignContext

Parameters:

name - Option name

setOption

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

Description copied from interface: TMLDesignContext

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

Specified by:

setOption in interface TMLDesignContext

Parameters:

name - Option name

value - Option value

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

Throws:

de.innovationgate.webgate.api.WGNotSupportedException

setDownwardOption

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

Description copied from interface: TMLDesignContext

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

Specified by:

setDownwardOption in interface TMLDesignContext

Parameters:

name - Option name

value - Option value

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

Throws:

de.innovationgate.webgate.api.WGNotSupportedException

getOptionNames

public java.util.List<java.lang.String> getOptionNames()

Description copied from interface: TMLDesignContext

Returns the names of WebTML options known on this design context

Specified by:

getOptionNames in interface TMLDesignContext

getMediaKey

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

Description copied from interface: TMLDesignContext

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

Specified by:

getMediaKey in interface TMLDesignContext

Throws:

de.innovationgate.webgate.api.WGException

removeOption

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

Specified by:

removeOption in interface TMLDesignContext

Throws:

de.innovationgate.webgate.api.WGNotSupportedException

getMinimumWGAVersion

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

Description copied from interface: TMLDesignContext

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

Specified by:

getMinimumWGAVersion in interface TMLDesignContext

setLocalVarOnModule

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

Description copied from interface: TMLDesignContext

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

Specified by:

setLocalVarOnModule in interface TMLDesignContext

Parameters:

name - Variable name

value - Variable value

Throws:

de.innovationgate.webgate.api.WGAPIException

setLocalVar

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

Description copied from interface: TMLDesignContext

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

Specified by:

setLocalVar in interface TMLDesignContext

Parameters:

name - Variable name

value - Variable value

Throws:

de.innovationgate.webgate.api.WGAPIException

retrieveLocalVar

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

Description copied from interface: TMLDesignContext

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

Specified by:

retrieveLocalVar in interface TMLDesignContext

Parameters:

name - Variable name

Throws:

de.innovationgate.webgate.api.WGAPIException

removeLocalVar

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

Description copied from interface: TMLDesignContext

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.

Specified by:

removeLocalVar in interface TMLDesignContext

Parameters:

name - Variable name

Returns:

Value of removed variable

Throws:

de.innovationgate.webgate.api.WGAPIException