de.innovationgate.wga.server.api.tml

Interface Context

All Known Implementing Classes:

TMLContext

public interface Context

The Context is the base object of the WebTML runtime. It combines two purposes: It represents the document context under which a WebTML functionality is executed, mostly the context of some WebTML tag or TMLScript script. That is it points to a special content document and offers it's item and metadata fields, just like and do in WebTML. It offers the most frequently used TMLScript functionalities as methods, like for example many condition tests, context changes, and access to WGAPI objects This object is the same as the TMLContext object in TMLScript. Documentation on this object and its methods in more detail can therefor be found on the TMLScript reference of the OpenWGA documenation library of the respective OpenWGA version for Object "TMLContext".

Method Summary

Methods

Modifier and Type	Method and Description
void	addwarning(java.lang.String msg) Adds a custom WebTML warning
void	addwarning(java.lang.String msg, boolean severe) Adds a custom WebTML warning
void	addwarning(java.lang.String msg, boolean severe, java.lang.Throwable cause) Adds a custom WebTML warning
void	appendvar(java.lang.String name, java.lang.Object value) Appends a value to a WebTML variable as list element
de.innovationgate.webgate.api.WGContent	content() Provides the WGAPI object "WGContent" which represents the current content document in context
java.lang.String	contenturl() Returns a URL to the content document in context
java.lang.String	contenturl(java.lang.String mediaKey, java.lang.String layoutKey) Returns a URL to the content document in context
java.lang.String	contenturl(java.lang.String mediaKey, java.lang.String layoutKey, boolean ignoreVirtualLink) Returns a URL to the content document in context
Context	context(java.lang.String expression) Creates a TMLContext object for a different content document.
Context	context(java.lang.String expression, boolean returnContextOnError) Creates a TMLContext object for a different content document.
Context	context(de.innovationgate.webgate.api.WGContent content) Takes a content document in form of the WGAPI object "WGContent" and constructs a TMLContext object that has it in context.
PortletEvent	createevent(java.lang.String name) Creates a new PortletEvent object
de.innovationgate.webgate.api.WGDatabase	db() Returns a WGAPI database object for the database of the current context
java.lang.String	fileurl(java.lang.String fileName) Creates a URL pointing to a file attachment on the current context document
java.lang.String	fileurl(java.lang.String containerName, java.lang.String fileName) Creates a URL pointing to a file attachment on a content document or file container in the context database
java.lang.String	fileurl(java.lang.String dbKey, java.lang.String containerName, java.lang.String fileName) Creates a URL pointing to a file attachment on a content document or file container
javax.servlet.http.HttpSession	gethttpsession() Returns the JavaEE object representing the current HTTP browser session
java.lang.String	getlasterror() Returns the error message of the last failed context expression that was done from this context object
org.apache.log4j.Logger	getlog() Provides an object for logging output to the application log
java.lang.String	getpath() Returns an absolute context path to the current context document
Portlet	getportlet() Returns a portlet object for the current WebTML portlet
UserProfile	getprofile() Returns the users personalisation profile as profile object
javax.servlet.http.HttpServletRequest	getrequest() Returns the JavaEE object representing the current HTTP browser request
javax.servlet.http.HttpServletResponse	getresponse() Returns the JavaEE object representing the current HTTP server response
java.lang.Object	getsessionvar(java.lang.String name) Retrieves a WebTML session variable
Form	gettmlform() Returns the TMLForm object representing the current WebTML form
java.lang.Object	getvar(java.lang.String name) Retrieves a normal WebTML variable
boolean	haschildren() Returns if the current context document has child documents
boolean	hasgroup(java.lang.String group) Tests if the user is member of the specified group
boolean	haslabel(java.lang.String key) Tests if a label is available for the given key that can be served to the user Uses either the default label container/file or the one determined for the current WebTML range.
boolean	haslabel(java.lang.String fileName, java.lang.String key) Tests if a label is available for the given key that can be served to the user Uses either the default label container "labels_language" or the one determined for the current WebTML range.
boolean	haslabel(java.lang.String containerName, java.lang.String fileName, java.lang.String key) Tests if a label is available for the given key that can be served to the user
boolean	hasoption(java.lang.String option) Tests if an WebTML option of the given name is defined
boolean	hasprofile() Returns if the user currently has a user profile
boolean	hasrole(java.lang.String role) Tests if the user has the given user role
boolean	hassiblings() Returns if the current context document has sibling documents
de.innovationgate.webgate.api.WGHierarchicalDatabase	hdb() Returns a WGAPI HDB object for the application in context
boolean	isanonymous() Tests if the current user is anonymous
boolean	isbrowserinterface() Returns true if the WebTML page is rendered in some kind of OpenWGA authoring client like the OpenWGA Content Manager
boolean	isdefined(java.lang.String name) Tests if a name is defined as WebTML variable or item on the context document
boolean	isempty(java.lang.String itemName) Returns if the given WebTML variable or item is regarded "empty".
boolean	isemptyvalue(java.lang.Object value) Returns if the given value is regarded "empty" Empty means being either nonexistent, null, empty/whitespace-only string, an empty list or a string with a single HTML linebreak
boolean	isfilled(java.lang.String attValue) Returns if the contents of an item or WebTML variable is regarded as "filled", meaning it is not empty like defined on isempty(String).
boolean	isfirstloop() Tests if a tag is in its first iteration.
boolean	isfirstloop(java.lang.String tagId) Tests if a tag is in its first iteration.
boolean	ishomepage()
boolean	islastloop() Tests if a tag is in its last iteration.
boolean	islastloop(java.lang.String tagId) Tests if a tag is in its last iteration.
boolean	ismaindocument() Returns if the document in context is the main document of the request
boolean	isnewsession() Returns if the current request is the first request in a new browser session
boolean	isroot() Returns if the current context document is a root document
boolean	isselected() Returns if the current document is the main document of the current request or an ancestor document of it
boolean	isselected(Context mainContext) Returns if the current document is either the document of the given main context or an ancestor document of it
boolean	istagidvalid(java.lang.String tagid) Tests if a WebTML tag with the given id is available
boolean	istrue(java.lang.String varname) Returns if the contents of an item or WebTML variable is regarded "true".
boolean	iswebenvironment() Returns if the current TMLScript code is executed in the context of a WebTML request
java.lang.Object	item(java.lang.String name) Returns the value of an item or a WebTML variable as single value.
java.util.List<java.lang.Object>	itemlist(java.lang.String name) Returns the value of an item or WebTML variable as list value
java.lang.String	label(java.lang.String key) Returns a WebTML label in a language that the current user should understand.
java.lang.String	label(java.lang.String key, java.util.List<java.lang.String> params) Returns a WebTML label in a language that the current user should understand.
java.lang.String	label(java.lang.String fileName, java.lang.String key) Returns a WebTML label in a language that the current user should understand.
java.lang.String	label(java.lang.String fileName, java.lang.String key, java.util.List<java.lang.String> params) Returns a WebTML label in a language that the current user should understand.
java.lang.String	label(java.lang.String containerName, java.lang.String fileName, java.lang.String key) Returns a WebTML label in a language that the current user should understand.
java.lang.String	label(java.lang.String containerName, java.lang.String fileName, java.lang.String key, java.util.List<java.lang.String> params) Returns a WebTML label in a language that the current user should understand.
java.lang.String	label(java.lang.String containerName, java.lang.String fileName, java.lang.String key, java.util.List<java.lang.String> params, boolean usePlaceholder) Returns a WebTML label in a language that the current user should understand.
java.lang.String	label(de.innovationgate.webgate.api.WGDatabase designDB, java.lang.String containerName, java.lang.String fileName, java.lang.String key, java.util.List<java.lang.String> params) Returns a WebTML label in a language that the current user should understand.
java.lang.String	label(de.innovationgate.webgate.api.WGDatabase designDB, java.lang.String containerName, java.lang.String fileName, java.lang.String key, java.util.List<java.lang.String> params, boolean usePlaceholder) Returns a WebTML label in a language that the current user should understand.
java.lang.Object	meta(java.lang.String name) Returns the value of a metadata field of type "content" as single value.
java.lang.Object	meta(java.lang.String type, java.lang.String name) Returns the value of a metadata field as single value.
java.util.List<java.lang.Object>	metalist(java.lang.String name) Returns the value of a metadata field of type "content" as list value.
java.util.List<java.lang.Object>	metalist(java.lang.String type, java.lang.String name) Returns the value of a metadata field as list value.
java.lang.Object	option(java.lang.String option) Retrieves the value of a WebTML option.
java.lang.Object	option(java.lang.String option, java.lang.Object defaultValue) Retrieves the value of a WebTML option.
Portlet	portletbypath(java.lang.String path) Retrieves a portlet by a portlet path expression
void	removesessionvar(java.lang.String name) Removes a WebTML session variable
void	removetmlform(java.lang.String formid) Removes the form of the given ID from form registry
void	removevar(java.lang.String name) Removes a (normal) WebTML variable
void	setoption(java.lang.String name, java.lang.Object value) Sets a WebTML option
void	setoption(java.lang.String name, java.lang.Object value, java.lang.String scope) Sets a WebTML option
void	setsessionvar(java.lang.String name, java.lang.Object value) Sets or updates a WebTML session variable.
void	setsessionvar(java.lang.String name, java.lang.Object value, boolean allowSerialisation) Sets or updates a WebTML session variable.
void	setvar(java.lang.String name, java.lang.Object value) Creates or updates a (normal) WebTML variable
java.lang.Object	taginfo(java.lang.String tagId, java.lang.String name) Retrieves a WebTML tag information
Form	tmlformbyid(java.lang.String id) Returns a TMLForm object representing the WebTML form of the given ID

