WGA (OpenWGA 7.1 Server API)

java.lang.Object
- de.innovationgate.wga.server.api.WGA

```
public class WGA
extends Object
```
Base class for the WGA Server API, providing access to all of the APIs functionalities. Use one of the get() methods to aquire an instance using different context objects for parameters:
- get() when running on behalf of a WebTML/TMLScript environment
- get(Context) when a WebTML context object is available
- #get(JobContext) in OpenWGA Java Jobs
- get(HttpServletRequest, HttpServletResponse, ServletContext) or get(ServletContext) in Servlet Filters
- get(WGACore) in other core functionalities
The number of available services may differ depending on the context object for which this instance was created. If a functionality needs a WGA resource that is not available on the context it throws an UnavailableResourceException.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`WGARequestInformation`	`accessLogging()` Returns the request information object for the current WebTML request to modify access logging data
`String`	`alias(String str, List<String> aliases)` Returns an alias for a string value from a list of WebTML aliases.
`String`	`alias(String str, String aliasesStr)` Returns an alias for a string value from a WebTML aliases string The aliases string given as parameter is expected to consist of a comma-separated list of elements of value plus corresponding alias, divided by a pipe symbol: alias\|value,alias\|value,alias\|value ...
`App`	`app()` Returns an application object for the current environment This will only work in WebTML/TMLScript environments and returns the object of the main context app.
`App`	`app(Context cx)` Returns an application object for the WebTML context This will only work if the context database represents an OpenWGA application.
`App`	`app(String dbKey)` Returns an application object for the database of the given key This will only work if the database represents an OpenWGA application.
`App`	`app(de.innovationgate.webgate.api.WGDatabase db)` Returns an application object for the given database This will only work if the database represents an OpenWGA application.
`Auth`	`auth()` Deprecated. Instead use `Domain.auth()` to get a domain specific authentication object.
`List<String>`	`buildOptions(Iterable<de.innovationgate.webgate.api.WGContent> contents, String titleExpr, String emptyTitle)` Builds options for WebTML form inputs from a list of contents Use this method to build the options of WebTML form inputs whose choices are based on content documents.
`Object`	`callAction(Context context, String actionID, List actionArgs, DesignResourceReference baseReference, GlobalExpressionScope globalScope)` Calls a WebTML action This can be used to call WebTML actions that are defined in any allowed way, including master and async actions.
`Object`	`callAction(String actionID, List actionArgs, DesignResourceReference baseReference, GlobalExpressionScope globalScope)` Calls a WebTML action This can be used to call WebTML actions that are defined in any allowed way, including master and async actions.
`Calendar`	`createCalendar()` Creates a Java Calendar object offering diverse functionality to modify date values This method is provided for TMLScript.
`Calendar`	`createCalendar(Date date)` Creates a Java Calendar object offering diverse functionality to modify date values This method is provided for TMLScript.
`Cookie`	`createCookie(String name, String value)` Creates a browser cookie object that can be added to the users browser session This method is provided for TMLScript.
`Date`	`createDate(boolean includeMillis)` Creates a new `Date` object for the current time.
`Form`	`createForm(FormInfo formInfo)` Creates a new TMLForm object as configured by a FormInfo object.
`FormInfo`	`createFormInfo(String id, boolean htmlInput, boolean persistent)` Creates a new FormInfo object Objects of this type define settings for creating TMLForm objects from Java and TMLScript.
`org.apache.commons.httpclient.HttpClient`	`createHttpClient()` Creates an object to do custom HTTP requests The returned object is an instance of the Jakarta Commons HTTP Client, a Java class providing extensive functionality to perform HTTP requests.
`de.innovationgate.utils.ImageScaler`	`createImageScaler(File file)` Creates an ImageScaler object to perform scaling operations on an image file.
`de.innovationgate.utils.ImageScaler`	`createImageScaler(InputStream in)` Creates an ImageScaler object to perform scaling operations on an image provided by an input stream ImageScaler objects are capable of scaling images to custom sizes.
`List`	`createList()` Creates a list object.
`List`	`createList(Object[] array)` Creates a list object from an array..
`List`	`createList(String collection, String delimiter)` Creates an list object from a collection string with delimiter.
`Map`	`createLookupTable()` Creates a map, known to TMLScript as "lookup table" This method is provided for TMLScript.
`Map`	`createLookupTable(Map map)` Creates a map, known to TMLScript as "lookup table", initializing it with the given maps entries This method is provided for TMLScript.
`Mail`	`createMail()` Creates a Mail object for sending e-mails.
`Mail`	`createMail(String smtpHost, String username, String password)` Creates a Mail object for sending e-mails.
`Context`	`createTMLContext(de.innovationgate.webgate.api.WGContent content)` Creates an WebTML context object for the given content If a WebTML environment is available this context will belong to this environment.
`Context`	`createTMLContext(de.innovationgate.webgate.api.WGContent content, Design design)` Creates an WebTML context object for the given content If a WebTML environment is available this context will belong to this environment.
`Context`	`createTMLContext(de.innovationgate.webgate.api.WGDatabase db)` Creates an WebTML context object for the given database The context will be on a dummy document of the given database.
`Context`	`createTMLContext(de.innovationgate.webgate.api.WGDatabase db, Design design)` Creates an WebTML context object for the given database The context will be on a dummy document of the given database.
`Context`	`createTMLContext(de.innovationgate.webgate.api.WGDatabase db, de.innovationgate.webgate.api.WGLanguageChooser chooser)` Creates an WebTML context object for the given database, using the given language chooser The context will be on a dummy document of the given database.
`Context`	`createTMLContext(de.innovationgate.webgate.api.WGDatabase db, de.innovationgate.webgate.api.WGLanguageChooser chooser, Design design)` Creates an WebTML context object for the given database, using the given language chooser The context will be on a dummy document of the given database.
`Database`	`database()` Returns a database object for the current environment.
`Database`	`database(Context cx)` Returns a database object for the WebTML context This either returns an `App` or `DataSource` object, depending on the database type
`Database`	`database(String dbKey)` Returns a database object for the database of the given key This either returns an `App` or `DataSource` object, depending on the database type
`Database`	`database(de.innovationgate.webgate.api.WGDatabase db)` Returns a database object for the given database This either returns an `App` or `DataSource` object, depending on the database type
`DataSource`	`dataSource()` Returns a data source object for the current environment This will only work in WebTML/TMLScript environments and returns the object of the main context data source.
`DataSource`	`dataSource(Context cx)` Returns a data source object for the WebTML context This will only work if the context database represents an OpenWGA data source.
`DataSource`	`dataSource(String dbKey)` Returns an application object for the database of the given key This will only work if the database represents an OpenWGA application.
`DataSource`	`dataSource(de.innovationgate.webgate.api.WGDatabase db)` Returns a data source object for the given database This will only work if the database represents an OpenWGA data source.
`Date`	`dateOnly(Date date)` Removes all daytime information from a date This method returns a new date which represents the date give but has hour, minute, second and millisecond information set to 0.
`de.innovationgate.webgate.api.WGDatabase`	`db(String dbKey)` Returns the WGAPI database object for the given database key When accessing a database that has not yet been accessed in this request OpenWGA will try to login the user to this database, using whatever login information is available on the session.
`de.innovationgate.webgate.api.WGDatabase`	`db(String dbKey, boolean open)` Returns the WGAPI database object for the given database key When accessing a database that has not yet been accessed in this request and parameter "open" is true then OpenWGA will try to login the user to this database, using whatever login information is available on the session.
`List<Object>`	`deleteDoublets(List<Object> lObj)` Removes multiple equal entries from a list.
`Object`	`deserializeObject(String encrypted)` Converts a string created by `serializeObject(Object)` back to the original object.
`Design`	`design()` Returns a design context object for the current environment This will only work in WebTML/TMLScript environments and returns the design of the main context app.
`Design`	`design(String dbKey)` Returns a design context object for the database of the given key This will only work if the database represents an OpenWGA application.
`Design`	`design(TMLDesignContext designContext)` Returns a design context object for the given WebTML design context The parameter object is an object of the WebTML implementation.
`Design`	`design(de.innovationgate.webgate.api.WGDatabase db)` Returns a design context object for the given database This will only work if the database represents an OpenWGA application.
`Domain`	`domain(String name)` Returns a domain object for the domain of the given name
`String`	`encode(String encoding, Object obj)` Encodes some text with a WebTML encoding This is the server API pendant of WebTML attribute encode.
`String`	`format(Object toBeFormatted, String formatString)` reates a formatted date string from a `Date` object or a formatted number string from a `Number` object
`String`	`format(Object toBeFormatted, String formatString, String language)` reates a formatted date string from a `Date` object or a formatted number string from a `Number` object
`static WGA`	`get()` Retrieves an WGA instance using the current threads main WebTML context for a context This method can be used in some Java code that runs on behalf of any WebTML/TMLScript functionality in the same thread.
`static WGA`	`get(Context context)` Returns a WGA instance using the given TMLContext object for a context.
`static WGA`	`get(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)` Returns a WGA instance using the given JavaEE objects for a context, for use in HTTP servlet requests.
`static WGA`	`get(HttpServletRequest request, HttpServletResponse response, WGACore core)` Returns a WGA instance using the given JavaEE objects for a context, for use in HTTP servlet requests.
`static WGA`	`get(ServletContext servletContext)` Returns a WGA instance using the given servlet context for a context.
`static WGA`	`get(WGAContext context)` Returns a WGA instance using the given `WGAContext` object for a context.
`static WGA`	`get(WGACore core)` Returns a WGA instance using the given `WGACore` object for a context.
`WGACore`	`getCore()` Returns the WGACore object in context
`DateFormat`	`getDateFormat(String pattern, Locale locale)` Returns an OpenWGA date format
`org.apache.log4j.Logger`	`getLog()` Returns a logging facility appropriate for the current WGA environment
`NumberFormat`	`getNumberFormat(String pattern, Locale locale)` Returns an OpenWGA number format
`HttpServletRequest`	`getRequest()` Returns the HTTP servlet request of the environment Will only work if the environment runs on behalf of a request
`String`	`getRequestURL()` Returns the URL by which this request was called This is the original URL which was used to call the current WebTML request.
`HttpServletResponse`	`getResponse()` Returns the HTTP servlet response of the environment Will only work if the environment runs on behalf of a request
`de.innovationgate.webgate.api.WGHierarchicalDatabase`	`hdb(String dbKey)` Returns a WGAPI HDB object for an application The HDB database object is a tool to use a OpenWGA content store as a simple hierarchical database for data storage.
`Html`	`html()` Returns a subobject "Html" which collects functionalities to load and parse Html documents.
`<T> T`	`instantiateService(Class<?> implementationClass)` Instantiates a specific service API implementation
`<T> T`	`instantiateService(de.innovationgate.wga.modules.ModuleDefinition implDef)` Instantiates a specific service API implementation
`boolean`	`isRequestAvailable()` Returns if the environmente runs on behalf of a request and a request object is available
`boolean`	`isResponseAvailable()` Returns if the environmente runs on behalf of a request and a response object is available
`boolean`	`isTMLContextAvailable()` Returns if a WebTML/TMLScript environment is available
`Jobs`	`jobs()` Returns a subobject "Jobs" providing services regarding OpenWGA Jobs
`Lucene`	`lucene(Context context)` Returns a Lucene object providing functionalities related to fulltext search
`Date`	`modifyDate(Date date, String unit, int amount)` Modifies a date by adding/substracting a certain timespan This is a utility method for simple modifications to dates without the use of `Calendar` objects. it returns a new `Date` object which represents the date of the parameter "date" plus/minus a given timespan.
`Nav`	`nav()` Returns a Nav object for the current WebTML context
`Nav`	`nav(Context context)` Returns a Nav Object for the given WebTML context
`boolean`	`openDatabase(de.innovationgate.webgate.api.WGDatabase db)` Opens an WGAPI database object with the credentials available in the current environment.
`Date`	`parseDate(String date, String format)` Converts a string containing date/time information to a `Date` object This method parses the given string based on a custom date format and return it as date object.
`Date`	`parseDate(String date, String format, String language)` Converts a string containing date/time information to a `Date` object This method parses the given string based on a custom date format and return it as date object.
`Number`	`parseNumber(String number, String format)` Converts a string containing numeric information into a Number object This method parses the given string based on a custom number format and return it as `Number` object.
`Number`	`parseNumber(String number, String format, String language)` Converts a string containing numeric information into a Number object This method parses the given string based on a custom number format and return it as `Number` object.
`Plugin`	`plugin(String uniqueName)` Returns a Plugin object for any OpenWGA plugin of the given unique nam.
`Plugin`	`plugin(de.innovationgate.webgate.api.WGDatabase db)` Returns a Plugin object for the WGAPI database object.
`void`	`redirectTo(String url)` Redirects the users browser to a different URL This method is only valid in WebTML environments and is only effective on a request if no content has yet been sent back to the browser.
`void`	`reopenSessions()` Reopens all currently open database sessions
`String`	`scoped(String str, String scope)` Qualifies the given text with the current WebTML scope This is the WGA Server API pendant to the dynamic WebTML attribute function "{scoped:text}".
`de.innovationgate.webgate.api.WGFileDerivateMetaData`	`selectDerivate(Context cx, String fileName, String derivateQueryStr)` Selects a file derivate of a file attachment which is the best match for a derivate query
`de.innovationgate.webgate.api.WGFileDerivateMetaData`	`selectDerivate(String fileName, String derivateQuery)` Selects a file derivate of a file attachment which is the best match for a derivate query.
`String`	`serializeObject(Object obj)` Serializes an object to an encrypted string The resulting string is a representation of the given object as string which is compressed as well as encrypted.
`Server`	`server()` Returns a subobject "Server" providing information and services regarding the OpenWGA server runtime and installation
`<T> T`	`service(Class<T> serviceClass)` Returns a service implementation for the given service API class/interface
`List<Class<?>>`	`serviceClasses()` Returns classes and interfaces of service APIs currently registered for this WGA runtime
`List`	`sortList(Object listObj, Object comparatorObj, int sortDir)` Sorts a List, either by a `Comparator` or, if the list contains `WGDocument` instances, by one or more metadata fields.
`Date`	`timeOnly(Date date)` Removes all day information from a date This method returns a new date which represents the date give but has day, month and day information set to 0.
`Context`	`tmlcontext()` Returns the WebTML context of the environment Will only work in those environments that run on behalf of WebTML functionalties, like WebTML elements etc.
`TMLScript`	`tmlscript()` Returns a subobject "TMLScript" for executing TMLScript expressions
`List<Object>`	`toList(Object... values)` Converts any value(s) into list form This method does the same list conversion known from itemList() or metaList() in TMLScript on the given values.
`URLBuilder`	`urlBuilder()` Creates a WGAPI URLBuilder object to contruct and modify URLs, using the current request URL
`URLBuilder`	`urlBuilder(Context context)` Creates a WGAPI URLBuilder object to contruct and modify URLs, using the current request URL
`URLBuilder`	`urlBuilder(Context context, String urlStr)` Creates a WGAPI URLBuilder object to contruct and modify URLs
`URLBuilder`	`urlBuilder(String urlStr)` Creates a WGAPI URLBuilder object to contruct and modify URLs.
`Validate`	`validate()` Returns a subobject "Validate" offering comfortable functions to validate data in common ways, prominently in WebTML form validations.
`Xml`	`xml()` Returns a subobject "Xml" which collects functionalities to load and parse Xml documents.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - get
```
public static WGA get()
               throws de.innovationgate.webgate.api.WGException
```
    Retrieves an WGA instance using the current threads main WebTML context for a context This method can be used in some Java code that runs on behalf of any WebTML/TMLScript functionality in the same thread. The returned WGA instance provides full service. Note however that the context used may not be the most specific context of your threads stack.
    
    Throws:
    
    IllegalStateException
    
    de.innovationgate.webgate.api.WGException
  - get
