de.innovationgate.wgpublisher.lang

Interface LanguageBehaviour

All Known Subinterfaces:

InitializableLanguageBehaviour, PriorizingLanguageBehaviour

All Known Implementing Classes:

BrowserLocaleLanguageBehaviour, DynamicLanguageBehaviour, OnlyDefaultLanguageBehaviour, StaticLanguageBehaviour

public interface LanguageBehaviour

An object implementing a language behaviour, deciding what language to choose in diverse situations.

Method Summary

Methods

Modifier and Type	Method and Description
de.innovationgate.webgate.api.WGContent	requestSelectContentForName(de.innovationgate.webgate.api.WGDatabase db, javax.servlet.http.HttpServletRequest req, java.lang.String name, boolean isBI) Selects a content for an unique name based on request locales
de.innovationgate.webgate.api.WGContent	requestSelectContentForPage(de.innovationgate.webgate.api.WGStructEntry page, javax.servlet.http.HttpServletRequest req, boolean isBI) Selects a content from a page on based on request locales
de.innovationgate.webgate.api.WGLanguage	requestSelectDatabaseLanguage(de.innovationgate.webgate.api.WGDatabase db, javax.servlet.http.HttpServletRequest req) Selects a language from a database based on request locales
java.lang.String	webtmlFetchLabel(WGAResourceBundleManager manager, TMLContext context, java.lang.String container, java.lang.String file, java.lang.String key) Fetches an WebTML label inside processing of a WebTML request
java.lang.String	webtmlGetPreferredLanguage(de.innovationgate.webgate.api.WGDatabase db, TMLContext context) Returns a language to prefer in the current request for the given database.
java.util.List<de.innovationgate.webgate.api.WGLanguage>	webtmlQueryLanguages(de.innovationgate.webgate.api.WGDatabase db, TMLContext context) Returns the languages to return in a WebTML query
de.innovationgate.webgate.api.WGContent	webtmlSelectContentForName(de.innovationgate.webgate.api.WGDatabase db, TMLContext context, java.lang.String name, boolean isBI) Selects a content for an unique name inside processing of a WebTML request
de.innovationgate.webgate.api.WGContent	webtmlSelectContentForPage(de.innovationgate.webgate.api.WGStructEntry page, TMLContext sourceContext, boolean isBI) Selects a content from a page inside processing of a WebTML request
de.innovationgate.webgate.api.WGLanguage	webtmlSelectDatabaseLanguage(de.innovationgate.webgate.api.WGDatabase db, TMLContext sourceContext) Selects a language from a database inside processing of a WebTML request

Method Detail

requestSelectContentForPage

de.innovationgate.webgate.api.WGContent requestSelectContentForPage(de.innovationgate.webgate.api.WGStructEntry page,
                                                                  javax.servlet.http.HttpServletRequest req,
                                                                  boolean isBI)
                                                                    throws de.innovationgate.webgate.api.WGAPIException

Selects a content from a page on based on request locales

Parameters:

page - The page

req - The current request

isBI - Is true when the user is logged in to authoring

Returns:

The content to choose or null if none is appropriate

Throws:

de.innovationgate.webgate.api.WGAPIException

requestSelectContentForName

de.innovationgate.webgate.api.WGContent requestSelectContentForName(de.innovationgate.webgate.api.WGDatabase db,
                                                                  javax.servlet.http.HttpServletRequest req,
                                                                  java.lang.String name,
                                                                  boolean isBI)
                                                                    throws de.innovationgate.webgate.api.WGAPIException

Selects a content for an unique name based on request locales

Parameters:

db - The database holding the content

req - The current request

name - The unique name

isBI - Is true when the user is logged in to authoring

Returns:

The content for the name or null if none is appropriate

Throws:

de.innovationgate.webgate.api.WGAPIException

requestSelectDatabaseLanguage

de.innovationgate.webgate.api.WGLanguage requestSelectDatabaseLanguage(de.innovationgate.webgate.api.WGDatabase db,
                                                                     javax.servlet.http.HttpServletRequest req)
                                                                       throws de.innovationgate.webgate.api.WGAPIException