Method Detail

addwarning

void addwarning(java.lang.String msg)

Adds a custom WebTML warning

Parameters:

msg - Message of the warning

addwarning

void addwarning(java.lang.String msg,
              boolean severe)

Adds a custom WebTML warning

Parameters:

msg - Message of the warning

severe - Flag that marks the warning as "severe". Severe warnings will cancel the execution of the current functionality and wil be displayed with a different icon in . Defaults to false.

addwarning

void addwarning(java.lang.String msg,
              boolean severe,
              java.lang.Throwable cause)

Adds a custom WebTML warning

Parameters:

msg - Message of the warning

severe - Flag that marks the warning as "severe". Severe warnings will cancel the execution of the current functionality and wil be displayed with a different icon in . Defaults to false.

cause - A Java exception that caused the warning. It's stack trace will be put out to the log, if warnings logging is enabled

appendvar

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

Appends a value to a WebTML variable as list element

Parameters:

name - Name of a WebTML variable

value - Value to append as list element to the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

content

de.innovationgate.webgate.api.WGContent content()

Provides the WGAPI object "WGContent" which represents the current content document in context

contenturl

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

Returns a URL to the content document in context

Throws:

de.innovationgate.webgate.api.WGException

contenturl

java.lang.String contenturl(java.lang.String mediaKey,
                          java.lang.String layoutKey)
                            throws de.innovationgate.webgate.api.WGException