```
public static WGA get(WGAContext context)
```
    Returns a WGA instance using the given WGAContext object for a context. The service provided depends on the context known by the WGAContext object.
    
    Parameters:
    
    context - A WGA context object
  - get
```
public static WGA get(Context context)
```
    Returns a WGA instance using the given TMLContext object for a context. The returned instance provides full service.
    
    Parameters:
    
    context - A TMLContext object
  - get
```
public static WGA get(ServletContext servletContext)
```
    Returns a WGA instance using the given servlet context for a context. The instance provided may have no WebTML/TMLScript/Request specific functionalities available.
    
    Parameters:
    
    servletContext - The servlet context
  - get
```
public static WGA get(HttpServletRequest request,
                      HttpServletResponse response,
                      ServletContext servletContext)
```
    Returns a WGA instance using the given JavaEE objects for a context, for use in HTTP servlet requests. The instance provided may have no WebTML/TMLScript specific functionalities available.
    
    Parameters:
    
    request - A HTTP request object
    
    response - A HTTP response object
    
    servletContext - A servlet context object
  - get
```
public static WGA get(HttpServletRequest request,
                      HttpServletResponse response,
                      WGACore core)
```
    Returns a WGA instance using the given JavaEE objects for a context, for use in HTTP servlet requests. The instance provided may have no WebTML/TMLScript specific functionalities available.
    
    Parameters:
    
    request - A HTTP request object
    
    response - A HTTP response object
    
    core - The internal OpenWGA core object
  - get
