Modifier and Type | Class and Description |
---|---|
static class |
TMLContext.ListVarContainer |
static class |
TMLContext.PersistentFormsMap |
static class |
TMLContext.Serialized |
static class |
TMLContext.WebTMLOccasion |
Modifier and Type | Field and Description |
---|---|
static java.lang.ThreadLocal<java.util.LinkedList<TMLContext>> |
_threadMainContexts |
static java.lang.String |
ACTIONID_DIVIDER |
static java.lang.Object |
SESSIONATTRIB_ASYNCACTION
Set as session attribute for tasks that execute master/async actions.
|
static java.lang.String |
SESSIONATTRIB_PROCESSCONTEXTS |
Constructor and Description |
---|
TMLContext(TMLContext parentContext,
BaseTagStatus status)
Constructor to create clones of a context with a design context for a different WebTML tag
|
TMLContext(de.innovationgate.webgate.api.WGDocument doc,
Base tag)
Constructor for the main context of a WebTML request
|
TMLContext(de.innovationgate.webgate.api.WGDocument doc,
TMLContext parentContext)
Constructor to create new contextes that take environment and designcontext from a parent context
|
TMLContext(de.innovationgate.webgate.api.WGDocument doc,
WGACore core,
TMLUserProfile userProfile,
TMLForm form) |
TMLContext(de.innovationgate.webgate.api.WGDocument doc,
WGACore core,
TMLUserProfile userProfile,
TMLForm form,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse rsp,
javax.servlet.http.HttpSession session) |
TMLContext(de.innovationgate.webgate.api.WGDocument doc,
WGACore core,
TMLUserProfile userProfile,
TMLForm form,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse rsp,
javax.servlet.http.HttpSession session,
TMLContext parentContext) |
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
|
boolean |
assertequallists(java.lang.String title,
java.lang.String category,
java.util.List l1,
java.util.List l2)
Compares two lists based on their contents but not on their order
|
boolean |
assertequallists(java.lang.String title,
java.lang.String category,
java.util.List l1,
java.util.List l2,
boolean ignoreOrder)
Compares two lists based on their contents
|
void |
assertequals(java.lang.String id,
java.lang.Object obj1,
java.lang.Object obj2)
wrapper for TestCore.assertEquals(...)
|
boolean |
assertequals(java.lang.String title,
java.lang.String category,
java.lang.Object obj1,
java.lang.Object obj2)
wrapper for TestCore.assertEquals(...)
|
void |
assertiondebug(boolean enabled)
enable or disable TestCore.assertionDebugMode
|
boolean |
assertisregisteredorexecuted(java.lang.String id)
wrapper for TestCore.assertIsRegisteredOrExecuted()
|
boolean |
assertlarger(java.lang.String title,
java.lang.String category,
java.util.Date obj1,
java.util.Date obj2) |
boolean |
assertlarger(java.lang.String title,
java.lang.String category,
java.lang.Number obj1,
java.lang.Number obj2) |
boolean |
assertnotequals(java.lang.String title,
java.lang.String category,
java.lang.Object obj1,
java.lang.Object obj2)
wrapper for TestCore.assertNotEquals(...)
|
void |
asserttrue(java.lang.String id,
java.lang.String condition)
wrapper for TestCore.assertTrue(...)
|
void |
asserttrue(java.lang.String title,
java.lang.String category,
java.lang.String condition)
wrapper for TestCore.assertTrue(...)
|
int |
assignuserprofile(java.lang.String name,
java.lang.String password) |
int |
assignuserprofile(java.lang.String domain,
java.lang.String name,
java.lang.String password) |
void |
attachscaledimage(de.innovationgate.webgate.api.WGDocument doc,
de.innovationgate.utils.ImageScaler scaler) |
void |
attachscaledimage(de.innovationgate.webgate.api.WGDocument doc,
de.innovationgate.utils.ImageScaler scaler,
java.lang.String targetFileName) |
java.util.List |
bestfragments(java.lang.String itemname,
int fragmentSize,
int maxFragments)
retrieves a list of the best fragments from the given contentItem based upon the last lucene query with highlight attribute set to true
query hits are not highlighted in fragments
|
java.util.List |
bestfragments(java.lang.String itemname,
int fragmentSize,
int maxFragments,
java.lang.String prefix,
java.lang.String suffix)
retrieves a list of the best fragments from the given contentItem based upon the last lucene query with highlight attribute set to true
query hits are highlighted (surrounded by given
|
java.util.List |
bestfragments(java.lang.String itemname,
int fragmentSize,
int maxFragments,
java.lang.String prefix,
java.lang.String suffix,
java.lang.String encode)
retrieves a list of the best fragments from the given contentItem based upon the last lucene query with highlight attribute set to true
query hits are highlighted (surrounded by given
|
java.util.List<java.lang.String> |
buildOptions(java.lang.Iterable<de.innovationgate.webgate.api.WGContent> contents,
java.lang.String titleExpr,
java.lang.String emptyTitle) |
ExpressionResult |
callCustomAction(TMLAction tmlAction,
TMLActionLink actionLink,
java.util.Map<java.lang.String,java.lang.Object> parentScopeObjects) |
java.lang.Object |
callDefaultAction(TMLAction action,
TMLActionLink link,
java.util.Map<java.lang.String,java.lang.Object> objects) |
void |
changesessionpassword(java.lang.String newPassword) |
void |
changesessionpassword(java.lang.String domain,
java.lang.String newPassword) |
static void |
clearThreadMainContext() |
int |
closeuserprofile() |
int |
closeuserprofile(java.lang.String domain) |
de.innovationgate.webgate.api.WGContent |
content()
Provides the WGAPI object "WGContent" which represents the current content document in context
|
java.lang.String |
contentdataurl(java.lang.String mediaKey,
java.lang.String layoutKey) |
java.lang.String |
contentdataurl(java.lang.String mediaKey,
java.lang.String layoutKey,
boolean ignoreVirtualLink,
java.lang.String queryString) |
java.lang.String |
contentdataurl(java.lang.String mediaKey,
java.lang.String layoutKey,
java.lang.String queryString) |
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
|
TMLContext |
context(java.lang.String expression)
Creates a TMLContext object for a different content document.
|
TMLContext |
context(java.lang.String expression,
boolean returnContextOnError)
Creates a TMLContext object for a different content document.
|
TMLContext |
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.
|
TMLContext |
context(de.innovationgate.webgate.api.WGDocument doc) |
java.lang.String |
convertVarName(java.lang.String name) |
java.util.Calendar |
createcalendar() |
java.util.Calendar |
createcalendar(java.util.Date date) |
static java.lang.String |
createContextKey(de.innovationgate.webgate.api.WGDocument doc) |
javax.servlet.http.Cookie |
createcookie(java.lang.String name,
java.lang.String value) |
javax.servlet.http.Cookie |
createCookie(java.lang.String name,
java.lang.String value) |
java.util.Date |
createdate() |
java.util.Date |
createdate(boolean includeMillis) |
PortletEvent |
createevent(java.lang.String name)
Creates a new PortletEvent object
|
TMLForm |
createform(TMLFormInfo formInfo) |
TMLFormInfo |
createforminfo(java.lang.String id) |
TMLFormInfo |
createforminfo(java.lang.String id,
boolean htmlInput,
boolean persistent) |
de.innovationgate.utils.ImageScaler |
createimagescaler(java.io.File imageFile) |
de.innovationgate.utils.ImageScaler |
createimagescaler(java.io.InputStream is) |
java.util.List |
createlist() |
java.util.List |
createlist(java.lang.Object[] objects) |
java.util.List |
createlist(java.lang.String listString,
java.lang.String delimiter) |
Login |
createlogin(java.lang.String username,
java.lang.String password) |
java.util.Map |
createlookuptable() |
java.util.Map |
createlookuptable(java.util.Map map) |
SmtpMail |
createmail() |
SmtpMail |
createmail(java.lang.String smtpHost,
java.lang.String username,
java.lang.String password) |
static TMLContext |
createMasterSessionContext(TMLContext context) |
int |
createuserprofile(java.lang.String name,
java.lang.String password) |
int |
createuserprofile(java.lang.String domain,
java.lang.String name,
java.lang.String password) |
int |
createuserprofile(java.lang.String domain,
java.lang.String name,
java.lang.String password,
boolean forCurrentUser) |
java.util.Date |
dateonly(java.util.Date date) |
de.innovationgate.webgate.api.WGDatabase |
db()
Returns a WGAPI database object for the database of the current context
|
de.innovationgate.webgate.api.WGDatabase |
db(java.lang.String key) |
TMLContext |
dbContext(de.innovationgate.webgate.api.WGDatabase dbTarget) |
TMLContext |
dbContext(de.innovationgate.webgate.api.WGDatabase dbTarget,
de.innovationgate.webgate.api.WGLanguageChooser chooser) |
TMLContext |
designContext(java.lang.String baseReference) |
TMLContext |
designContext(TMLDesignContext designContext) |
de.innovationgate.webgate.api.WGDatabase |
designdb() |
java.lang.String |
encode(java.lang.String encode,
java.lang.Object input) |
FileDerivateManager.DerivateQuery |
enhanceFileDerivateQuery(java.lang.String fileDerivates) |
boolean |
equals(java.lang.Object obj) |
ExpressionResult |
evaluateExpression(java.lang.String expression) |
ExpressionResult |
evaluateExpression(java.lang.String expression,
java.util.Map additionalObjects) |
ExpressionResult |
evaluateScript(java.lang.String script) |
ExpressionResult |
evaluateScript(java.lang.String script,
java.util.Map additionalObjects) |
static java.util.Map<java.lang.String,TMLAction> |
fetchActionRegistration(javax.servlet.http.HttpSession session) |
ManagedObject |
fetchModuleController() |
static java.util.Map<java.lang.String,TMLForm> |
fetchPersistentForms(javax.servlet.http.HttpSession session) |
static ProcessContextRegistration |
fetchProcessContextRegistration(javax.servlet.http.HttpSession session) |
PortletEvent |
fetchRequestPortletEvent() |
static java.util.Map<java.lang.String,de.innovationgate.utils.TransientObjectWrapper<java.lang.Object>> |
fetchSessionVars(javax.servlet.http.HttpSession session) |
static java.util.Map<java.lang.String,TMLForm> |
fetchTransientForms(javax.servlet.http.HttpServletRequest req) |
static TMLUserProfile |
fetchUserProfile(WGACore core,
de.innovationgate.webgate.api.WGDatabase db,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res) |
static java.util.List<Warning> |
fetchWarnings(javax.servlet.http.HttpServletRequest req) |
java.lang.String |
filedataurl(java.lang.String fileName) |
java.lang.String |
filedataurl(java.lang.String containerName,
java.lang.String fileName) |
java.lang.String |
filedataurl(java.lang.String containerName,
java.lang.String fileName,
java.lang.String contentType) |
java.lang.String |
filedataurl(java.lang.String dbKey,
java.lang.String containerName,
java.lang.String fileName,
java.lang.String contentType)
creates a RFC2397 data url from the given file
|
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
|
static java.lang.Object |
flattenList(java.lang.Object object,
boolean reduceList) |
TMLAction |
getActionByID(java.lang.String id,
java.lang.String dbkey) |
TMLAction |
getActionByID(java.lang.String id,
java.lang.String dbkey,
DesignResourceReference baseRef)
Retrieves an TMLAction definition from all valid sources
|
java.util.Map |
getActionRegistration() |
de.innovationgate.webgate.api.WGDocument |
getapiobject() |
de.innovationgate.webgate.api.WGContent |
getcontent() |
javax.servlet.http.Cookie[] |
getcookies() |
TMLDesignContext |
getDesignContext() |
java.lang.String |
getDesignDBKey() |
de.innovationgate.webgate.api.WGDocument |
getdocument() |
int |
getDummy() |
TMLContextEnvironment |
getEnvironment() |
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
|
TMLContext |
getmaincontext() |
TMLAction |
getModuleActionByID(java.lang.String id,
java.lang.String dbKey) |
de.innovationgate.webgate.api.WGUserAccess |
getoriginaluserdata() |
java.lang.String |
getpath()
Returns an absolute context path to the current context document
|
java.util.Map |
getPersistentForms() |
de.innovationgate.wga.common.beans.csconfig.v1.PluginID |
getpluginid(de.innovationgate.webgate.api.WGDatabase db)
Ugly duplicate of
pluginid(WGDatabase) , kept for historical reasons. |
TMLPortlet |
getportlet()
Returns a portlet object for the current WebTML portlet
|
TMLPortlet |
getportletbykey(java.lang.String nameSpace) |
de.innovationgate.webgate.api.WGPortletRegistry |
getPortletRegistry() |
TMLPortletStateStorage |
getPortletStateStorage() |
java.lang.String |
getpreferredlanguage()
Deprecated.
|
java.util.Locale |
getPreferredLanguageLocale() |
TMLUserProfile |
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.String |
getrole() |
java.lang.String |
getScopedString(java.lang.String str,
java.lang.String scope) |
java.lang.Object |
getsessionvar(java.lang.String name)
Retrieves a WebTML session variable
|
BaseTagStatus |
gettag() |
static TMLContext |
getThreadMainContext() |
TMLContext |
getTMLContextForDocument(de.innovationgate.webgate.api.WGDocument doc) |
TMLForm |
gettmlform()
Returns the TMLForm object representing the current WebTML form
|
java.lang.String |
getUriHash() |
WGAURLBuilder |
getURLBuilder() |
java.lang.String |
geturlparameter(java.lang.String name) |
java.util.List |
geturlparameterlist(java.lang.String name) |
java.util.List |
geturlparameternames() |
java.lang.Object |
getvar(java.lang.String name)
Retrieves a normal WebTML variable
|
java.util.List<Warning> |
getWarnings() |
WGACore |
getwgacore() |
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
|
int |
hashCode() |
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 |
hasMappedItemValue(java.lang.String name) |
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
|
boolean |
hasVariable(java.lang.String name) |
de.innovationgate.webgate.api.WGHierarchicalDatabase |
hdb()
Returns a WGAPI HDB object for the application in context
|
de.innovationgate.webgate.api.WGHierarchicalDatabase |
hdb(java.lang.String key) |
java.lang.String |
highlightitem(java.lang.String name,
java.lang.String prefix,
java.lang.String suffix) |
java.lang.String |
highlightitem(java.lang.String name,
java.lang.String prefix,
java.lang.String suffix,
java.lang.String encode) |
java.util.List |
highlightMeta(java.lang.String name,
java.lang.String prefix,
java.lang.String suffix)
returns a singleton list with metavalues highlighted (surrounded with given
|
java.util.List |
highlightMeta(java.lang.String name,
java.lang.String prefix,
java.lang.String suffix,
java.lang.String encode)
returns a singleton list with metavalues highlighted (surrounded with given
|
void |
importEnvironmentData(TMLContext context) |
void |
importEnvironmentData(TMLContext context,
boolean includeIntrusiveData) |
boolean |
isanonymous()
Tests if the current user is anonymous
|
boolean |
isassertiondebug() |
boolean |
isbotrequest() |
boolean |
isbrowserinterface()
Returns true if the WebTML page is rendered in some kind of OpenWGA authoring client like the OpenWGA Content Manager
|
boolean |
isCurrentSequenceNumber(TMLActionLink actionLink,
javax.servlet.http.HttpSession session,
boolean ajax) |
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 |
isfalse(java.lang.String varname) |
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
Context.isempty(String) . |
boolean |
isfirstloop()
Tests if a tag
|
boolean |
isfirstloop(java.lang.String tagId)
Tests if a tag
|
boolean |
ishomepage() |
boolean |
islastloop()
Tests if a tag
|
boolean |
islastloop(java.lang.String tagId)
Tests if a tag
|
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.lang.Object |
item(java.lang.String name,
java.util.Map<java.lang.String,java.lang.Object> params) |
java.lang.Object |
item(java.lang.String type,
java.lang.String name) |
java.lang.Iterable<java.lang.Object> |
itemiterable(java.lang.String name) |
java.lang.Iterable<java.lang.Object> |
itemiterable(java.lang.String name,
java.util.Map<java.lang.String,java.lang.Object> params) |
java.util.List<java.lang.Object> |
itemlist(java.lang.String name)
Returns the value of an item or WebTML variable as list value
|
java.util.List<java.lang.Object> |
itemlist(java.lang.String name,
java.util.Map<java.lang.String,java.lang.Object> params) |
java.lang.Object |
itemlist(java.lang.String type,
java.lang.String name) |
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 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 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 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 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 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.String |
layouturl(java.lang.String mediaKey,
java.lang.String layoutKey) |
java.lang.String |
layouturl(java.lang.String dbKey,
java.lang.String mediaKey,
java.lang.String layoutKey) |
org.dom4j.Document |
loadhtml(org.apache.commons.httpclient.HttpClient client,
java.lang.String url) |
org.dom4j.Document |
loadhtml(java.lang.String url) |
boolean |
login(java.lang.String user,
java.lang.String password) |
boolean |
login(java.lang.String user,
java.lang.String password,
java.lang.String domain) |
boolean |
logout(java.lang.String domain) |
de.innovationgate.webgate.api.WGResultSet |
lucenesearch(java.lang.String phrase) |
de.innovationgate.webgate.api.WGResultSet |
lucenesearch(java.lang.String phrase,
java.lang.String scope) |
void |
makeThreadMainContext() |
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 |
metalist(java.lang.String name)
Returns the value of a metadata field of type "content" as list value.
|
java.util.List |
metalist(java.lang.String type,
java.lang.String name)
Returns the value of a metadata field as list value.
|
java.lang.String |
multiencode(java.lang.String encode,
java.lang.Object input) |
java.util.Date |
now() |
java.lang.Object |
option(java.lang.String option)
Retrieves the value of a WebTML option.
|
java.lang.Object |
option(java.lang.String optionName,
java.lang.Object defaultValue)
Retrieves the value of a WebTML option.
|
java.util.Date |
parsedate(java.lang.String date,
java.lang.String format) |
org.dom4j.Document |
parsehtml(java.lang.String html) |
java.lang.Number |
parsenumber(java.lang.String number,
java.lang.String format) |
de.innovationgate.webgate.api.WGDatabase |
plugindb(java.lang.String pluginUniqueName) |
java.lang.String |
plugindbkey(java.lang.String pluginUniqueName) |
de.innovationgate.wga.common.beans.csconfig.v1.PluginID |
pluginid(java.lang.String pluginUniqueName) |
de.innovationgate.wga.common.beans.csconfig.v1.PluginID |
pluginid(de.innovationgate.webgate.api.WGDatabase db) |
TMLPortlet |
portletbypath(java.lang.String path)
Retrieves a portlet by a portlet path expression
|
static java.lang.String |
processReferencePath(java.lang.String ref,
java.lang.String currentModuleRef)
Takes a reference name that might be a local name (starting with ":").
|
void |
redirectto(java.lang.String url) |
TMLAction |
registerAction(TMLAction currentAction,
java.lang.String id,
java.lang.String designDB)
Registers an action for the current Http-Session, if an action with this code is not already registered.
|
void |
registerassertequals(java.lang.String id,
java.lang.String title,
java.lang.String category)
wrapper for TestCore.registerAssertEquals()
|
void |
registerasserttrue(java.lang.String id,
java.lang.String title,
java.lang.String category)
wrapper for TestCore.registerAssertTrue()
|
void |
registerForm(TMLForm form,
boolean persist) |
void |
removelucenequery()
removes the last lucene query from session
should be called when you are sure you do not need further highlighting of content items
for the last executed lucene query with highlight=="true"
|
void |
removePortletVariables(java.lang.String prefix) |
void |
removesessionvar(java.lang.String name)
Removes a WebTML session variable
|
void |
removeThreadMainContext() |
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
|
java.lang.String |
resolveDBKey(java.lang.String dbkey) |
DesignResourceReference |
resolveDesignResource(java.lang.String ref) |
DesignResourceReference |
resolveDesignResource(java.lang.String refString,
DesignResourceReference baseReference) |
DesignResourceReference |
resolveDesignResource(java.lang.String designDB,
java.lang.String refString) |
DesignResourceReference |
resolveDesignResource(java.lang.String refDB,
java.lang.String refString,
DesignResourceReference baseReference)
Resolves a design reference to find the corresponding resource.
|
void |
saveprofileonend() |
java.lang.String |
scripturl(java.lang.String type,
java.lang.String doc) |
java.lang.String |
scripturl(java.lang.String dbKey,
java.lang.String type,
java.lang.String doc) |
void |
setLastError(java.lang.String lastError) |
void |
setLocalVar(java.lang.String name,
java.lang.Object value) |
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 |
setpreferredlanguage(java.lang.String lang)
Deprecated.
|
void |
setrole(java.lang.String role) |
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 |
setSessionVar(java.lang.String name,
java.lang.Object value,
boolean allowSerialization,
boolean keepList) |
void |
seturlparameterifempty(java.lang.String name,
java.util.List values) |
void |
seturlparameterifempty(java.lang.String name,
java.lang.String value) |
void |
setvar(java.lang.String name,
java.lang.Object value)
Creates or updates a (normal) WebTML variable
|
void |
setvar(java.lang.String name,
java.lang.Object value,
boolean keepList) |
java.util.Date |
stringtodate(java.lang.String text) |
java.lang.String |
systemLabel(java.lang.String systemBundleName,
java.lang.String labelKey) |
java.lang.String |
systemLabel(java.lang.String systemBundleName,
java.lang.String labelKey,
java.util.List params)
Retrieves a WGA internal system label from the properties files lying under
WGACore.SYSTEMLABEL_BASE_PATH in the language of the current request locale |
java.lang.Object |
taginfo(java.lang.String tagId,
java.lang.String name)
Retrieves a WebTML tag information
|
java.util.Date |
timeonly(java.util.Date date) |
TMLForm |
tmlformbyid(java.lang.String id)
Returns a TMLForm object representing the WebTML form of the given ID
|
TMLContext |
toIsolatedVersion() |
java.lang.Iterable<java.lang.Object> |
toIterable(java.lang.Object value) |
static java.util.List<java.lang.Object> |
toList(java.lang.Object value) |
java.lang.String |
toString() |
void |
updateOrSetVar(java.lang.String name,
java.lang.Object value)
Tool method for the TMLScript engine defining the behaviour of setvar() short syntax
Will look for possible existing variables to update before setting a new variable
|
void |
waitforauthupdates(de.innovationgate.webgate.api.WGDatabase db,
int timeoutSeconds) |
public static final java.lang.String SESSIONATTRIB_PROCESSCONTEXTS
public static final java.lang.String ACTIONID_DIVIDER
public static final java.lang.Object SESSIONATTRIB_ASYNCACTION
public static java.lang.ThreadLocal<java.util.LinkedList<TMLContext>> _threadMainContexts
public TMLContext(de.innovationgate.webgate.api.WGDocument doc, Base tag)
doc
- tag
- public TMLContext(de.innovationgate.webgate.api.WGDocument doc, TMLContext parentContext)
doc
- parentContext
- public TMLContext(TMLContext parentContext, BaseTagStatus status)
doc
- parentContext
- public TMLContext(de.innovationgate.webgate.api.WGDocument doc, WGACore core, TMLUserProfile userProfile, TMLForm form, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse rsp, javax.servlet.http.HttpSession session, TMLContext parentContext)
public TMLContext(de.innovationgate.webgate.api.WGDocument doc, WGACore core, TMLUserProfile userProfile, TMLForm form)
public TMLContext(de.innovationgate.webgate.api.WGDocument doc, WGACore core, TMLUserProfile userProfile, TMLForm form, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse rsp, javax.servlet.http.HttpSession session)
public static TMLContext getThreadMainContext()
public void makeThreadMainContext()
public void removeThreadMainContext()
public static void clearThreadMainContext()
public TMLContextEnvironment getEnvironment()
public void importEnvironmentData(TMLContext context, boolean includeIntrusiveData) throws TMLException
TMLException
public void importEnvironmentData(TMLContext context) throws TMLException
TMLException
public java.util.Map getActionRegistration()
public java.lang.Object callDefaultAction(TMLAction action, TMLActionLink link, java.util.Map<java.lang.String,java.lang.Object> objects)
public ExpressionResult callCustomAction(TMLAction tmlAction, TMLActionLink actionLink, java.util.Map<java.lang.String,java.lang.Object> parentScopeObjects) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public void setvar(java.lang.String name, java.lang.Object value, boolean keepList) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public java.lang.String convertVarName(java.lang.String name)
public java.lang.Object getvar(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
Context
public java.lang.Object getsessionvar(java.lang.String name)
Context
getsessionvar
in interface Context
public void setvar(java.lang.String name, java.lang.Object value) throws de.innovationgate.webgate.api.WGAPIException
Context
public void updateOrSetVar(java.lang.String name, java.lang.Object value) throws de.innovationgate.webgate.api.WGException
name
- Variable to setvalue
- Value to Setde.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGException
public TMLContext getmaincontext()
public java.lang.Object item(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
Context
public java.lang.Object item(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> params) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public java.lang.Object item(java.lang.String type, java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public boolean isbotrequest()
public java.lang.Object itemlist(java.lang.String type, java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public de.innovationgate.webgate.api.WGDocument getdocument()
public boolean hasVariable(java.lang.String name)
public boolean hasMappedItemValue(java.lang.String name)
public static java.lang.Object flattenList(java.lang.Object object, boolean reduceList)
public java.util.List<java.lang.Object> itemlist(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
Context
public java.util.List<java.lang.Object> itemlist(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> params) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public java.lang.Iterable<java.lang.Object> itemiterable(java.lang.String name) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.Iterable<java.lang.Object> itemiterable(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> params) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.String highlightitem(java.lang.String name, java.lang.String prefix, java.lang.String suffix) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public java.lang.String highlightitem(java.lang.String name, java.lang.String prefix, java.lang.String suffix, java.lang.String encode) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public java.util.List highlightMeta(java.lang.String name, java.lang.String prefix, java.lang.String suffix) throws de.innovationgate.webgate.api.WGAPIException
name
- prefix
- suffix
- de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public java.util.List highlightMeta(java.lang.String name, java.lang.String prefix, java.lang.String suffix, java.lang.String encode) throws de.innovationgate.webgate.api.WGAPIException
name
- prefix
- suffix
- encode
- de.innovationgate.webgate.api.WGAPIException
public java.util.List bestfragments(java.lang.String itemname, int fragmentSize, int maxFragments) throws de.innovationgate.webgate.api.WGAPIException
itemname
- the item fragements should be retrieved fromfragmentSize
- the number of characters for each fragmentmaxFragments
- the maximum number of fragements returnedde.innovationgate.webgate.api.WGAPIException
public java.util.List bestfragments(java.lang.String itemname, int fragmentSize, int maxFragments, java.lang.String prefix, java.lang.String suffix) throws de.innovationgate.webgate.api.WGAPIException
itemname
- the item fragements should be retrieved fromfragmentSize
- the number of characters for each fragmentmaxFragments
- the maximum number of fragements returnedprefix
- the prefix for highlighting the search term in fragementssuffix
- the suffix for highlighting the search term in fragementsde.innovationgate.webgate.api.WGAPIException
public java.util.List bestfragments(java.lang.String itemname, int fragmentSize, int maxFragments, java.lang.String prefix, java.lang.String suffix, java.lang.String encode) throws de.innovationgate.webgate.api.WGAPIException
itemname
- the item fragements should be retrieved fromfragmentSize
- the number of characters for each fragmentmaxFragments
- the maximum number of fragements returnedprefix
- the prefix for highlighting the search term in fragementssuffix
- the suffix for highlighting the search term in fragementsencode
- encode each fragment in the given encoding - prefix and suffix will not be encodedde.innovationgate.webgate.api.WGAPIException
public void removelucenequery()
public java.lang.Iterable<java.lang.Object> toIterable(java.lang.Object value) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public static java.util.List<java.lang.Object> toList(java.lang.Object value)
public java.util.List metalist(java.lang.String type, java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
Context
public java.util.List metalist(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
Context
public void setSessionVar(java.lang.String name, java.lang.Object value, boolean allowSerialization, boolean keepList)
public void setsessionvar(java.lang.String name, java.lang.Object value, boolean allowSerialisation)
Context
setsessionvar
in interface Context
name
- Name of the variablevalue
- Value of the variableallowSerialisation
- Determines if the variable value can be serialized and therefor transported to other nodes in a clusterpublic void setsessionvar(java.lang.String name, java.lang.Object value)
Context
setsessionvar
in interface Context
name
- Name of the variablevalue
- Value of the variablepublic void removesessionvar(java.lang.String name)
Context
removesessionvar
in interface Context
name
- Name of the variablepublic de.innovationgate.webgate.api.WGContent content()
Context
public de.innovationgate.webgate.api.WGContent getcontent()
public TMLContext context(java.lang.String expression, boolean returnContextOnError)
Context
context
in interface Context
expression
- An OpenWGA context expression. Syntax is identical to that of WebTML attribute contextreturnContextOnError
- Determines if on context change error the original context is to be returned. If false this method returns null on a failed context change.public TMLContext context(java.lang.String expression)
Context
context
in interface Context
expression
- An OpenWGA context expression. Syntax is identical to that of WebTML attribute contextpublic java.lang.Object meta(java.lang.String type, java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
Context
public TMLUserProfile getprofile()
Context
getprofile
in interface Context
public TMLPortlet getportlet() throws de.innovationgate.webgate.api.WGAPIException
Context
getportlet
in interface Context
de.innovationgate.webgate.api.WGAPIException
public TMLPortlet portletbypath(java.lang.String path) throws de.innovationgate.webgate.api.WGException
Context
portletbypath
in interface Context
path
- The portlet pathde.innovationgate.webgate.api.WGException
public TMLPortlet getportletbykey(java.lang.String nameSpace) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public de.innovationgate.webgate.api.WGPortletRegistry getPortletRegistry() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public TMLPortletStateStorage getPortletStateStorage()
public java.lang.Object meta(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
Context
public java.lang.Object taginfo(java.lang.String tagId, java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
Context
public java.lang.String getlasterror()
Context
getlasterror
in interface Context
public void setLastError(java.lang.String lastError)
public boolean isselected() throws de.innovationgate.webgate.api.WGAPIException
Context
isselected
in interface Context
de.innovationgate.webgate.api.WGAPIException
public boolean isselected(Context mainContext) throws de.innovationgate.webgate.api.WGAPIException
Context
isselected
in interface Context
de.innovationgate.webgate.api.WGAPIException
public boolean haschildren() throws de.innovationgate.webgate.api.WGAPIException
Context
haschildren
in interface Context
de.innovationgate.webgate.api.WGAPIException
public boolean hassiblings() throws de.innovationgate.webgate.api.WGAPIException
Context
hassiblings
in interface Context
de.innovationgate.webgate.api.WGAPIException
public boolean isroot() throws de.innovationgate.webgate.api.WGAPIException
Context
public boolean ismaindocument() throws de.innovationgate.webgate.api.WGAPIException
Context
ismaindocument
in interface Context
de.innovationgate.webgate.api.WGAPIException
public boolean isbrowserinterface()
Context
isbrowserinterface
in interface Context
public java.lang.String contenturl(java.lang.String mediaKey, java.lang.String layoutKey) throws de.innovationgate.webgate.api.WGException
Context
contenturl
in interface Context
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.de.innovationgate.webgate.api.WGException
public java.lang.String contenturl() throws de.innovationgate.webgate.api.WGException
Context
contenturl
in interface Context
de.innovationgate.webgate.api.WGException
public java.lang.String contenturl(java.lang.String mediaKey, java.lang.String layoutKey, boolean ignoreVirtualLink) throws de.innovationgate.webgate.api.WGException
Context
contenturl
in interface Context
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.de.innovationgate.webgate.api.WGException
public java.lang.String contentdataurl(java.lang.String mediaKey, java.lang.String layoutKey) throws javax.servlet.ServletException, java.io.IOException, de.innovationgate.webgate.api.WGException
javax.servlet.ServletException
java.io.IOException
de.innovationgate.webgate.api.WGException
public java.lang.String contentdataurl(java.lang.String mediaKey, java.lang.String layoutKey, java.lang.String queryString) throws javax.servlet.ServletException, java.io.IOException, de.innovationgate.webgate.api.WGException
javax.servlet.ServletException
java.io.IOException
de.innovationgate.webgate.api.WGException
public java.lang.String contentdataurl(java.lang.String mediaKey, java.lang.String layoutKey, boolean ignoreVirtualLink, java.lang.String queryString) throws javax.servlet.ServletException, java.io.IOException, de.innovationgate.webgate.api.WGException
javax.servlet.ServletException
java.io.IOException
de.innovationgate.webgate.api.WGException
public int getDummy()
public java.lang.String layouturl(java.lang.String dbKey, java.lang.String mediaKey, java.lang.String layoutKey) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.String layouturl(java.lang.String mediaKey, java.lang.String layoutKey) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public void setrole(java.lang.String role)
public java.lang.String getrole()
public void addwarning(java.lang.String msg, boolean severe)
Context
addwarning
in interface Context
msg
- Message of the warningsevere
- 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 public void addwarning(java.lang.String msg, boolean severe, java.lang.Throwable cause)
Context
addwarning
in interface Context
msg
- Message of the warningsevere
- 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 cause
- A Java exception that caused the warning. It's stack trace will be put out to the log, if warnings logging is enabledpublic void addwarning(java.lang.String msg)
Context
addwarning
in interface Context
msg
- Message of the warningpublic boolean isnewsession()
Context
isnewsession
in interface Context
public javax.servlet.http.Cookie[] getcookies()
public javax.servlet.http.HttpServletRequest getrequest()
Context
getrequest
in interface Context
public boolean istrue(java.lang.String varname) throws de.innovationgate.webgate.api.WGAPIException
Context
public boolean isdefined(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
Context
public boolean isfalse(java.lang.String varname) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public java.lang.Object option(java.lang.String optionName, java.lang.Object defaultValue)
Context
public java.lang.Object option(java.lang.String option)
Context
public boolean hasoption(java.lang.String option)
Context
public java.util.Date dateonly(java.util.Date date)
public java.util.Date timeonly(java.util.Date date)
public de.innovationgate.webgate.api.WGDocument getapiobject()
getapiobject
in interface TMLObject
public java.util.Date stringtodate(java.lang.String text)
public java.util.List createlist()
public java.util.List createlist(java.lang.Object[] objects)
public java.util.List createlist(java.lang.String listString, java.lang.String delimiter)
public int createuserprofile(java.lang.String name, java.lang.String password) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public int createuserprofile(java.lang.String domain, java.lang.String name, java.lang.String password) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public int createuserprofile(java.lang.String domain, java.lang.String name, java.lang.String password, boolean forCurrentUser) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public int assignuserprofile(java.lang.String name, java.lang.String password) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public int assignuserprofile(java.lang.String domain, java.lang.String name, java.lang.String password) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public TMLForm gettmlform()
Context
gettmlform
in interface Context
public TMLForm tmlformbyid(java.lang.String id)
Context
tmlformbyid
in interface Context
id
- id of the formpublic de.innovationgate.webgate.api.WGDatabase db(java.lang.String key) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGDatabase db()
Context
public de.innovationgate.webgate.api.WGDatabase designdb() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGHierarchicalDatabase hdb(java.lang.String key) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGHierarchicalDatabase hdb() throws de.innovationgate.webgate.api.WGException
Context
public int closeuserprofile(java.lang.String domain) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public int closeuserprofile() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public boolean hasprofile()
Context
hasprofile
in interface Context
public TMLContext context(de.innovationgate.webgate.api.WGContent content) throws de.innovationgate.webgate.api.WGAPIException
Context
public TMLContext context(de.innovationgate.webgate.api.WGDocument doc) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public SmtpMail createmail(java.lang.String smtpHost, java.lang.String username, java.lang.String password) throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
public SmtpMail createmail() throws TMLException
TMLException
public de.innovationgate.utils.ImageScaler createimagescaler(java.io.File imageFile) throws de.innovationgate.webgate.api.WGException, java.io.IOException
de.innovationgate.webgate.api.WGException
java.io.IOException
public de.innovationgate.utils.ImageScaler createimagescaler(java.io.InputStream is) throws de.innovationgate.webgate.api.WGException, java.io.IOException
de.innovationgate.webgate.api.WGException
java.io.IOException
public java.lang.String getpath() throws de.innovationgate.webgate.api.WGAPIException
Context
public void registerForm(TMLForm form, boolean persist)
public javax.servlet.http.HttpServletResponse getresponse()
Context
getresponse
in interface Context
public void redirectto(java.lang.String url) throws java.io.IOException
java.io.IOException
public TMLContext getTMLContextForDocument(de.innovationgate.webgate.api.WGDocument doc)
public static java.lang.String createContextKey(de.innovationgate.webgate.api.WGDocument doc)
public javax.servlet.http.Cookie createcookie(java.lang.String name, java.lang.String value)
public javax.servlet.http.Cookie createCookie(java.lang.String name, java.lang.String value)
public org.apache.log4j.Logger getlog()
Context
public void removevar(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
Context
public WGACore getwgacore()
public javax.servlet.http.HttpSession gethttpsession()
Context
gethttpsession
in interface Context
public void setpreferredlanguage(java.lang.String lang)
public java.lang.String getpreferredlanguage()
getpreferredlanguage(WGDatabase, boolean)
with the current context database and "true" for the exhaustive parameterde.innovationgate.webgate.api.WGAPIException
public java.util.Locale getPreferredLanguageLocale()
public java.util.Date parsedate(java.lang.String date, java.lang.String format) throws java.text.ParseException, de.innovationgate.webgate.api.WGException
java.text.ParseException
de.innovationgate.webgate.api.WGException
public java.lang.Number parsenumber(java.lang.String number, java.lang.String format) throws java.text.ParseException, de.innovationgate.webgate.api.WGException
java.text.ParseException
de.innovationgate.webgate.api.WGException
public java.util.Date createdate()
public java.util.Date now()
public java.util.Date createdate(boolean includeMillis)
public java.util.Calendar createcalendar(java.util.Date date)
public java.util.Calendar createcalendar()
public void setoption(java.lang.String name, java.lang.Object value, java.lang.String scope)
Context
public void setoption(java.lang.String name, java.lang.Object value)
Context
public Login createlogin(java.lang.String username, java.lang.String password)
public java.lang.String label(java.lang.String containerName, java.lang.String fileName, java.lang.String key, java.util.List params, boolean usePlaceholder)
Context
label
in interface Context
containerName
- Label container base name. Omit the language suffix.fileName
- Label file holding label definitions. Omit the suffix ".properties".key
- The label keyparams
- Label parameters that are injected into the label textusePlaceholder
- Specify true to return a label placeholder in case the label does not exist. Specify false to return null in that case.public java.lang.String label(java.lang.String containerName, java.lang.String fileName, java.lang.String key, java.util.List params)
Context
public 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
Context
label
in interface Context
designDB
- The WGAPI database object of the app from which to load labelscontainerName
- Label container base name. Omit the language suffix.fileName
- Label file holding label definitions. Omit the suffix ".properties".key
- The label keyparams
- Label parameters that are injected into the label textusePlaceholder
- Specify true to return a label placeholder in case the label does not exist. Specify false to return null in that case.de.innovationgate.webgate.api.WGException
public 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 params) throws de.innovationgate.webgate.api.WGException
Context
label
in interface Context
designDB
- The WGAPI database object of the app from which to load labelscontainerName
- Label container base name. Omit the language suffix.fileName
- Label file holding label definitions. Omit the suffix ".properties".key
- The label keyparams
- Label parameters that are injected into the label textde.innovationgate.webgate.api.WGException
public java.lang.String label(java.lang.String containerName, java.lang.String fileName, java.lang.String key)
Context
public java.lang.String label(java.lang.String fileName, java.lang.String key, java.util.List params)
Context
public java.lang.String label(java.lang.String fileName, java.lang.String key)
Context
public java.lang.String label(java.lang.String key, java.util.List params)
Context
public java.lang.String label(java.lang.String key)
Context
public boolean haslabel(java.lang.String key)
Context
public boolean haslabel(java.lang.String fileName, java.lang.String key)
Context
public boolean haslabel(java.lang.String containerName, java.lang.String fileName, java.lang.String key)
Context
public boolean iswebenvironment()
Context
iswebenvironment
in interface Context
public void asserttrue(java.lang.String title, java.lang.String category, java.lang.String condition)
title
- assertion-titlecategory
- assertion-categorycondition
- tmlscript-condition to test for truepublic boolean assertequals(java.lang.String title, java.lang.String category, java.lang.Object obj1, java.lang.Object obj2)
title
- assertion-titlecategory
- assertion-categoryobj1
- Object1 for compareobj2
- Object2 for comparepublic boolean assertlarger(java.lang.String title, java.lang.String category, java.lang.Number obj1, java.lang.Number obj2)
public boolean assertlarger(java.lang.String title, java.lang.String category, java.util.Date obj1, java.util.Date obj2)
public boolean assertnotequals(java.lang.String title, java.lang.String category, java.lang.Object obj1, java.lang.Object obj2)
title
- assertion-titlecategory
- assertion-categoryobj1
- Object1 for compareobj2
- Object2 for comparepublic boolean assertequallists(java.lang.String title, java.lang.String category, java.util.List l1, java.util.List l2)
title
- assertion-titlecategory
- assertion-categoryl1
- List 1 for comparel2
- List 2 for compareignoreOrder
- Set to true to ignore list orderpublic boolean assertequallists(java.lang.String title, java.lang.String category, java.util.List l1, java.util.List l2, boolean ignoreOrder)
title
- assertion-titlecategory
- assertion-categoryl1
- List 1 for comparel2
- List 2 for compareignoreOrder
- Set to true to ignore list orderpublic void asserttrue(java.lang.String id, java.lang.String condition)
id
- of preregistered assertioncondition
- tmlscript-condition to test for truepublic void assertequals(java.lang.String id, java.lang.Object obj1, java.lang.Object obj2)
id
- of preregistered assertionobj1
- Object1 for compareobj2
- Object2 for comparepublic void registerasserttrue(java.lang.String id, java.lang.String title, java.lang.String category)
id
- unqiue id for the assertiontitle
- assertion-titlecategory
- assertion-categorypublic void registerassertequals(java.lang.String id, java.lang.String title, java.lang.String category)
id
- unqiue id for the assertiontitle
- assertion-titlecategory
- assertion-categorypublic boolean assertisregisteredorexecuted(java.lang.String id)
id
- unique id for the assertionpublic void assertiondebug(boolean enabled)
public boolean isassertiondebug()
public void changesessionpassword(java.lang.String domain, java.lang.String newPassword)
public void changesessionpassword(java.lang.String newPassword) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public TMLAction getActionByID(java.lang.String id, java.lang.String dbkey)
public TMLAction getActionByID(java.lang.String id, java.lang.String dbkey, DesignResourceReference baseRef)
id
- The reference of the actiondbkey
- An explicitly chosen dbkey where to lookup the action. Give null if nothing was chosen.baseRef
- The base design reference of the current design context, used to resolve the action.public java.lang.String getDesignDBKey()
public TMLAction getModuleActionByID(java.lang.String id, java.lang.String dbKey) throws TMLActionException
TMLActionException
public TMLForm createform(TMLFormInfo formInfo) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public TMLFormInfo createforminfo(java.lang.String id)
public TMLFormInfo createforminfo(java.lang.String id, boolean htmlInput, boolean persistent)
public static java.lang.String processReferencePath(java.lang.String ref, java.lang.String currentModuleRef)
ref
- The reference name to expandcurrentModuleRef
- The name of the currently executed modulepublic de.innovationgate.webgate.api.WGResultSet lucenesearch(java.lang.String phrase, java.lang.String scope) throws de.innovationgate.webgate.api.WGQueryException
de.innovationgate.webgate.api.WGQueryException
public de.innovationgate.webgate.api.WGResultSet lucenesearch(java.lang.String phrase) throws de.innovationgate.webgate.api.WGQueryException
de.innovationgate.webgate.api.WGQueryException
public java.lang.String fileurl(java.lang.String containerName, java.lang.String fileName) throws de.innovationgate.webgate.api.WGException
Context
fileurl
in interface Context
containerName
- Name of a file container or key of a content documentfileName
- 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.de.innovationgate.webgate.api.WGException
public java.lang.String fileurl(java.lang.String dbKey, java.lang.String containerName, java.lang.String fileName) throws de.innovationgate.webgate.api.WGException
Context
fileurl
in interface Context
dbKey
- Database key of the database whose file is to be served.containerName
- Name of a file container or key of a content documentfileName
- 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.de.innovationgate.webgate.api.WGException
public java.lang.String fileurl(java.lang.String fileName) throws de.innovationgate.webgate.api.WGException
Context
fileurl
in interface Context
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.de.innovationgate.webgate.api.WGException
public java.lang.String filedataurl(java.lang.String containerName, java.lang.String fileName) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public java.lang.String filedataurl(java.lang.String fileName) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public java.lang.String filedataurl(java.lang.String containerName, java.lang.String fileName, java.lang.String contentType) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public java.lang.String filedataurl(java.lang.String dbKey, java.lang.String containerName, java.lang.String fileName, java.lang.String contentType) throws de.innovationgate.webgate.api.WGAPIException
dbKey
- containerName
- fileName
- contentType
- de.innovationgate.webgate.api.WGAPIException
public void saveprofileonend()
public java.util.Map createlookuptable()
public java.util.Map createlookuptable(java.util.Map map)
public PortletEvent createevent(java.lang.String name)
Context
createevent
in interface Context
name
- Name of the portlet event. All event receivers subscribing to this name will receive it when it is thrown.public boolean isempty(java.lang.String itemName) throws de.innovationgate.webgate.api.WGAPIException
Context
public boolean isemptyvalue(java.lang.Object value)
Context
isemptyvalue
in interface Context
value
- Value to testpublic boolean isfilled(java.lang.String attValue) throws de.innovationgate.webgate.api.WGAPIException
Context
Context.isempty(String)
.
This method returns always true when in authoring mode for a document.public boolean login(java.lang.String user, java.lang.String password, java.lang.String domain) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public boolean login(java.lang.String user, java.lang.String password) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public boolean logout(java.lang.String domain) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGDatabase plugindb(java.lang.String pluginUniqueName) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public de.innovationgate.wga.common.beans.csconfig.v1.PluginID pluginid(java.lang.String pluginUniqueName) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.String plugindbkey(java.lang.String pluginUniqueName)
public java.lang.String encode(java.lang.String encode, java.lang.Object input) throws de.innovationgate.utils.FormattingException
de.innovationgate.utils.FormattingException
public java.lang.String multiencode(java.lang.String encode, java.lang.Object input) throws de.innovationgate.utils.FormattingException
de.innovationgate.utils.FormattingException
public WGAURLBuilder getURLBuilder()
public org.dom4j.Document loadhtml(org.apache.commons.httpclient.HttpClient client, java.lang.String url) throws java.io.UnsupportedEncodingException, de.innovationgate.webgate.api.WGAPIException, java.io.IOException, org.apache.commons.httpclient.HttpException, org.xml.sax.SAXException
java.io.UnsupportedEncodingException
de.innovationgate.webgate.api.WGAPIException
java.io.IOException
org.apache.commons.httpclient.HttpException
org.xml.sax.SAXException
public org.dom4j.Document loadhtml(java.lang.String url) throws java.io.UnsupportedEncodingException, de.innovationgate.webgate.api.WGAPIException, org.apache.commons.httpclient.HttpException, java.io.IOException, org.xml.sax.SAXException
java.io.UnsupportedEncodingException
de.innovationgate.webgate.api.WGAPIException
org.apache.commons.httpclient.HttpException
java.io.IOException
org.xml.sax.SAXException
public org.dom4j.Document parsehtml(java.lang.String html) throws org.xml.sax.SAXException, java.io.IOException
org.xml.sax.SAXException
java.io.IOException
public TMLAction registerAction(TMLAction currentAction, java.lang.String id, java.lang.String designDB)
currentAction
- The action to registerid
- The id of the action. Specify null if the action has no id.public void removePortletVariables(java.lang.String prefix)
public java.lang.String geturlparameter(java.lang.String name)
public java.util.List geturlparameterlist(java.lang.String name)
public java.util.List geturlparameternames()
public void seturlparameterifempty(java.lang.String name, java.lang.String value) throws de.innovationgate.webgate.api.WGIllegalStateException
de.innovationgate.webgate.api.WGIllegalStateException
public void seturlparameterifempty(java.lang.String name, java.util.List values) throws de.innovationgate.webgate.api.WGIllegalStateException
de.innovationgate.webgate.api.WGIllegalStateException
public boolean isfirstloop()
Context
isfirstloop
in interface Context
public boolean islastloop()
Context
islastloop
in interface Context
public boolean isfirstloop(java.lang.String tagId)
Context
isfirstloop
in interface Context
tagId
- id of the foreach tagpublic boolean islastloop(java.lang.String tagId)
Context
islastloop
in interface Context
tagId
- id of the foreach tagpublic java.lang.String resolveDBKey(java.lang.String dbkey)
public de.innovationgate.wga.common.beans.csconfig.v1.PluginID getpluginid(de.innovationgate.webgate.api.WGDatabase db)
pluginid(WGDatabase)
, kept for historical reasons. See B00005E92db
- public de.innovationgate.wga.common.beans.csconfig.v1.PluginID pluginid(de.innovationgate.webgate.api.WGDatabase db)
public java.util.Map getPersistentForms()
public TMLDesignContext getDesignContext()
public ExpressionResult evaluateExpression(java.lang.String expression, java.util.Map additionalObjects)
public ExpressionResult evaluateExpression(java.lang.String expression)
public ExpressionResult evaluateScript(java.lang.String script, java.util.Map additionalObjects)
public ExpressionResult evaluateScript(java.lang.String script)
public void waitforauthupdates(de.innovationgate.webgate.api.WGDatabase db, int timeoutSeconds) throws WGAServerException
WGAServerException
public java.lang.String systemLabel(java.lang.String systemBundleName, java.lang.String labelKey, java.util.List params)
WGACore.SYSTEMLABEL_BASE_PATH
in the language of the current request localesystemBundleName
- Name of the bundle filelabelKey
- Key of the labelparams
- A list of parameters that replace placeholders {1}...{n} in the labelpublic java.lang.String systemLabel(java.lang.String systemBundleName, java.lang.String labelKey)
public static TMLContext createMasterSessionContext(TMLContext context) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public static java.util.Map<java.lang.String,de.innovationgate.utils.TransientObjectWrapper<java.lang.Object>> fetchSessionVars(javax.servlet.http.HttpSession session)
public static ProcessContextRegistration fetchProcessContextRegistration(javax.servlet.http.HttpSession session)
public static java.util.Map<java.lang.String,TMLAction> fetchActionRegistration(javax.servlet.http.HttpSession session)
public static TMLUserProfile fetchUserProfile(WGACore core, de.innovationgate.webgate.api.WGDatabase db, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
public static java.util.List<Warning> fetchWarnings(javax.servlet.http.HttpServletRequest req)
public static java.util.Map<java.lang.String,TMLForm> fetchTransientForms(javax.servlet.http.HttpServletRequest req)
public static java.util.Map<java.lang.String,TMLForm> fetchPersistentForms(javax.servlet.http.HttpSession session)
public de.innovationgate.webgate.api.WGUserAccess getoriginaluserdata()
public void removetmlform(java.lang.String formid)
Context
removetmlform
in interface Context
formid
- Id of the formpublic void attachscaledimage(de.innovationgate.webgate.api.WGDocument doc, de.innovationgate.utils.ImageScaler scaler, java.lang.String targetFileName) throws java.io.IOException, de.innovationgate.webgate.api.WGAPIException
java.io.IOException
de.innovationgate.webgate.api.WGAPIException
public void attachscaledimage(de.innovationgate.webgate.api.WGDocument doc, de.innovationgate.utils.ImageScaler scaler) throws java.io.IOException, de.innovationgate.webgate.api.WGAPIException
java.io.IOException
de.innovationgate.webgate.api.WGAPIException
public TMLContext dbContext(de.innovationgate.webgate.api.WGDatabase dbTarget, de.innovationgate.webgate.api.WGLanguageChooser chooser) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public TMLContext dbContext(de.innovationgate.webgate.api.WGDatabase dbTarget) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public BaseTagStatus gettag()
public java.util.List<Warning> getWarnings()
public DesignResourceReference resolveDesignResource(java.lang.String ref) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public DesignResourceReference resolveDesignResource(java.lang.String designDB, java.lang.String refString) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public DesignResourceReference resolveDesignResource(java.lang.String refString, DesignResourceReference baseReference) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public DesignResourceReference resolveDesignResource(java.lang.String refDB, java.lang.String refString, DesignResourceReference baseReference) throws de.innovationgate.webgate.api.WGException
refDB
- dbkey of an explicitly chosen target app. Give null if nothing was chosen.refString
- The reference string addressing the resourcebaseReference
- The base reference used to resolve relative addressationde.innovationgate.webgate.api.WGException
public java.lang.String getScopedString(java.lang.String str, java.lang.String scope)
public java.util.List<java.lang.String> buildOptions(java.lang.Iterable<de.innovationgate.webgate.api.WGContent> contents, java.lang.String titleExpr, java.lang.String emptyTitle) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public java.lang.String scripturl(java.lang.String dbKey, java.lang.String type, java.lang.String doc) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.String scripturl(java.lang.String type, java.lang.String doc) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public boolean istagidvalid(java.lang.String tagid)
Context
istagidvalid
in interface Context
public boolean hasrole(java.lang.String role) throws de.innovationgate.webgate.api.WGAPIException
Context
public boolean hasgroup(java.lang.String group) throws de.innovationgate.webgate.api.WGAPIException
Context
public boolean isanonymous() throws de.innovationgate.webgate.api.WGAPIException
Context
isanonymous
in interface Context
de.innovationgate.webgate.api.WGAPIException
public void appendvar(java.lang.String name, java.lang.Object value) throws de.innovationgate.webgate.api.WGAPIException
Context
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getUriHash()
public FileDerivateManager.DerivateQuery enhanceFileDerivateQuery(java.lang.String fileDerivates) throws WGInvalidDerivateQueryException
WGInvalidDerivateQueryException
public TMLContext designContext(TMLDesignContext designContext)
public TMLContext designContext(java.lang.String baseReference)
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public PortletEvent fetchRequestPortletEvent()
public boolean isCurrentSequenceNumber(TMLActionLink actionLink, javax.servlet.http.HttpSession session, boolean ajax)
public ManagedObject fetchModuleController() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public TMLContext toIsolatedVersion()
public void setLocalVar(java.lang.String name, java.lang.Object value) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public boolean ishomepage()
ishomepage
in interface Context