Returns a URL to the content document in context

Parameters:

mediaKey - Mediakey of the WebTML module that should be used as outer layout for the document. Specify null to render it with its content types layouts.

layoutKey - Name of the WebTML module that should be used as outer layout for the document. Specify null to render it with its content types layouts.

Throws:

de.innovationgate.webgate.api.WGException

contenturl

java.lang.String contenturl(java.lang.String mediaKey,
                          java.lang.String layoutKey,
                          boolean ignoreVirtualLink)
                            throws de.innovationgate.webgate.api.WGException

Returns a URL to the content document in context

Parameters:

mediaKey - Mediakey of the WebTML module that should be used as outer layout for the document. Specify null to render it with its content types layouts.

layoutKey - Name of the WebTML module that should be used as outer layout for the document. Specify null to render it with its content types layouts.

ignoreVirtualLink - If true and the context document is virtual this method returns a normal URL to the virtual document instead of the virtual target URL.

Throws:

de.innovationgate.webgate.api.WGException

context

Context context(java.lang.String expression)

Creates a TMLContext object for a different content document. This method offers the same functionality as the WebTML attribute context. It received a context expression, retrieves the content document that is addressed by it and returns a TMLContext object that has this document in context.

Parameters:

expression - An OpenWGA context expression. Syntax is identical to that of WebTML attribute context

