public interface TMLDesignContext
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).
|
BaseTagStatus getTag()
TMLPortlet getPortlet() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
void setLocalVarOnModule(java.lang.String name, java.lang.Object value) throws de.innovationgate.webgate.api.WGAPIException
name
- Variable namevalue
- Variable valuede.innovationgate.webgate.api.WGAPIException
void setLocalVar(java.lang.String name, java.lang.Object value) throws de.innovationgate.webgate.api.WGAPIException
name
- Variable namevalue
- Variable valuede.innovationgate.webgate.api.WGAPIException
java.lang.Object retrieveLocalVar(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
NullPlaceHolder
instance of no variable was found.name
- Variable namede.innovationgate.webgate.api.WGAPIException
java.lang.Object removeLocalVar(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
NullPlaceHolder
instance of no variable was found.name
- Variable namede.innovationgate.webgate.api.WGAPIException
TMLOption getOption(java.lang.String name) throws de.innovationgate.webgate.api.WGException
name
- Option namede.innovationgate.webgate.api.WGException
void setOption(java.lang.String name, java.lang.Object value, java.lang.String scope) throws de.innovationgate.webgate.api.WGException
name
- Option namevalue
- Option valuescope
- Option inheritance scope. Use TMLOption.SCOPE_... constantsde.innovationgate.webgate.api.WGException
void setDownwardOption(java.lang.String name, java.lang.Object value, java.lang.String scope) throws de.innovationgate.webgate.api.WGException
name
- Option namevalue
- Option valuescope
- Option inheritance scope. Use TMLOption.SCOPE_... constantsde.innovationgate.webgate.api.WGException
java.util.List<java.lang.String> getOptionNames() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
void removeOption(java.lang.String name) throws de.innovationgate.webgate.api.WGException
Removes
- a WebTML option on the current design contextde.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGDatabase getDesignDB()
DesignResourceReference getBaseReference()
de.innovationgate.wga.common.beans.csconfig.v1.Version getVersionCompliance()
de.innovationgate.wga.common.beans.csconfig.v1.Version getMinimumWGAVersion()
java.lang.String getMediaKey() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
void addWarning(TMLContext cx, java.lang.String msg, boolean severe, java.lang.Throwable cause)
cx
- WebTML contextmsg
- Messagesevere
- Whether the message indicates a cancelled tag executioncause
- Optional cause exceptionTMLDesignContext createContextDelegate(de.innovationgate.webgate.api.WGDatabase designdb, java.lang.String baseReference)
designdb
- The design applicationbaseReference
- The base reference