```
public static WGA get(WGACore core)
```
    Returns a WGA instance using the given WGACore object for a context. The instance provided may have no WebTML/TMLScript/Request specific functionalities available.
    
    Parameters:
    
    core - WGA core object
  - getCore
```
public WGACore getCore()
```
    Returns the WGACore object in context
  - format
```
public String format(Object toBeFormatted,
                     String formatString,
                     String language)
              throws de.innovationgate.webgate.api.WGException
```
    reates a formatted date string from a Date object or a formatted number string from a Number object
    
    Parameters:
    
    toBeFormatted - Either a Date or a Number
    
    formatString - The format pattern, just like known from SimpleDateFormat or DecimalFormat
    
    language - A language string determining the language for language dependent formattings
    
    Returns:
    
    String representing the Date/Number in the specified format
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - format
```
public String format(Object toBeFormatted,
                     String formatString)
              throws de.innovationgate.webgate.api.WGException
```
    reates a formatted date string from a Date object or a formatted number string from a Number object
    
    Parameters:
    
    toBeFormatted - Either a Date or a Number
    
    formatString - The format pattern, just like known from SimpleDateFormat or DecimalFormat
    
    Returns:
    
    String representing the Date/Number in the specified format
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - sortList
```
public List sortList(Object listObj,
                     Object comparatorObj,
                     int sortDir)
              throws de.innovationgate.webgate.api.WGException
```
    Sorts a List, either by a Comparator or, if the list contains WGDocument instances, by one or more metadata fields. The sorting is done in place, i.e. the given list object is sorted.
    
    Parameters:
    
    listObj - The list to be sorted
    
    comparatorObj - Comparator object, either a List of metadata names, or a String containing a metadata name, or a Comparator
    
    sortDir - Sort direction, either "up" or "down".
    
    Returns:
    
    The list
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - deleteDoublets
```
public List<Object> deleteDoublets(List<Object> lObj)
```
    Removes multiple equal entries from a list. This method is provided to the TMLScript API. In Java it has little sense as Sets can be used for the same thing.
    
    Parameters:
    
    lObj - The list
    
    Returns:
    
    List with removed duplicates
  - callAction