Returns:

A TMLContext that matches the content that was addressed in the context expression. If context change fails returns the original TMLContext.

context

Context context(java.lang.String expression,
              boolean returnContextOnError)

Creates a TMLContext object for a different content document. This method offers the same functionality as the WebTML attribute context. It received a context expression, retrieves the content document that is addressed by it and returns a TMLContext object that has this document in context.

Parameters:

expression - An OpenWGA context expression. Syntax is identical to that of WebTML attribute context

returnContextOnError - Determines if on context change error the original context is to be returned. If false this method returns null on a failed context change.

Returns:

A TMLContext that matches the content that was addressed in the context expression. If context change fails returns either the original TMLContext or null if parameter "returnContextOnError" was set to false.

context

Context context(de.innovationgate.webgate.api.WGContent content)
                throws de.innovationgate.webgate.api.WGAPIException

Takes a content document in form of the WGAPI object "WGContent" and constructs a TMLContext object that has it in context.

Parameters:

content - The WGAPI content object

Returns:

A TMLContext representing the given content document

Throws:

de.innovationgate.webgate.api.WGAPIException

createevent

PortletEvent createevent(java.lang.String name)

Creates a new PortletEvent object

Parameters:

name - Name of the portlet event. All event receivers subscribing to this name will receive it when it is thrown.

db

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

Returns a WGAPI database object for the database of the current context

fileurl

java.lang.String fileurl(java.lang.String fileName)
                         throws java.io.UnsupportedEncodingException,
                                de.innovationgate.webgate.api.WGException

Creates a URL pointing to a file attachment on the current context document

Parameters:

fileName - Name of the file attachment on file container or content document. If the file is a ZIP archive you can address files inside it by specifying the path in the ZIP file after the name, divided by slashes.

Returns:

URL pointing to a file attachment

Throws:

java.io.UnsupportedEncodingException

de.innovationgate.webgate.api.WGException

fileurl

java.lang.String fileurl(java.lang.String containerName,
                       java.lang.String fileName)
                         throws de.innovationgate.webgate.api.WGException

Creates a URL pointing to a file attachment on a content document or file container in the context database

Parameters:

containerName - Name of a file container or key of a content document

fileName - Name of the file attachment on file container or content document. If the file is a ZIP archive you can address files inside it by specifying the path in the ZIP file after the name, divided by slashes.

Returns:

URL pointing to a file attachment

Throws:

de.innovationgate.webgate.api.WGException

fileurl

java.lang.String fileurl(java.lang.String dbKey,
                       java.lang.String containerName,
                       java.lang.String fileName)
                         throws de.innovationgate.webgate.api.WGException

Creates a URL pointing to a file attachment on a content document or file container

Parameters:

dbKey - Database key of the database whose file is to be served.

containerName - Name of a file container or key of a content document

fileName - Name of the file attachment on file container or content document. If the file is a ZIP archive you can address files inside it by specifying the path in the ZIP file after the name, divided by slashes.

Returns:

URL pointing to a file attachment

Throws:

de.innovationgate.webgate.api.WGException

gethttpsession