Selects a language from a database based on request locales

Parameters:

db - The database

req - The current request

Returns:

The language to choose or null if none is appropriate

Throws:

de.innovationgate.webgate.api.WGAPIException

webtmlSelectContentForPage

de.innovationgate.webgate.api.WGContent webtmlSelectContentForPage(de.innovationgate.webgate.api.WGStructEntry page,
                                                                 TMLContext sourceContext,
                                                                 boolean isBI)
                                                                   throws de.innovationgate.webgate.api.WGAPIException

Selects a content from a page inside processing of a WebTML request

Parameters:

page - The page

sourceContext - The context from whom to the page is addressed. Note that this may be a context from another database.

isBI - Is true when the user is logged in to authoring

Returns:

The content to choose or null if none is appropriate

Throws:

de.innovationgate.webgate.api.WGAPIException

webtmlSelectContentForName

de.innovationgate.webgate.api.WGContent webtmlSelectContentForName(de.innovationgate.webgate.api.WGDatabase db,
                                                                 TMLContext context,
                                                                 java.lang.String name,
                                                                 boolean isBI)
                                                                   throws de.innovationgate.webgate.api.WGAPIException

Selects a content for an unique name inside processing of a WebTML request

Parameters:

db - The database

context - The context from whom the function is called. Note that this may be a context from another database.

name - The unique name

isBI - Is true when the user is logged in to authoring

Returns:

The content to choose or null if none is appropriate

Throws:

de.innovationgate.webgate.api.WGAPIException

webtmlSelectDatabaseLanguage

de.innovationgate.webgate.api.WGLanguage webtmlSelectDatabaseLanguage(de.innovationgate.webgate.api.WGDatabase db,
                                                                    TMLContext sourceContext)
                                                                      throws de.innovationgate.webgate.api.WGAPIException

Selects a language from a database inside processing of a WebTML request

Parameters:

db - The database

sourceContext - The context from whom the function is called. Note that this may be a context from another database.

Returns:

The language to choose or null if none is appropriate

Throws:

de.innovationgate.webgate.api.WGAPIException

webtmlFetchLabel

java.lang.String webtmlFetchLabel(WGAResourceBundleManager manager,
                                TMLContext context,
                                java.lang.String container,
                                java.lang.String file,
                                java.lang.String key)
                                  throws de.innovationgate.webgate.api.WGAPIException

Fetches an WebTML label inside processing of a WebTML request

Parameters:

manager - The resource bundle manager for those labels

context - The context from whom the function is called. Note that this may be a context from another database.

container - The label container name

file - The label file name

key - The label key

Returns:

A label or null if no appropriate was found.

Throws:

de.innovationgate.webgate.api.WGAPIException

webtmlQueryLanguages

java.util.List<de.innovationgate.webgate.api.WGLanguage> webtmlQueryLanguages(de.innovationgate.webgate.api.WGDatabase db,
                                                                            TMLContext context)
                                                                              throws de.innovationgate.webgate.api.WGAPIException

Returns the languages to return in a WebTML query

Parameters:

db - The database running the query

context - The context from whom the query is executed. Note that this may be a context from another database.

Returns:

A list of languages to include in the result list

Throws:

de.innovationgate.webgate.api.WGAPIException

webtmlGetPreferredLanguage

java.lang.String webtmlGetPreferredLanguage(de.innovationgate.webgate.api.WGDatabase db,
                                          TMLContext context)
                                            throws de.innovationgate.webgate.api.WGAPIException

Returns a language to prefer in the current request for the given database. Used to fill this.preferredLanguage for functionalities still using this.

Parameters:

context - The database for whom the preferred language is to be determined

context - The context from whom the function is called. Note that this may be a context from another database.

Returns:

Name of a language to prefer or null if no appropriate was found

Throws:

de.innovationgate.webgate.api.WGAPIException