```
public Object callAction(Context context,
                         String actionID,
                         List actionArgs,
                         DesignResourceReference baseReference,
                         GlobalExpressionScope globalScope)
                  throws de.innovationgate.webgate.api.WGException
```
    Calls a WebTML action This can be used to call WebTML actions that are defined in any allowed way, including master and async actions. This however needs an WebTML environment in context. In case of a master action the call is automatically executed in a separate session. Data changes done in this master action will not be automatically visible to the calling code as its current database session will not pick them up. To have the updated state in the calling code you can reopen the current session of changed databases after the action call, but note that this will drop all unsaved changes to these databases from the calling session. In case of an async action the call of the action is triggered but the calling TMLScript code continues while the action is executed. Parameters param1 to param5 are given as argument list "actionArgs", element 0 to 4. They will be available to the action as WebTML variables "tmlparam1" to "tmlparam5" and as List object "actionParams" containing the params as list elements 0 to 4.
    
    Parameters:
    
    context - TMLContext ot execute the action on. Specify null to use one from WGA object context.
    
    actionID - ID of the action to call. This may be the ID of a tag or the name of a TMLScript module. If you want to call an action that is defined in a different applications design you may prefix the ID with the database key of this application plus a slash. So to call an action "actions:doit" from application "myapp", use "myapp/actions:doit" as ID parameter.
    
    actionArgs - Parameters for the action, available as "tmlparam1" (index 0) to "tmlparam5" (index 4)
    
    baseReference - The base reference from which to resolve the action id.
    
    globalScope - The global expression scope under which to execute the action. Specify null to have none.
    
    Returns:
    
    Return value of the action, null if there is none
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - callAction
```
public Object callAction(String actionID,
                         List actionArgs,
                         DesignResourceReference baseReference,
                         GlobalExpressionScope globalScope)
                  throws de.innovationgate.webgate.api.WGException
```
    Calls a WebTML action This can be used to call WebTML actions that are defined in any allowed way, including master and async actions. This however needs an WebTML environment in context. In case of a master action the call is automatically executed in a separate session. Data changes done in this master action will not be automatically visible to the calling code as its current database session will not pick them up. To have the updated state in the calling code you can reopen the current session of changed databases after the action call, but note that this will drop all unsaved changes to these databases from the calling session. In case of an async action the call of the action is triggered but the calling TMLScript code continues while the action is executed. Parameters param1 to param5 are given as argument list "actionArgs", element 0 to 4. They will be available to the action as WebTML variables "tmlparam1" to "tmlparam5" and as List object "actionParams" containing the params as list elements 0 to 4.
    
    Parameters:
    
    actionID - ID of the action to call. This may be the ID of a tag or the name of a TMLScript module. If you want to call an action that is defined in a different applications design you may prefix the ID with the database key of this application plus a slash. So to call an action "actions:doit" from application "myapp", use "myapp/actions:doit" as ID parameter.
    
    actionArgs - Parameters for the action, available as "tmlparam1" (index 0) to "tmlparam5" (index 4)
    
    baseReference - The base reference from which to resolve the action id.
    
    globalScope - The global expression scope under which to execute the action. Specify null to have none.
    
    Returns:
    
    Return value of the action, null if there is none
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - serializeObject
```
public String serializeObject(Object obj)
                       throws de.innovationgate.webgate.api.WGException
```
    Serializes an object to an encrypted string The resulting string is a representation of the given object as string which is compressed as well as encrypted. It works with trivial data objects like String, Number, Boolean or Date, also with List, Map or JavaBeans containing those type of objects. Uses this function to either use complex objects on places that only allow strings (for example on WebTML action parameters) or to prevent any data from being manipulated by the browser user when it needs to be transported to and returned from the browser. Use deserializeObject(String) to convert the string back to the originating object.
    
    Parameters:
    
    obj - Object to serialize
    
    Returns:
    
    The serialized object
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - deserializeObject
```
public Object deserializeObject(String encrypted)
                         throws de.innovationgate.webgate.api.WGException
```
    Converts a string created by serializeObject(Object) back to the original object. The object returned by this method is in fact an exact copy of the object that was used on serializeObject() with the exact same data. So in terms of object equality and identity it is "equal" but not "the same".
    
    Parameters:
    
    encrypted - Serialized object
    
    Returns:
    
    Deserialized object
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - scoped
```
public String scoped(String str,
                     String scope)
              throws de.innovationgate.webgate.api.WGException
```
    Qualifies the given text with the current WebTML scope This is the WGA Server API pendant to the dynamic WebTML attribute function "{scoped:text}". It can be used for any text that should be qualified with the current WebTML scope, so it won't collide with other usages of this text in its domain.
    
    Parameters:
    
    str - The string to scope.
    
    scope - The scope. Specify null to use scope from current WebTML context
    
    Returns:
    
    The scoped string
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - plugin
```
public Plugin plugin(String uniqueName)
              throws de.innovationgate.webgate.api.WGException
```
    Returns a Plugin object for any OpenWGA plugin of the given unique nam. This method can be used to retrieve information about any active OpenWGA plugin. It will not return invalid or inactive plugins.
    
    Parameters:
    
    uniqueName - Plugin unique name
    
    Returns:
    
    Plugin object
    
    Throws:
    
    de.innovationgate.webgate.api.WGAPIException
    
    de.innovationgate.webgate.api.WGException
  - plugin
```
public Plugin plugin(de.innovationgate.webgate.api.WGDatabase db)
              throws de.innovationgate.webgate.api.WGException
```
    Returns a Plugin object for the WGAPI database object. The WGAPI database object must belong to the database of a plugin.
    
    Parameters:
    
    db - The WGAPI database object
    
    Returns:
    
    Plugin object
    
    Throws:
    
    de.innovationgate.webgate.api.WGAPIException
    
    de.innovationgate.webgate.api.WGException
  - lucene
```
public Lucene lucene(Context context)
              throws de.innovationgate.webgate.api.WGException
```
    Returns a Lucene object providing functionalities related to fulltext search
    
    Parameters:
    
    context - WebTML context for the lucene object.
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - parseDate
```
public Date parseDate(String date,
                      String format,
                      String language)
               throws de.innovationgate.webgate.api.WGException,
                      ParseException
```
    Converts a string containing date/time information to a Date object This method parses the given string based on a custom date format and return it as date object. Use date format strings known from SimpleDateFormat
    
    Parameters:
    
    date - The date string
    
    format - The format string
    
    language - The language string of the language to use for parsing language dependent date parts
    
    Returns:
    
    The parsed date
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
    
    ParseException - If the string is unparseable for the given date format
  - parseDate
```
public Date parseDate(String date,
                      String format)
               throws de.innovationgate.webgate.api.WGException,
                      ParseException
```
    Converts a string containing date/time information to a Date object This method parses the given string based on a custom date format and return it as date object. Use date format strings known from SimpleDateFormat
    
    Parameters:
    
    date - The date string
    
    format - The format string
    
    Returns:
    
    The parsed date
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
    
    ParseException - If the string is unparseable for the given date format
  - createDate
```
public Date createDate(boolean includeMillis)
                throws de.innovationgate.webgate.api.WGException
```
    Creates a new Date object for the current time. This method is provided for TMLScript. In Java one can simply construct a Date object.
    
    Parameters:
    
    includeMillis - true ot include milliseconds in time
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - modifyDate
```
public Date modifyDate(Date date,
                       String unit,
                       int amount)
                throws de.innovationgate.webgate.api.WGException
```
    Modifies a date by adding/substracting a certain timespan This is a utility method for simple modifications to dates without the use of Calendar objects. it returns a new Date object which represents the date of the parameter "date" plus/minus a given timespan. In order to add a timespan one is first to choose which time unit to use via argument "unit" and then the amount of units to add via argument "amount". In order to substract a timespan from the date a negative amount value is to be used. The unit is determined by the date string character that would be used by SimpleDateFormat for the time unit:
    - d" or "D" - Day
    - "M" - Month
    - "w" or "W" - Week
    - "y" - Year
    - "H" or "h" - Hour
    - "m" - Minute
    - "s" - Second
    - "S" - Millisecond
    Parameters:
    
    date - Date to modify
    
    unit - Modify unit. See table above.
    
    amount - Amount of date units to add to the date. Specify negative amounts to substract.
    
    Returns:
    
    The modified date
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - createForm
```
public Form createForm(FormInfo formInfo)
                throws de.innovationgate.webgate.api.WGException
```
    Creates a new TMLForm object as configured by a FormInfo object. While TMLForm objects are mostly created implicitly by the WebTML tag this method provides the possibility to create a form in Java. This is only useful in WebTML environments where the form can actually be used. The created form object can then be used by a subsequent tag to offer it for editing. For that to work the id of the form tag must match the ID of the created form object.
    
    Parameters:
    
    formInfo - Form info object
    
    Returns:
    
    A new TMLForm object
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - createFormInfo
```
public FormInfo createFormInfo(String id,
                               boolean htmlInput,
                               boolean persistent)
                        throws de.innovationgate.webgate.api.WGException
```
    Creates a new FormInfo object Objects of this type define settings for creating TMLForm objects from Java and TMLScript. Use this object on method createForm(FormInfo) to finally create a TMLForm object. This method creates form info objects that belong to the design of the current WebTML context and behave according to its settings.
    
    Parameters:
    
    id - Form id
    
    htmlInput - Determines if the form will accept plain HTML inputs
    
    persistent - Determines if the form will be persistent
    
    Returns:
    
    new form info object
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - createImageScaler
```
public de.innovationgate.utils.ImageScaler createImageScaler(File file)
                                                      throws de.innovationgate.webgate.api.WGException,
                                                             IOException
```
    Creates an ImageScaler object to perform scaling operations on an image file. ImageScaler objects are capable of scaling images to custom sizes. This method needs the image to be available as a file in the servers file system.
    
    Parameters:
    
    file - The file to scale
    
    Returns:
    
    An image scaler object with the file loaded
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
    
    de.innovationgate.wga.modules.ModuleInstantiationException
    
    IOException
  - createImageScaler