javax.servlet.http.HttpSession gethttpsession()

Returns the JavaEE object representing the current HTTP browser session

getlasterror

java.lang.String getlasterror()

Returns the error message of the last failed context expression that was done from this context object

getlog

org.apache.log4j.Logger getlog()

Provides an object for logging output to the application log

getpath

java.lang.String getpath()
                         throws de.innovationgate.webgate.api.WGAPIException

Returns an absolute context path to the current context document

Throws:

de.innovationgate.webgate.api.WGAPIException

getportlet

Portlet getportlet()
                   throws de.innovationgate.webgate.api.WGAPIException

Returns a portlet object for the current WebTML portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

getprofile

UserProfile getprofile()

Returns the users personalisation profile as profile object

getrequest

javax.servlet.http.HttpServletRequest getrequest()

Returns the JavaEE object representing the current HTTP browser request

getresponse

javax.servlet.http.HttpServletResponse getresponse()

Returns the JavaEE object representing the current HTTP server response

getsessionvar

java.lang.Object getsessionvar(java.lang.String name)

Retrieves a WebTML session variable

gettmlform

Form gettmlform()

Returns the TMLForm object representing the current WebTML form

getvar

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

Retrieves a normal WebTML variable

Throws:

de.innovationgate.webgate.api.WGAPIException

haschildren

boolean haschildren()
                    throws de.innovationgate.webgate.api.WGAPIException

Returns if the current context document has child documents

Throws:

de.innovationgate.webgate.api.WGAPIException

hasgroup

boolean hasgroup(java.lang.String group)
                 throws de.innovationgate.webgate.api.WGAPIException

Tests if the user is member of the specified group

Throws:

de.innovationgate.webgate.api.WGAPIException

haslabel

boolean haslabel(java.lang.String key)

Tests if a label is available for the given key that can be served to the user Uses either the default label container/file or the one determined for the current WebTML range.

Parameters:

key - The label key

haslabel

boolean haslabel(java.lang.String fileName,
               java.lang.String key)

Tests if a label is available for the given key that can be served to the user Uses either the default label container "labels_language" or the one determined for the current WebTML range.

Parameters:

fileName - Label file holding label definitions. Omit the suffix ".properties".

key - The label key

haslabel

boolean haslabel(java.lang.String containerName,
               java.lang.String fileName,
               java.lang.String key)

Tests if a label is available for the given key that can be served to the user

Parameters:

containerName - Label container base name. Omit the language suffix.

fileName - Label file holding label definitions. Omit the suffix ".properties".

key - The label key

hasoption

boolean hasoption(java.lang.String option)

Tests if an WebTML option of the given name is defined

hasprofile

boolean hasprofile()

Returns if the user currently has a user profile

hasrole

boolean hasrole(java.lang.String role)
                throws de.innovationgate.webgate.api.WGAPIException

Tests if the user has the given user role

Throws:

de.innovationgate.webgate.api.WGAPIException

hassiblings

boolean hassiblings()
                    throws de.innovationgate.webgate.api.WGAPIException

Returns if the current context document has sibling documents

Throws:

de.innovationgate.webgate.api.WGAPIException

hdb

de.innovationgate.webgate.api.WGHierarchicalDatabase hdb()
                                                         throws de.innovationgate.webgate.api.WGException

Returns a WGAPI HDB object for the application in context

Throws:

de.innovationgate.webgate.api.WGException

isanonymous

boolean isanonymous()
                    throws de.innovationgate.webgate.api.WGAPIException

Tests if the current user is anonymous

Throws:

de.innovationgate.webgate.api.WGAPIException

isbrowserinterface

boolean isbrowserinterface()

Returns true if the WebTML page is rendered in some kind of OpenWGA authoring client like the OpenWGA Content Manager

isdefined

boolean isdefined(java.lang.String name)
                  throws de.innovationgate.webgate.api.WGAPIException

Tests if a name is defined as WebTML variable or item on the context document

Parameters:

name - Name of WebTML variable or item

Throws:

de.innovationgate.webgate.api.WGAPIException

isempty

boolean isempty(java.lang.String itemName)
                throws de.innovationgate.webgate.api.WGAPIException

Returns if the given WebTML variable or item is regarded "empty". Empty means being either nonexistent, null, empty/whitespace-only string, an empty list or a string with a single HTML linebreak

Parameters:

itemName - Name of a WebTML variable or item

Throws:

de.innovationgate.webgate.api.WGAPIException

isemptyvalue

boolean isemptyvalue(java.lang.Object value)

Returns if the given value is regarded "empty" Empty means being either nonexistent, null, empty/whitespace-only string, an empty list or a string with a single HTML linebreak

Parameters:

value - Value to test

isfilled

boolean isfilled(java.lang.String attValue)
                 throws de.innovationgate.webgate.api.WGAPIException

Returns if the contents of an item or WebTML variable is regarded as "filled", meaning it is not empty like defined on isempty(String). This method returns always true when in authoring mode for a document.

Parameters:

attValue - The name of the item or WebTML variable

Throws:

de.innovationgate.webgate.api.WGAPIException

isfirstloop

boolean isfirstloop()

Tests if a tag is in its first iteration. This method uses the "nearest" tag of that type up the tag cascading hierarchy.

isfirstloop

boolean isfirstloop(java.lang.String tagId)

Tests if a tag is in its first iteration.

Parameters:

tagId - id of the foreach tag

islastloop

boolean islastloop()

Tests if a tag is in its last iteration. This method uses the "nearest" tag of that type up the tag cascading hierarchy.

islastloop

boolean islastloop(java.lang.String tagId)

Tests if a tag is in its last iteration.

Parameters:

tagId - id of the foreach tag

ismaindocument

boolean ismaindocument()
                       throws de.innovationgate.webgate.api.WGAPIException

Returns if the document in context is the main document of the request

Throws:

de.innovationgate.webgate.api.WGAPIException

isnewsession

boolean isnewsession()

Returns if the current request is the first request in a new browser session

isroot

boolean isroot()
               throws de.innovationgate.webgate.api.WGAPIException

Returns if the current context document is a root document

Throws:

de.innovationgate.webgate.api.WGAPIException

isselected

boolean isselected()
                   throws de.innovationgate.webgate.api.WGAPIException

Returns if the current document is the main document of the current request or an ancestor document of it

Throws:

de.innovationgate.webgate.api.WGAPIException

isselected

boolean isselected(Context mainContext)
                   throws de.innovationgate.webgate.api.WGAPIException

Returns if the current document is either the document of the given main context or an ancestor document of it

Throws:

de.innovationgate.webgate.api.WGAPIException

istagidvalid

boolean istagidvalid(java.lang.String tagid)

Tests if a WebTML tag with the given id is available

Parameters:

tagid -

istrue

boolean istrue(java.lang.String varname)
               throws de.innovationgate.webgate.api.WGAPIException

Returns if the contents of an item or WebTML variable is regarded "true". Values that are regarded true: JavaScript/Java boolean value of true, the string "true", a numeric value of 1 or -1

Parameters:

varname - The name of the item or WebTML variable

Throws:

de.innovationgate.webgate.api.WGAPIException

iswebenvironment

boolean iswebenvironment()

Returns if the current TMLScript code is executed in the context of a WebTML request

item

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

Returns the value of an item or a WebTML variable as single value.

Parameters:

name - Name of the item or WebTML variable

Throws:

de.innovationgate.webgate.api.WGAPIException

itemlist

java.util.List<java.lang.Object> itemlist(java.lang.String name)
                                          throws de.innovationgate.webgate.api.WGAPIException

Returns the value of an item or WebTML variable as list value

Parameters:

name - Name of the item or WebTML variable

Throws:

de.innovationgate.webgate.api.WGAPIException

label

java.lang.String label(java.lang.String key)