```
public de.innovationgate.utils.ImageScaler createImageScaler(InputStream in)
                                                      throws de.innovationgate.webgate.api.WGException,
                                                             IOException
```
    Creates an ImageScaler object to perform scaling operations on an image provided by an input stream ImageScaler objects are capable of scaling images to custom sizes.
    
    Parameters:
    
    in - Stream providing image data
    
    Returns:
    
    An image scaler object with the file loaded
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
    
    de.innovationgate.wga.modules.ModuleInstantiationException
    
    IOException
  - createList
```
public List createList()
```
    Creates a list object. This method is provided for TMLScript. In Java one can simply instantiate an ArrayList or other list variants.
  - createList
```
public List createList(Object[] array)
```
    Creates a list object from an array.. This method is provided for TMLScript. In Java one can simply use Arrays.asList(Object...).
  - createList
```
public List createList(String collection,
                       String delimiter)
```
    Creates an list object from a collection string with delimiter. This method is provided for TMLScript. In Java one can simply use WGUtils.deserializeCollection(String, String) and variants.
    
    Parameters:
    
    collection -
    
    delimiter -
  - createLookupTable
```
public Map createLookupTable(Map map)
```
    Creates a map, known to TMLScript as "lookup table", initializing it with the given maps entries This method is provided for TMLScript. In Java one can simply instantiate a HashMap or other map variants.
    
    Parameters:
    
    map - Map providing entries
    
    Returns:
    
    New map
  - createLookupTable
```
public Map createLookupTable()
```
    Creates a map, known to TMLScript as "lookup table" This method is provided for TMLScript. In Java one can simply instantiate a HashMap or other map variants.
    
    Returns:
    
    New map
  - createMail
```
public Mail createMail()
                throws UnsupportedEncodingException,
                       de.innovationgate.webgate.api.WGException
```
    Creates a Mail object for sending e-mails. This variant uses the mail configuration of the OpenWGA server.
    
    Returns:
    
    A new Mail object
    
    Throws:
    
    UnsupportedEncodingException
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - createMail
```
public Mail createMail(String smtpHost,
                       String username,
                       String password)
                throws de.innovationgate.webgate.api.WGException,
                       UnsupportedEncodingException
```
    Creates a Mail object for sending e-mails. This variant receives host, username and password of the SMTP account.
    
    Parameters:
    
    smtpHost - The host name
    
    username - The user name of the account
    
    password - The password of the account
    
    Returns:
    
    A new Mail object
    
    Throws:
    
    UnsupportedEncodingException
    
    de.innovationgate.webgate.api.WGException
  - parseNumber
```
public Number parseNumber(String number,
                          String format,
                          String language)
                   throws ParseException,
                          de.innovationgate.webgate.api.WGException
```
    Converts a string containing numeric information into a Number object This method parses the given string based on a custom number format and return it as Number object. You must specify the number format that the string contains in parameter "format" using the syntax known from DecimalFormat.
    
    Parameters:
    
    format - The number format string
    
    number - The number string
    
    language - Language string of language to use for language-dependent parts of the number string.
    
    Returns:
    
    The parsed number
    
    Throws:
    
    ParseException - If the string is unparseable for the given number format
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - parseNumber
```
public Number parseNumber(String number,
                          String format)
                   throws ParseException,
                          de.innovationgate.webgate.api.WGException
```
    Converts a string containing numeric information into a Number object This method parses the given string based on a custom number format and return it as Number object. You must specify the number format that the string contains in parameter "format" using the syntax known from DecimalFormat.
    
    Parameters:
    
    format - The date format string
    
    number - The number string
    
    Returns:
    
    The parsed number
    
    Throws:
    
    ParseException - If the string is unparseable for the given number format
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - db
```
public de.innovationgate.webgate.api.WGDatabase db(String dbKey)
                                            throws de.innovationgate.webgate.api.WGException
```
    Returns the WGAPI database object for the given database key When accessing a database that has not yet been accessed in this request OpenWGA will try to login the user to this database, using whatever login information is available on the session. If that fails - bc. the user has no access - the database is still returned but has no open session. You can test the availability of an open session by WGDatabase.isSessionOpen() The method may return OpenWGA content stores as well as data sources. The method returns null if no database of the given dbkey is connected.
    
    Parameters:
    
    dbKey - Database key
    
    Returns:
    
    The WGAPI database object
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGAPIException
    
    de.innovationgate.webgate.api.WGException
  - db
```
public de.innovationgate.webgate.api.WGDatabase db(String dbKey,
                                                   boolean open)
                                            throws de.innovationgate.webgate.api.WGException
```
    Returns the WGAPI database object for the given database key When accessing a database that has not yet been accessed in this request and parameter "open" is true then OpenWGA will try to login the user to this database, using whatever login information is available on the session. If that fails - bc. the user has no access - the database is still returned but has no open session. You can test the availability of an open session by WGDatabase.isSessionOpen() The method may return OpenWGA content stores as well as data sources. The method returns null if no database of the given dbkey is connected.
    
    Parameters:
    
    dbKey - Database key
    
    open - Whether a session should be opened on the database using the environments authentication information
    
    Returns:
    
    The WGAPI database object
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGAPIException
    
    de.innovationgate.webgate.api.WGException
  - openDatabase
```
public boolean openDatabase(de.innovationgate.webgate.api.WGDatabase db)
                     throws de.innovationgate.webgate.api.WGException
```
    Opens an WGAPI database object with the credentials available in the current environment. In WebTML/TMLScript environments this method tries to use a user login that is available. In other environments it opens a master session on the database. This method ist mostly used internally from WebTML/Server API to open sessions on databases. Occasionally this may be used to open WGAPI databases that were retrieved from other sources.
    
    Parameters:
    
    db - The database to open.
    
    Returns:
    
    true if the database is now open, false if not
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGAPIException
  - hdb
```
public de.innovationgate.webgate.api.WGHierarchicalDatabase hdb(String dbKey)
                                                         throws de.innovationgate.webgate.api.WGException
```
    Returns a WGAPI HDB object for an application The HDB database object is a tool to use a OpenWGA content store as a simple hierarchical database for data storage. Since OpenWGA 5.3 we recommend usage of HDBModel, which builds upon this interface instead of directly using the HDB object.
    
    Parameters:
    
    dbKey - Database key of the application
    
    Returns:
    
    HDB database object
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - encode
```
public String encode(String encoding,
                     Object obj)
              throws de.innovationgate.webgate.api.WGException,
                     de.innovationgate.utils.FormattingException
```
    Encodes some text with a WebTML encoding This is the server API pendant of WebTML attribute encode. You can use all encodings that are available to the current OpenWGA runtime and are also usable on the attribute.
    
    Parameters:
    
    encoding - Name of the encoding, f.e. "html", "rtf"
    
    obj - The text to encode. Non strings will internally be converted to strings.
    
    Returns:
    
    Encoded text
    
    Throws:
    
    de.innovationgate.utils.FormattingException
    
    de.innovationgate.webgate.api.WGException
  - urlBuilder
```
public URLBuilder urlBuilder(Context context,
                             String urlStr)
                      throws de.innovationgate.webgate.api.WGException
```
    Creates a WGAPI URLBuilder object to contruct and modify URLs
    
    Parameters:
    
    context - A WebTML context which is used as application context for the URL to generate (for example to retrieve configurations about protocol ports to use). Specify null to use implicit environment context.
    
    urlStr - Some URL that you want the URLBuilder to modify. It may be an absolute URL or a relative one that will be complemented with the URL of the current request.
    
    Returns:
    
    URL Builder object
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - getRequestURL
```
public String getRequestURL()
                     throws de.innovationgate.webgate.api.WGException
```
    Returns the URL by which this request was called This is the original URL which was used to call the current WebTML request. It may differ from the URL that was interpreted to determine the right WebTML/Content to render as this might have been modified by OpenWGA filters.
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - urlBuilder
```
public URLBuilder urlBuilder(Context context)
                      throws de.innovationgate.webgate.api.WGException
```
    Creates a WGAPI URLBuilder object to contruct and modify URLs, using the current request URL
    
    Parameters:
    
    context - A WebTML context which is used as application context for the URL to generate (for example to retrieve configurations about protocol ports to use). Specify null to use implicit environment context.
    
    Returns:
    
    URL Builder object
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - urlBuilder
```
public URLBuilder urlBuilder(String urlStr)
                      throws de.innovationgate.webgate.api.WGException
```
    Creates a WGAPI URLBuilder object to contruct and modify URLs.
    
    Parameters:
    
    urlStr - Some URL that you want the URLBuilder to modify. It may be an absolute URL or a relative one that will be complemented with the URL of the current request. This variant uses an implicit TMLContext for application context.
    
    Returns:
    
    URL Builder object
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - urlBuilder
```
public URLBuilder urlBuilder()
                      throws de.innovationgate.webgate.api.WGException
```
    Creates a WGAPI URLBuilder object to contruct and modify URLs, using the current request URL
    
    Returns:
    
    URL Builder object
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - redirectTo
```
public void redirectTo(String url)
                throws de.innovationgate.webgate.api.WGException,
                       IOException
```
    Redirects the users browser to a different URL This method is only valid in WebTML environments and is only effective on a request if no content has yet been sent back to the browser. It then cancels the current request (the called WebTML page is neither rendered nor sent to the browser) and directly instructs the users browser to head to the given URL. When used in an AJAX action this method will cancel the rendering of the portlet and trigger a reload of the complete webpage. All other HTTP response or cookie settings that may have been set before in the request are ineffective if this operation is called.
    
    Parameters:
    
    url - The URL to redirect to
    
    Throws:
    
    UnavailableResourceException
    
    IOException
    
    de.innovationgate.webgate.api.WGException
  - buildOptions
```
public List<String> buildOptions(Iterable<de.innovationgate.webgate.api.WGContent> contents,
                                 String titleExpr,
                                 String emptyTitle)
                          throws de.innovationgate.webgate.api.WGException
```
    Builds options for WebTML form inputs from a list of contents Use this method to build the options of WebTML form inputs whose choices are based on content documents. This will be the case if you want to store them as content relations, but may also be the case if you want to store document keys for a choice of documents. The method takes a list of content documents and builds a list of option strings from them. The titles of these options are either the titles of the content documents or the result of a title expression given as parameter. The option values will always be the struct keys of the documents in the list (which is mostly used to store relations to documents of equal languages). Normally the returned options list will only host entries for the content documents in the list. If you specify the "emptyTitle" parameter it will also host an entry for an empty value at the top of the list.
    
    Parameters:
    
    contents - List of WGAPI content objects that should be used to calculate the options
    
    titleExpr - A TMLScript expression that is evaluated against the individual contents to form the title of the options. Omit it to simply use the content titles as option titles.
    
    emptyTitle - A title that is used for an entry that represents an empty value. Omit it to have no empty value entry.
    
    Returns:
    
    A list of strings, representing input options
    
    Throws:
    
    de.innovationgate.webgate.api.WGAPIException
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - dateOnly
```
public Date dateOnly(Date date)
              throws de.innovationgate.webgate.api.WGException
```
    Removes all daytime information from a date This method returns a new date which represents the date give but has hour, minute, second and millisecond information set to 0. So this date represents the day at second 0. This method can be useful if you want to compare dates only on behalf of the day that they represent. Dates that are on the same day but with different daytimes will be equal when run through this method.
    
    Parameters:
    
    date - The date
    
    Returns:
    
    A date object with resetted daytime information
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - timeOnly
```
public Date timeOnly(Date date)
              throws de.innovationgate.webgate.api.WGException
```
    Removes all day information from a date This method returns a new date which represents the date give but has day, month and day information set to 0. So this date represents the time at day 1 on year 1. This method can be useful if you want to compare dates only on behalf of the time that they represent. Dates that are on the same time but for different days will be equal when run through this method.
    
    Parameters:
    
    date - The date
    
    Returns:
    
    A date object with resetted day information
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - createCalendar
```
public Calendar createCalendar(Date date)
                        throws de.innovationgate.webgate.api.WGException
```
    Creates a Java Calendar object offering diverse functionality to modify date values This method is provided for TMLScript. In Java one can simly instantiate a GregorianCalendar.
    
    Parameters:
    
    date - The date to represent
    
    Returns:
    
    The calendar object
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - createCalendar
```
public Calendar createCalendar()
                        throws de.innovationgate.webgate.api.WGException
```
    Creates a Java Calendar object offering diverse functionality to modify date values This method is provided for TMLScript. In Java one can simly instantiate a GregorianCalendar.
    
    Returns:
    
    The calendar object
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - design
```
public Design design(de.innovationgate.webgate.api.WGDatabase db)
              throws de.innovationgate.webgate.api.WGException
```
    Returns a design context object for the given database This will only work if the database represents an OpenWGA application.
    
    Parameters:
    
    db - The database
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - design
```
public Design design()
              throws de.innovationgate.webgate.api.WGException
```
    Returns a design context object for the current environment This will only work in WebTML/TMLScript environments and returns the design of the main context app.
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - design
```
public Design design(String dbKey)
              throws de.innovationgate.webgate.api.WGException
```
    Returns a design context object for the database of the given key This will only work if the database represents an OpenWGA application.
    
    Parameters:
    
    dbKey - The database key
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - design
```
public Design design(TMLDesignContext designContext)
              throws de.innovationgate.webgate.api.WGException
```
    Returns a design context object for the given WebTML design context The parameter object is an object of the WebTML implementation.
    
    Parameters:
    
    designContext - The WebTML design context
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - app
```
public App app()
        throws de.innovationgate.webgate.api.WGException
```
    Returns an application object for the current environment This will only work in WebTML/TMLScript environments and returns the object of the main context app. This will only work if the main context database represents an OpenWGA application.
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - app
```
public App app(de.innovationgate.webgate.api.WGDatabase db)
        throws de.innovationgate.webgate.api.WGException
```
    Returns an application object for the given database This will only work if the database represents an OpenWGA application.
    
    Parameters:
    
    db - The database
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - app
```
public App app(Context cx)
        throws de.innovationgate.webgate.api.WGException
```
    Returns an application object for the WebTML context This will only work if the context database represents an OpenWGA application.
    
    Parameters:
    
    cx - The WebTML context
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - app
```
public App app(String dbKey)
        throws de.innovationgate.webgate.api.WGException
```
    Returns an application object for the database of the given key This will only work if the database represents an OpenWGA application.
    
    Parameters:
    
    dbKey - Key of the database
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - dataSource
```
public DataSource dataSource()
                      throws de.innovationgate.webgate.api.WGException
```
    Returns a data source object for the current environment This will only work in WebTML/TMLScript environments and returns the object of the main context data source. This will only work if the main context database represents an OpenWGA data source.
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - dataSource
```
public DataSource dataSource(de.innovationgate.webgate.api.WGDatabase db)
                      throws de.innovationgate.webgate.api.WGException
```
    Returns a data source object for the given database This will only work if the database represents an OpenWGA data source.
    
    Parameters:
    
    db - The database
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - dataSource
```
public DataSource dataSource(Context cx)
                      throws de.innovationgate.webgate.api.WGException
```
    Returns a data source object for the WebTML context This will only work if the context database represents an OpenWGA data source.
    
    Parameters:
    
    cx - The WebTML context
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - dataSource
```
public DataSource dataSource(String dbKey)
                      throws de.innovationgate.webgate.api.WGException
```
    Returns an application object for the database of the given key This will only work if the database represents an OpenWGA application.
    
    Parameters:
    
    dbKey - Key of the database
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - database
```
public Database database()
                  throws de.innovationgate.webgate.api.WGException
```
    Returns a database object for the current environment. This will only work in WebTML/TMLScript environments and returns the object of the main context database. This either returns an App or DataSource object, depending on the database type
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - database
```
public Database database(de.innovationgate.webgate.api.WGDatabase db)
                  throws de.innovationgate.webgate.api.WGException
```
    Returns a database object for the given database This either returns an App or DataSource object, depending on the database type
    
    Parameters:
    
    db - The database
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - database
```
public Database database(Context cx)
                  throws de.innovationgate.webgate.api.WGException
```
    Returns a database object for the WebTML context This either returns an App or DataSource object, depending on the database type
    
    Parameters:
    
    cx - The WebTML context
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - database
```
public Database database(String dbKey)
                  throws de.innovationgate.webgate.api.WGException
```
    Returns a database object for the database of the given key This either returns an App or DataSource object, depending on the database type
    
    Parameters:
    
    dbKey - Key of the database
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - createCookie
```
public Cookie createCookie(String name,
                           String value)
                    throws de.innovationgate.webgate.api.WGException
```
    Creates a browser cookie object that can be added to the users browser session This method is provided for TMLScript. In Java one can simply instantiate a Cookie object.
    
    Parameters:
    
    name - Cookie name
    
    value - Cookie value
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - createHttpClient
```
public org.apache.commons.httpclient.HttpClient createHttpClient()
                                                          throws de.innovationgate.webgate.api.WGException
```
    Creates an object to do custom HTTP requests The returned object is an instance of the Jakarta Commons HTTP Client, a Java class providing extensive functionality to perform HTTP requests. If a proxy is configured for the system the client object will already be configured to use it.
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - xml
```
public Xml xml()
        throws de.innovationgate.webgate.api.WGException
```
    Returns a subobject "Xml" which collects functionalities to load and parse Xml documents.
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - auth
```
public Auth auth()
```
    Deprecated. Instead use Domain.auth() to get a domain specific authentication object.
    
    Returns a subobject "Auth" which collects functionalities regarding user authentication.
  - html