Returns a WebTML label in a language that the current user should understand. This variant uses either default the label container/file or the ones specified for the current WebTML range

Parameters:

key - The label key

label

java.lang.String label(java.lang.String key,
                     java.util.List<java.lang.String> params)

Returns a WebTML label in a language that the current user should understand. This variant uses either default the label container/file or the ones specified for the current WebTML range

Parameters:

key - The label key

params - Label parameters that are injected into the label text

label

java.lang.String label(java.lang.String fileName,
                     java.lang.String key)

Returns a WebTML label in a language that the current user should understand. This variant uses either the label container or the one specified for the current WebTML range

Parameters:

fileName - Label file holding label definitions. Omit the suffix ".properties".

key - The label key

label

java.lang.String label(java.lang.String fileName,
                     java.lang.String key,
                     java.util.List<java.lang.String> params)

Returns a WebTML label in a language that the current user should understand. This variant uses either the label container or the one specified for the current WebTML range

Parameters:

fileName - Label file holding label definitions. Omit the suffix ".properties".

key - The label key

params - Label parameters that are injected into the label text

label

java.lang.String label(java.lang.String containerName,
                     java.lang.String fileName,
                     java.lang.String key)

Returns a WebTML label in a language that the current user should understand. This variant uses either the label container or the one specified for the current WebTML range

Parameters:

containerName - Label container base name. Omit the language suffix.

fileName - Label file holding label definitions. Omit the suffix ".properties".

key - The label key

label

java.lang.String label(java.lang.String containerName,
                     java.lang.String fileName,
                     java.lang.String key,
                     java.util.List<java.lang.String> params)

Returns a WebTML label in a language that the current user should understand. This variant uses either the label container or the one specified for the current WebTML range

Parameters:

containerName - Label container base name. Omit the language suffix.

fileName - Label file holding label definitions. Omit the suffix ".properties".

key - The label key

params - Label parameters that are injected into the label text

label

java.lang.String label(java.lang.String containerName,
                     java.lang.String fileName,
                     java.lang.String key,
                     java.util.List<java.lang.String> params,
                     boolean usePlaceholder)

Returns a WebTML label in a language that the current user should understand. This variant uses either the label container or the one specified for the current WebTML range

Parameters:

containerName - Label container base name. Omit the language suffix.

fileName - Label file holding label definitions. Omit the suffix ".properties".

key - The label key

params - Label parameters that are injected into the label text

usePlaceholder - Specify true to return a label placeholder in case the label does not exist. Specify false to return null in that case.

label

java.lang.String label(de.innovationgate.webgate.api.WGDatabase designDB,
                     java.lang.String containerName,
                     java.lang.String fileName,
                     java.lang.String key,
                     java.util.List<java.lang.String> params)
                       throws de.innovationgate.webgate.api.WGException

Returns a WebTML label in a language that the current user should understand. This variant uses either the label container or the one specified for the current WebTML range

Parameters:

designDB - The WGAPI database object of the app from which to load labels

containerName - Label container base name. Omit the language suffix.

fileName - Label file holding label definitions. Omit the suffix ".properties".

key - The label key

params - Label parameters that are injected into the label text

Throws:

de.innovationgate.webgate.api.WGException

label

java.lang.String label(de.innovationgate.webgate.api.WGDatabase designDB,
                     java.lang.String containerName,
                     java.lang.String fileName,
                     java.lang.String key,
                     java.util.List<java.lang.String> params,
                     boolean usePlaceholder)
                       throws de.innovationgate.webgate.api.WGException

Returns a WebTML label in a language that the current user should understand. This variant uses either the label container or the one specified for the current WebTML range

Parameters:

designDB - The WGAPI database object of the app from which to load labels

containerName - Label container base name. Omit the language suffix.

fileName - Label file holding label definitions. Omit the suffix ".properties".

key - The label key

params - Label parameters that are injected into the label text