```
public Html html()
```
    Returns a subobject "Html" which collects functionalities to load and parse Html documents.
  - server
```
public Server server()
```
    Returns a subobject "Server" providing information and services regarding the OpenWGA server runtime and installation
  - isTMLContextAvailable
```
public boolean isTMLContextAvailable()
```
    Returns if a WebTML/TMLScript environment is available
  - tmlcontext
```
public Context tmlcontext()
                   throws de.innovationgate.webgate.api.WGException
```
    Returns the WebTML context of the environment Will only work in those environments that run on behalf of WebTML functionalties, like WebTML elements etc.
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - getRequest
```
public HttpServletRequest getRequest()
                              throws de.innovationgate.webgate.api.WGException
```
    Returns the HTTP servlet request of the environment Will only work if the environment runs on behalf of a request
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - isRequestAvailable
```
public boolean isRequestAvailable()
```
    Returns if the environmente runs on behalf of a request and a request object is available
  - isResponseAvailable
```
public boolean isResponseAvailable()
```
    Returns if the environmente runs on behalf of a request and a response object is available
  - getResponse
```
public HttpServletResponse getResponse()
                                throws de.innovationgate.webgate.api.WGException
```
    Returns the HTTP servlet response of the environment Will only work if the environment runs on behalf of a request
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - createTMLContext
```
public Context createTMLContext(de.innovationgate.webgate.api.WGDatabase db,
                                Design design)
                         throws de.innovationgate.webgate.api.WGException
```
    Creates an WebTML context object for the given database The context will be on a dummy document of the given database. If a WebTML environment is available this context will belong to this environment. It will use its language choosing configuration to choose the dummy docs language. Otherwise this will be a new independent context creating its own environment. It will use the databases default language.
    
    Parameters:
    
    db - The database for which to create the context
    
    design - The design which the context should use for reference on design operations. Specify null to use the design of the database where the content comes from.
    
    Returns:
    
    A new WebTML context object
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - createTMLContext
```
public Context createTMLContext(de.innovationgate.webgate.api.WGDatabase db)
                         throws de.innovationgate.webgate.api.WGException
```
    Creates an WebTML context object for the given database The context will be on a dummy document of the given database. If a WebTML environment is available this context will belong to this environment. It will use its language choosing configuration to choose the dummy docs language. Otherwise this will be a new independent context creating its own environment. It will use the databases default language.
    
    Parameters:
    
    db - The database for which to create the context
    
    Returns:
    
    A new WebTML context object
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - createTMLContext
```
public Context createTMLContext(de.innovationgate.webgate.api.WGDatabase db,
                                de.innovationgate.webgate.api.WGLanguageChooser chooser,
                                Design design)
                         throws de.innovationgate.webgate.api.WGException
```
    Creates an WebTML context object for the given database, using the given language chooser The context will be on a dummy document of the given database. If a WebTML environment is available this context will belong to this environment. Otherwise this will be a new independent context creating its own environment.
    
    Parameters:
    
    db - The database for which to create the context
    
    chooser - A language choosing object, responsible for choosing the language of the context doc
    
    design - The design which the context should use for reference on design operations. Specify null to use the design of the database where the content comes from.
    
    Returns:
    
    A new WebTML context object
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - createTMLContext
```
public Context createTMLContext(de.innovationgate.webgate.api.WGDatabase db,
                                de.innovationgate.webgate.api.WGLanguageChooser chooser)
                         throws de.innovationgate.webgate.api.WGException
```
    Creates an WebTML context object for the given database, using the given language chooser The context will be on a dummy document of the given database. If a WebTML environment is available this context will belong to this environment. Otherwise this will be a new independent context creating its own environment.
    
    Parameters:
    
    db - The database for which to create the context
    
    chooser - A language choosing object, responsible for choosing the language of the context doc
    
    Returns:
    
    A new WebTML context object
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - createTMLContext
```
public Context createTMLContext(de.innovationgate.webgate.api.WGContent content,
                                Design design)
                         throws de.innovationgate.webgate.api.WGException
```
    Creates an WebTML context object for the given content If a WebTML environment is available this context will belong to this environment. Otherwise this will be a new independent context creating its own environment.
    
    Parameters:
    
    content - The content document which should be in context
    
    design - The design which the context should use for reference on design operations. Specify null to use the design of the database where the content comes from.
    
    Returns:
    
    A new WebTML context object
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - createTMLContext
```
public Context createTMLContext(de.innovationgate.webgate.api.WGContent content)
                         throws de.innovationgate.webgate.api.WGException
```
    Creates an WebTML context object for the given content If a WebTML environment is available this context will belong to this environment. Otherwise this will be a new independent context creating its own environment.
    
    Parameters:
    
    content - The content document which should be in context
    
    Returns:
    
    A new WebTML context object
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - domain
```
public Domain domain(String name)
              throws de.innovationgate.webgate.api.WGException
```
    Returns a domain object for the domain of the given name
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - tmlscript
```
public TMLScript tmlscript()
                    throws de.innovationgate.webgate.api.WGException
```
    Returns a subobject "TMLScript" for executing TMLScript expressions
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - jobs
```
public Jobs jobs()
```
    Returns a subobject "Jobs" providing services regarding OpenWGA Jobs
  - validate