usePlaceholder - Specify true to return a label placeholder in case the label does not exist. Specify false to return null in that case.

Throws:

de.innovationgate.webgate.api.WGException

meta

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

Returns the value of a metadata field of type "content" as single value.

Parameters:

name - The name of the metadata field

Throws:

de.innovationgate.webgate.api.WGAPIException

meta

java.lang.Object meta(java.lang.String type,
                    java.lang.String name)
                      throws de.innovationgate.webgate.api.WGAPIException

Returns the value of a metadata field as single value.

Parameters:

type - The type of metadata field

name - The name of the metadata field

Throws:

de.innovationgate.webgate.api.WGAPIException

metalist

java.util.List<java.lang.Object> metalist(java.lang.String name)
                                          throws de.innovationgate.webgate.api.WGAPIException

Returns the value of a metadata field of type "content" as list value.

Parameters:

name - The name of the metadata field

Throws:

de.innovationgate.webgate.api.WGAPIException

metalist

java.util.List<java.lang.Object> metalist(java.lang.String type,
                                        java.lang.String name)
                                          throws de.innovationgate.webgate.api.WGAPIException

Returns the value of a metadata field as list value.

Parameters:

type - The type of metadata field

name - The name of the metadata field

Throws:

de.innovationgate.webgate.api.WGAPIException

option

java.lang.Object option(java.lang.String option)

Retrieves the value of a WebTML option. Return null if the option does not exist.

Parameters:

option - Name of the option

option

java.lang.Object option(java.lang.String option,
                      java.lang.Object defaultValue)

Retrieves the value of a WebTML option.

Parameters:

option - Name of the option

defaultValue - A value to return if the option does not exist

portletbypath

Portlet portletbypath(java.lang.String path)
                      throws de.innovationgate.webgate.api.WGException

Retrieves a portlet by a portlet path expression

Parameters:

path - The portlet path

Throws:

de.innovationgate.webgate.api.WGException

removesessionvar

void removesessionvar(java.lang.String name)

Removes a WebTML session variable

Parameters:

name - Name of the variable

removetmlform

void removetmlform(java.lang.String formid)

Removes the form of the given ID from form registry

Parameters:

formid - Id of the form

removevar

void removevar(java.lang.String name)
               throws de.innovationgate.webgate.api.WGAPIException

Removes a (normal) WebTML variable

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

setoption

void setoption(java.lang.String name,
             java.lang.Object value)

Sets a WebTML option

Parameters:

name - Name of the option

value - Value of the option

setoption

void setoption(java.lang.String name,
             java.lang.Object value,
             java.lang.String scope)

Sets a WebTML option

Parameters:

name - Name of the option

value - Value of the option

scope - Scope of the option. Use strings "global" or "local".

setsessionvar

void setsessionvar(java.lang.String name,
                 java.lang.Object value)

Sets or updates a WebTML session variable. Variables set by this variant are allowed for serialisation.

Parameters:

name - Name of the variable

value - Value of the variable

setsessionvar

void setsessionvar(java.lang.String name,
                 java.lang.Object value,
                 boolean allowSerialisation)

Sets or updates a WebTML session variable.

Parameters:

name - Name of the variable

value - Value of the variable

allowSerialisation - Determines if the variable value can be serialized and therefor transported to other nodes in a cluster

setvar

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

Creates or updates a (normal) WebTML variable

Parameters:

name - Name of the variable

value - Value of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

taginfo

java.lang.Object taginfo(java.lang.String tagId,
                       java.lang.String name)
                         throws de.innovationgate.webgate.api.WGAPIException

Retrieves a WebTML tag information

Parameters:

tagId - id of the tag to retrieve the info from

name - Nmae of the info field

Throws:

de.innovationgate.webgate.api.WGAPIException

tmlformbyid

Form tmlformbyid(java.lang.String id)

Returns a TMLForm object representing the WebTML form of the given ID

Parameters:

id - id of the form

ishomepage

boolean ishomepage()