```
public Validate validate()
                  throws de.innovationgate.webgate.api.WGException
```
    Returns a subobject "Validate" offering comfortable functions to validate data in common ways, prominently in WebTML form validations.
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - reopenSessions
```
public void reopenSessions()
                    throws de.innovationgate.webgate.api.WGException
```
    Reopens all currently open database sessions
    
    Throws:
    
    WGAServerException
    
    de.innovationgate.webgate.api.WGException
  - accessLogging
```
public WGARequestInformation accessLogging()
                                    throws de.innovationgate.webgate.api.WGException
```
    Returns the request information object for the current WebTML request to modify access logging data
    
    Throws:
    
    UnavailableResourceException
    
    de.innovationgate.webgate.api.WGException
  - toList
```
public List<Object> toList(Object... values)
                    throws de.innovationgate.webgate.api.WGException
```
    Converts any value(s) into list form This method does the same list conversion known from itemList() or metaList() in TMLScript on the given values. It is ensured that the return value is a non-null List with differing contents. The behaviour regarding each single input input value is:
    - Given a list it returns that list unmodified
    - Given other collections and arrays it returns a list containing the collection values
    - Given null it returns an empty list
    - All other values return a list with the value as single element
    If multiple objects are given as values it will concatenate the elements of their resulting lists into one big list
    Parameters:
    
    values - Values that are either objects representing a list or elements to go into the list
    
    Returns:
    
    The value as list
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - serviceClasses
```
public List<Class<?>> serviceClasses()
                              throws de.innovationgate.webgate.api.WGException
```
    Returns classes and interfaces of service APIs currently registered for this WGA runtime
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - service
```
public <T> T service(Class<T> serviceClass)
              throws de.innovationgate.webgate.api.WGException
```
    Returns a service implementation for the given service API class/interface
    
    Parameters:
    
    serviceClass - The service API class or interface
    
    Returns:
    
    The implementation fo the service API which is currently active for the WGA runtime
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - instantiateService
```
public <T> T instantiateService(Class<?> implementationClass)
                         throws de.innovationgate.webgate.api.WGException
```
    Instantiates a specific service API implementation
    
    Parameters:
    
    implementationClass - The service API implementation class
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - instantiateService
```
public <T> T instantiateService(de.innovationgate.wga.modules.ModuleDefinition implDef)
                         throws de.innovationgate.webgate.api.WGException
```
    Instantiates a specific service API implementation
    
    Parameters:
    
    implDef - The module definition of the implementation
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - selectDerivate
```
public de.innovationgate.webgate.api.WGFileDerivateMetaData selectDerivate(Context cx,
                                                                           String fileName,
                                                                           String derivateQueryStr)
                                                                    throws de.innovationgate.webgate.api.WGException
```
    Selects a file derivate of a file attachment which is the best match for a derivate query
    
    Parameters:
    
    cx - Context of the content holding the attachment
    
    fileName - Name of the attachment
    
    derivateQueryStr - The derivate query
    
    Returns:
    
    Metadata of the best matching derivate. Null if no match was found.
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - selectDerivate
```
public de.innovationgate.webgate.api.WGFileDerivateMetaData selectDerivate(String fileName,
                                                                           String derivateQuery)
                                                                    throws de.innovationgate.webgate.api.WGException
```
    Selects a file derivate of a file attachment which is the best match for a derivate query. This variant uses the current WebTML context document to find file attachment and derivates.
    
    Parameters:
    
    fileName - Name of the attachment
    
    derivateQuery - The derivate query
    
    Returns:
    
    Metadata of the best matching derivate. Null if no match was found.
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - alias
```
public String alias(String str,
                    String aliasesStr)
```
    Returns an alias for a string value from a WebTML aliases string The aliases string given as parameter is expected to consist of a comma-separated list of elements of value plus corresponding alias, divided by a pipe symbol: alias|value,alias|value,alias|value ...
    
    Parameters:
    
    str - The string value
    
    aliasesStr - The aliases string
    
    Returns:
    
    The found alias or the original string value if no alias was found
  - alias
```
public String alias(String str,
                    List<String> aliases)
```
    Returns an alias for a string value from a list of WebTML aliases. The list of aliases given as parameter is expected to contain elements of value plus corresponding alias, divided by a pipe symbol: alias|value
    
    Parameters:
    
    str - The string value
    
    aliases - The list of aliases
    
    Returns:
    
    The found alias or the original string value if no alias was found
  - getLog
```
public org.apache.log4j.Logger getLog()
```
    Returns a logging facility appropriate for the current WGA environment
  - getDateFormat
```
public DateFormat getDateFormat(String pattern,
                                Locale locale)
                         throws de.innovationgate.webgate.api.WGException
```
    Returns an OpenWGA date format
    
    Parameters:
    
    pattern - The date format pattern
    
    locale - A locale to use for locale-dependent date parts. Specify null to let the current WebTML context choose the locale.
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - getNumberFormat
```
public NumberFormat getNumberFormat(String pattern,
                                    Locale locale)
                             throws de.innovationgate.webgate.api.WGException
```
    Returns an OpenWGA number format
    
    Parameters:
    
    pattern - The number format pattern
    
    locale - A locale to use for locale-dependent number parts. Specify null to let the current WebTML context choose the locale.
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - nav
```
public Nav nav()
        throws de.innovationgate.webgate.api.WGException
```
    Returns a Nav object for the current WebTML context
    
    Throws:
    
    de.innovationgate.webgate.api.WGException
  - nav
```
public Nav nav(Context context)
        throws de.innovationgate.webgate.api.WGException
```
    Returns a Nav Object for the given WebTML context
    
    Parameters:
    
    context -
    
    Throws:
    
    de.innovationgate.webgate.api.WGException

Class WGA

Method Summary

Methods inherited from class java.lang.Object

Method Detail

get

get

get

get

get

get

get

getCore

format

format

sortList

deleteDoublets

callAction

callAction

serializeObject

deserializeObject

scoped

plugin

plugin

lucene

parseDate

parseDate

createDate

modifyDate

createForm

createFormInfo

createImageScaler

createImageScaler

createList

createList

createList

createLookupTable

createLookupTable

createMail

createMail

parseNumber

parseNumber

db

db

openDatabase

hdb

encode

urlBuilder

getRequestURL

urlBuilder

urlBuilder

urlBuilder

redirectTo

buildOptions

dateOnly

timeOnly

createCalendar

createCalendar

design

design

design

design

app

app

app

app

dataSource

dataSource

dataSource

dataSource

database

database

database

database

createCookie

createHttpClient

xml

auth

html

server

isTMLContextAvailable