public class Design
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
Design.DesignOccasion
The problem occasion type used by
startProblemOccasion(String) and addProblem(String, String, Map) |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ADDPROBLEM_PARAM_ERROR
Parameter for
addProblem(String, String, Map) containing an Error object |
static java.lang.String |
ADDPROBLEM_PARAM_SEVERITY
Parameter for
addProblem(String, String, Map) containing the problem severity |
Modifier and Type | Method and Description |
---|---|
void |
addProblem(ProblemOccasion occasion,
java.lang.String key)
Adds a problem to the problem registry
|
void |
addProblem(ProblemOccasion occasion,
java.lang.String key,
java.util.Map<java.lang.Object,java.lang.Object> params)
Adds a problem to the problem registry
|
void |
addProblem(java.lang.String occasionKey,
java.lang.String key)
Adds a problem to the problem registry
|
void |
addProblem(java.lang.String occasionKey,
java.lang.String key,
java.util.Map<java.lang.Object,java.lang.Object> params)
Adds a problem to the problem registry
|
App |
app()
Returns the App of the current design
|
java.lang.String |
applyLabelParams(java.lang.String label,
java.util.List<? extends java.lang.Object> params)
Applys label params to a label string
|
java.lang.Object |
callAction()
Calls the TMLScript module, adressed by the current base reference, as WebTML action.
|
java.lang.Object |
callAction(Context cx,
java.util.List<java.lang.Object> actionArgs)
Calls the TMLScript module, adressed by the current base reference, as WebTML action
|
java.lang.Object |
callAction(Context cx,
java.util.List<java.lang.Object> actionArgs,
java.util.Map<java.lang.String,java.lang.Object> additionalObjects)
Calls the TMLScript module, adressed by the current base reference, as WebTML action
|
java.lang.Object |
callAction(Context context,
java.lang.String actionID,
java.util.List<java.lang.Object> actionArgs,
DesignResourceReference baseReference,
GlobalExpressionScope globalScope)
Calls a WebTML action
This is a variant of
WGA.callAction(Context, String, List, DesignResourceReference, GlobalExpressionScope) which is able to call actions that are defined in or for the current design. |
java.lang.Object |
callAction(java.util.List<java.lang.Object> actionArgs)
Calls the TMLScript module, adressed by the current base reference, as WebTML action.
|
FormInfo |
createFormInfo(Context context,
java.lang.String id)
Creates a
FormInfo to be used to create a new WebTML form |
de.innovationgate.webgate.api.WGDatabase |
db()
Returns the WGAPI database object for the application of the current design
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
fileURL(java.lang.String fileName)
Generates a URL to a file from the file container that is referenced by this design object
|
java.lang.String |
fileURL(java.lang.String containerName,
java.lang.String fileName)
Generates a URL to a file from design
|
java.lang.String |
fileURL(java.lang.String dbKey,
java.lang.String containerName,
java.lang.String fileName)
Generates a URL to a file from design
|
DesignResourceReference |
getBaseReference()
Returns the base reference where this design points to
A design object may point to a base reference.
|
de.innovationgate.wga.common.beans.csconfig.v1.CSConfig |
getConfig()
Returns the design configuration
|
java.lang.String |
getCSSCode()
Retrieves the code of the CSS module under the base reference of this design.
|
de.innovationgate.webgate.api.WGScriptModule |
getCSSModule()
Returns a WGAPI CSS module object for a module at this designs base reference (see
getBaseReference() ) |
TMLDesignContext |
getDesignContext()
Returns the WebTML design context behind this server API design context
|
de.innovationgate.webgate.api.WGFileContainer |
getFileContainer()
Returns a WGAPI file container object for a module at this designs base reference (see
getBaseReference() ) |
java.util.List<java.lang.String> |
getFileContainerNames(boolean descend)
Returns the names of all file containers whose name either equals the base reference or who are inside the folder adressed by the base reference
|
java.lang.String |
getFileEncoding()
Returns the file encoding of text files inside the current design
If the design is composed of multiple base/overlay designs the encoding of the design is
returned to which the current base reference is pointing.
|
java.lang.Object |
getGlobal(Context context,
java.lang.String name)
Deprecated.
Bogus context parameter. Use
getGlobal(String) |
java.lang.Object |
getGlobal(java.lang.String name)
Returns a TMLScript global that is available for the current design
This method allows to retrieve TMLScript globals with their name as method parameter.
|
HDBModel |
getHdbModel()
Returns the HDBModel object for the current designs application
This property is null if the application of the current design does not use HDBModel.
|
java.lang.String |
getJavaScriptCode()
Retrieves the code of the JavaScript module under the base reference of this design.
|
java.lang.String |
getJavaScriptCode(java.lang.Boolean compress) |
de.innovationgate.webgate.api.WGScriptModule |
getJavaScriptModule()
Returns a WGAPI JavaScript module object for a module at this designs base reference (see
getBaseReference() ) |
java.util.PropertyResourceBundle |
getLabelBundle(Context context,
java.lang.String container,
java.lang.String file,
java.lang.String language)
Deprecated.
Bogus context parameter. Use
getLabelBundle(String, String, String) . |
java.util.PropertyResourceBundle |
getLabelBundle(java.lang.String container,
java.lang.String file,
java.lang.String language)
Retrieves all labels of a label file from the design in a specific language
|
java.lang.String |
getResourceName()
Returns the resource name of the base reference of this design object
|
de.innovationgate.webgate.api.WGScriptModule |
getScriptModule()
Deprecated.
|
de.innovationgate.webgate.api.WGScriptModule |
getScriptModule(java.lang.String codeType)
Returns a WGAPI script module object for a module at this designs base reference (see
getBaseReference() ) |
java.util.List<java.lang.String> |
getScriptModuleNames(java.lang.String codeType,
boolean descend)
Returns the names of all script modules of the given code type whose name either equals the base reference or who are inside the folder adressed by the base reference
|
java.lang.String |
getTmlDefaultEncoding()
Returns the default WebTML encoding of this design
|
java.lang.String |
getTmlMedium()
Returns the media key of the current WebTML medium of the environment.
|
de.innovationgate.webgate.api.WGTMLModule |
getTMLModule(java.lang.String mediaKey)
Returns a WGAPI WebTML module object for a module at this designs base reference (see
getBaseReference() ) |
java.util.List<java.lang.String> |
getTMLModuleNames(java.lang.String mediaKey,
boolean descend)
Returns the names of all WebTML modules of the given media key whose name either equals the base reference or who are inside the folder adressed by the base reference
|
java.lang.String |
getTMLScriptCode()
Retrieves the code of the TMLScript module under the base reference of this design.
|
de.innovationgate.webgate.api.WGScriptModule |
getTMLScriptModule()
Returns a WGAPI TMLScript module object for a module at this designs base reference (see
getBaseReference() ) |
de.innovationgate.wga.common.beans.csconfig.v1.Version |
getVersionCompliance()
Returns the version compliance of the current design
The version compliance of an OpenWGA design determines, for which version of OpenWGA the design was developed.
|
java.lang.String |
getWebtmlScope()
Returns the WebTML scope that is currently actve
|
java.lang.String |
getXMLCode()
Retrieves the code of the XML module under the base reference of this design.
|
de.innovationgate.webgate.api.WGScriptModule |
getXMLModule()
Returns a WGAPI XML module object for a module at this designs base reference (see
getBaseReference() ) |
int |
hashCode() |
boolean |
isCustomable()
Returns if the current design is customizable
This, unlike
isCustomized() , also returns true if the design is customizable - so may contain overlay resources - although it is not used with a customization. |
boolean |
isCustomized()
Returns if the current design is actually customized
|
java.lang.String |
label(java.lang.String key)
Returns a WebTML label from the current design, using default label container and file
|
java.lang.String |
label(java.lang.String file,
java.lang.String key)
Returns a WebTML label from the current design, using default label container
|
java.lang.String |
label(java.lang.String container,
java.lang.String file,
java.lang.String key)
Returns a WebTML label from the current design
|
java.lang.String |
label(java.lang.String containerName,
java.lang.String fileName,
java.lang.String key,
java.util.List<? extends java.lang.Object> params,
boolean usePlaceholder)
Returns a WebTML label from the current design and accepts label parameters
|
java.lang.String |
label(java.lang.String container,
java.lang.String file,
java.lang.String key,
java.util.List<java.lang.String> params)
Returns a WebTML label from the current design and accepts label parameters
|
java.lang.String |
layoutURL()
Creates a URL to render a WebTML module, adressed by the base reference of this design object, in a contextless request
This variant uses the WebTML medium of the current script environment.
|
java.lang.String |
layoutURL(java.lang.String medium)
Creates a URL to render a WebTML module, adressed by the base reference of this design object, in a contextless request
|
Plugin |
plugin()
Returns the Plugin object for the OpenWGA plugin that provides the current design
OpenWGA plugins are often used as design providers for OpenWGA applications.
|
java.util.List<Plugin> |
plugins()
Returns the Plugin objects for the OpenWGA plugins that provide the current design
OpenWGA plugins are often used as design providers for OpenWGA applications.
|
void |
registerAppGlobal(java.lang.String name,
java.lang.Object ref)
Defines a "TMLScript App global" variable with a scope limited to the current application
|
void |
registerDbGlobal(Context context,
java.lang.String name,
java.lang.Object ref)
Deprecated.
Bogus context parameter. Use
registerAppGlobal(String, Object) . |
void |
registerDbGlobal(java.lang.String name,
java.lang.Object ref)
Deprecated.
Misnamed. Use
registerAppGlobal(String, Object) . |
void |
registerGlobal(Context context,
java.lang.String name,
java.lang.Object ref)
Deprecated.
Bogus context parameter. Use
registerGlobal(String, Object) . |
void |
registerGlobal(java.lang.String name,
java.lang.Object ref)
Defines a "TMLScript global" variable
|
Design |
resolve(DesignResourceReference ref)
Resolves a design reference relatively to the current design
This method can be used to address another design resource relative to the current design context.
|
Design |
resolve(java.lang.String refString)
Resolves a design reference relatively to the current design
This method can be used to address another design resource relative to the current design context.
|
Design |
resolve(java.lang.String refDB,
java.lang.String refString)
Resolves a design reference relatively to the current design
This method can be used to address another design resource relative to the current design context.
|
java.lang.String |
resolveDbKey(java.lang.String dbkey)
Resolves a database key
This will resolve plugin shortcuts to actual database keys, while leaving regular database keys untouched
|
DesignResourceReference |
resolveReference(DesignResourceReference ref)
Resolves a design reference relatively to the current design
This method can be used to address another design resource relative to the current design context.
|
DesignResourceReference |
resolveReference(java.lang.String refString)
Resolves a design reference relatively to the current design
This method can be used to address another design resource relative to the current design context.
|
java.lang.String |
resolveScriptlets(Context context,
java.lang.String input)
Resolve scriptlets in the given input
|
java.lang.String |
resolveScriptlets(Context context,
java.lang.String input,
java.util.Map<java.lang.String,java.lang.Object> objects)
Resolve scriptlets in the given input
|
java.lang.String |
resolveScriptlets(java.lang.String input)
Resolve scriptlets in the given input.
|
Design |
resolveSystemContainerWithFile(java.lang.String fileName)
Searches for a system file container on the current design containing the given file.
|
Design |
resolveSystemFileContainer(java.lang.String name)
Resolves a system file container of the given name.
|
Design |
resolveSystemFileContainer(java.lang.String name,
boolean unqualifiedFallback)
Resolves a system file container of the given name.
|
java.util.ArrayList<Design> |
resolveSystemResources(java.lang.String name,
int docType,
java.lang.String codeType,
boolean unqualifiedFallback) |
Design |
resolveSystemScriptModule(java.lang.String name,
java.lang.String type)
Resolves a system script of the given name.
|
Design |
resolveSystemScriptModule(java.lang.String name,
java.lang.String type,
boolean unqualifiedFallback)
Resolves a system script of the given name.
|
Design |
resolveSystemTMLModule(java.lang.String name,
java.lang.String mediaKey)
Resolves a system WebTML module of the given name.
|
Design |
resolveSystemTMLModule(java.lang.String name,
java.lang.String mediaKey,
boolean unqualifiedFallback)
Resolves a system WebTML module of the given name.
|
java.lang.String |
scriptURL(java.lang.String codeType)
Creates a URL serving the code of a publishable script module resource, adressed by the base reference of this design object
|
Design.DesignOccasion |
startProblemOccasion(java.lang.String occasion)
Starts a problem occasion and clears all already registered problems for this occasion key
|
Design.DesignOccasion |
startProblemOccasion(java.lang.String occasion,
boolean clearOldProblems)
Starts a problem occasion
|
java.lang.String |
systemLabel(java.lang.String labelKey)
Returns an OpenWGA system label from the default bundle
|
java.lang.String |
systemLabel(java.lang.String labelKey,
java.util.List<java.lang.String> params)
Returns an OpenWGA system label from the default bundle and accepts label parameters
|
java.lang.String |
systemLabel(java.lang.String systemBundleName,
java.lang.String labelKey)
Returns an OpenWGA system label
|
java.lang.String |
systemLabel(java.lang.String systemBundleName,
java.lang.String labelKey,
java.util.List<java.lang.String> params)
Returns an OpenWGA system label and accepts label parameters
|
java.lang.String |
toString() |
void |
unregisterGlobal(Context context,
java.lang.String globalName)
Deprecated.
Bogus context parameter. Use
unregisterGlobal(String) . |
void |
unregisterGlobal(java.lang.String globalName)
Removes a TMLScript global
This method is intended to remove previously registered TMLScript globals when they should become unavailable, for example on disconnecting the app/plugin which provides the functionality.
|
public static final java.lang.String ADDPROBLEM_PARAM_ERROR
addProblem(String, String, Map)
containing an Error objectpublic static final java.lang.String ADDPROBLEM_PARAM_SEVERITY
addProblem(String, String, Map)
containing the problem severitypublic java.lang.Object getGlobal(Context context, java.lang.String name) throws de.innovationgate.webgate.api.WGException
getGlobal(String)
context
- Obsolete parameter. May be null.name
- de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGException
public java.lang.Object getGlobal(java.lang.String name) throws de.innovationgate.webgate.api.WGException
name
- Name the globalde.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGException
public HDBModel getHdbModel() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.String label(java.lang.String key) throws de.innovationgate.webgate.api.WGException
key
- Label keyde.innovationgate.webgate.api.WGException
public java.lang.String label(java.lang.String file, java.lang.String key) throws de.innovationgate.webgate.api.WGException
file
- Label file, specify null for default.key
- Label keyde.innovationgate.webgate.api.WGException
public java.lang.String label(java.lang.String container, java.lang.String file, java.lang.String key) throws de.innovationgate.webgate.api.WGException
container
- Label container, specify null for default.file
- Label file, specify null for default.key
- Label keyde.innovationgate.webgate.api.WGException
public java.lang.String label(java.lang.String container, java.lang.String file, java.lang.String key, java.util.List<java.lang.String> params) throws de.innovationgate.webgate.api.WGException
container
- label container, specify null for default.file
- label file, specify null for default.key
- label keyparams
- Label parameters. List element 0 is used as param 1, element 1 as param 2 and so onde.innovationgate.webgate.api.WGException
public java.lang.String label(java.lang.String containerName, java.lang.String fileName, java.lang.String key, java.util.List<? extends java.lang.Object> params, boolean usePlaceholder) throws de.innovationgate.webgate.api.WGException
containerName
- label container, specify null for default.fileName
- label file, specify null for default.key
- label keyparams
- Label parameters. List element 0 is used as param 1, element 1 as param 2 and so onusePlaceholder
- Specify true to return label placeholder if the label is not defined. Specify false to return null instead.de.innovationgate.webgate.api.WGException
public java.lang.String systemLabel(java.lang.String labelKey) throws de.innovationgate.webgate.api.WGException
labelKey
- Label keyWGAServerException
de.innovationgate.webgate.api.WGException
public java.lang.String systemLabel(java.lang.String labelKey, java.util.List<java.lang.String> params) throws de.innovationgate.webgate.api.WGException
labelKey
- Label keyparams
- Label parameters. List element 0 is used as param 1, element 1 as param 2 and so onWGAServerException
de.innovationgate.webgate.api.WGException
public java.lang.String systemLabel(java.lang.String systemBundleName, java.lang.String labelKey) throws de.innovationgate.webgate.api.WGException
systemBundleName
- Label bundle name.labelKey
- Label keyWGAServerException
de.innovationgate.webgate.api.WGException
public java.lang.String systemLabel(java.lang.String systemBundleName, java.lang.String labelKey, java.util.List<java.lang.String> params) throws de.innovationgate.webgate.api.WGException
systemBundleName
- Label bundle name.labelKey
- Label keyparams
- Label parameters. List element 0 is used as param 1, element 1 as param 2 and so onWGAServerException
de.innovationgate.webgate.api.WGException
public java.lang.String applyLabelParams(java.lang.String label, java.util.List<? extends java.lang.Object> params) throws de.innovationgate.webgate.api.WGException
label
- The label stringparams
- Parametersde.innovationgate.webgate.api.WGException
public java.lang.String getTmlDefaultEncoding() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.util.PropertyResourceBundle getLabelBundle(Context context, java.lang.String container, java.lang.String file, java.lang.String language) throws de.innovationgate.webgate.api.WGException, java.io.IOException
getLabelBundle(String, String, String)
.context
- WebTML context. Obsolete parameter. May be null.container
- Label container, specify null for default.file
- Label file, specify null for default.language
- Language code to retrieve labels forde.innovationgate.webgate.api.WGAPIException
java.io.IOException
de.innovationgate.webgate.api.WGException
public java.util.PropertyResourceBundle getLabelBundle(java.lang.String container, java.lang.String file, java.lang.String language) throws de.innovationgate.webgate.api.WGException, java.io.IOException
container
- Label container, specify null for default.file
- Label file, specify null for default.language
- Language code to retrieve labels forde.innovationgate.webgate.api.WGAPIException
java.io.IOException
de.innovationgate.webgate.api.WGException
public void registerGlobal(Context context, java.lang.String name, java.lang.Object ref) throws de.innovationgate.webgate.api.WGException
registerGlobal(String, Object)
.context
- Obsolete parameter. May be null.name
- Global name, must begin with uppercase letterref
- Object to store as globalde.innovationgate.webgate.api.WGException
public void registerGlobal(java.lang.String name, java.lang.Object ref) throws de.innovationgate.webgate.api.WGException
name
- Global name, must begin with uppercase letterref
- Object to store as globalde.innovationgate.webgate.api.WGException
public void unregisterGlobal(Context context, java.lang.String globalName) throws de.innovationgate.webgate.api.WGException
unregisterGlobal(String)
.registerDbGlobal(Context, String, Object)
) are automatically cleared once their scope app disconnects.context
- Obsolete parameter. May be null.globalName
- Name of the globalde.innovationgate.webgate.api.WGException
public void unregisterGlobal(java.lang.String globalName) throws de.innovationgate.webgate.api.WGException
registerDbGlobal(Context, String, Object)
) are automatically cleared once their scope app disconnects.globalName
- Name of the globalde.innovationgate.webgate.api.WGException
public void registerDbGlobal(Context context, java.lang.String name, java.lang.Object ref) throws de.innovationgate.webgate.api.WGException
registerAppGlobal(String, Object)
.context
- WebTML context. Obsolete parameter. May be null.name
- Global name, must begin with uppercase letterref
- Object to store as globalde.innovationgate.webgate.api.WGException
public void registerDbGlobal(java.lang.String name, java.lang.Object ref) throws de.innovationgate.webgate.api.WGException
registerAppGlobal(String, Object)
.name
- Global name, must begin with uppercase letterref
- Object to store as globalde.innovationgate.webgate.api.WGException
public void registerAppGlobal(java.lang.String name, java.lang.Object ref) throws de.innovationgate.webgate.api.WGException
name
- Global name, must begin with uppercase letterref
- Object to store as globalde.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGDatabase db() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public App app() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.util.List<Plugin> plugins() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public Plugin plugin() throws de.innovationgate.webgate.api.WGException
plugins()
.de.innovationgate.webgate.api.WGException
public java.lang.Object callAction(Context context, java.lang.String actionID, java.util.List<java.lang.Object> actionArgs, DesignResourceReference baseReference, GlobalExpressionScope globalScope) throws de.innovationgate.webgate.api.WGException
WGA.callAction(Context, String, List, DesignResourceReference, GlobalExpressionScope)
which is able to call actions that are defined in or for the current design. Otherwise it works just like its pendant on the WGA object.context
- WebTML context under which to execute the actionactionID
- ID of the actionactionArgs
- Action arguments. List element 0 will be available as WebTML variable "tmlparam1", element 1 as "tmlparam2" and so onbaseReference
- The base reference from which to resolve the action ID. Specify null for no base reference.globalScope
- The global scope holding global objects to be available to the action.de.innovationgate.webgate.api.WGException
public java.lang.Object callAction() throws de.innovationgate.webgate.api.WGException
actionArgs
- Action arguments. List element 0 will be available as WebTML variable "tmlparam1", element 1 as "tmlparam2" and so onde.innovationgate.webgate.api.WGException
public java.lang.Object callAction(java.util.List<java.lang.Object> actionArgs) throws de.innovationgate.webgate.api.WGException
actionArgs
- Action arguments. List element 0 will be available as WebTML variable "tmlparam1", element 1 as "tmlparam2" and so onde.innovationgate.webgate.api.WGException
public java.lang.Object callAction(Context cx, java.util.List<java.lang.Object> actionArgs) throws de.innovationgate.webgate.api.WGException
context
- WebTML context under which to execute the actionactionArgs
- Action arguments. List element 0 will be available as WebTML variable "tmlparam1", element 1 as "tmlparam2" and so onde.innovationgate.webgate.api.WGException
public java.lang.Object callAction(Context cx, java.util.List<java.lang.Object> actionArgs, java.util.Map<java.lang.String,java.lang.Object> additionalObjects) throws de.innovationgate.webgate.api.WGException
context
- WebTML context under which to execute the actionadditionalObjects
- Objects to be globally available to the actionactionArgs
- Action arguments. List element 0 will be available as WebTML variable "tmlparam1", element 1 as "tmlparam2" and so onde.innovationgate.webgate.api.WGException
public boolean isCustomized() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public boolean isCustomable() throws de.innovationgate.webgate.api.WGException
isCustomized()
, also returns true if the design is customizable - so may contain overlay resources - although it is not used with a customization.de.innovationgate.webgate.api.WGException
public de.innovationgate.wga.common.beans.csconfig.v1.CSConfig getConfig() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public FormInfo createFormInfo(Context context, java.lang.String id) throws de.innovationgate.webgate.api.WGException
FormInfo
to be used to create a new WebTML formcontext
- The WebTML context for the formid
- The ID of the formde.innovationgate.webgate.api.WGException
public TMLDesignContext getDesignContext() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public DesignResourceReference getBaseReference()
resolve(String)
.
This may return an empty string if the design object has no particular base reference.public de.innovationgate.webgate.api.WGScriptModule getScriptModule() throws de.innovationgate.webgate.api.WGException
getScriptModule(String)
getBaseReference()
)WGAServerException
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGScriptModule getTMLScriptModule() throws de.innovationgate.webgate.api.WGException
getBaseReference()
)WGAServerException
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGScriptModule getJavaScriptModule() throws de.innovationgate.webgate.api.WGException
getBaseReference()
)WGAServerException
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGScriptModule getCSSModule() throws de.innovationgate.webgate.api.WGException
getBaseReference()
)WGAServerException
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGScriptModule getXMLModule() throws de.innovationgate.webgate.api.WGException
getBaseReference()
)WGAServerException
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGScriptModule getScriptModule(java.lang.String codeType) throws de.innovationgate.webgate.api.WGException
getBaseReference()
)codeType
- The script code typeWGAServerException
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGTMLModule getTMLModule(java.lang.String mediaKey) throws de.innovationgate.webgate.api.WGException
getBaseReference()
)mediaKey
- The media ke for which to retrieve a moduleWGAServerException
de.innovationgate.webgate.api.WGException
public java.lang.String getCSSCode() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.String getJavaScriptCode() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.String getJavaScriptCode(java.lang.Boolean compress) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.String getTMLScriptCode() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.String getXMLCode() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public de.innovationgate.webgate.api.WGFileContainer getFileContainer() throws de.innovationgate.webgate.api.WGException
getBaseReference()
)WGAServerException
de.innovationgate.webgate.api.WGException
public java.lang.String resolveDbKey(java.lang.String dbkey) throws de.innovationgate.webgate.api.WGException
dbkey
- Database key to resolvede.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGException
public Design resolve(java.lang.String refDB, java.lang.String refString) throws de.innovationgate.webgate.api.WGException
refDB
- Database key of an app to address. Specify null to stay in the current app.refString
- The reference string addressing the resourcede.innovationgate.webgate.api.WGException
public Design resolve(java.lang.String refString) throws de.innovationgate.webgate.api.WGException
refString
- The reference string addressing the resourcede.innovationgate.webgate.api.WGException
public Design resolve(DesignResourceReference ref) throws de.innovationgate.webgate.api.WGException
ref
- Design resouce reference to resolvede.innovationgate.webgate.api.WGException
public Design resolveSystemScriptModule(java.lang.String name, java.lang.String type, boolean unqualifiedFallback) throws de.innovationgate.webgate.api.WGException
name
- Name of the script module, without the "wga:" prefixtype
- Code type of the scriptunqualifiedFallback
- Specify true if you also want to search for resources not qualified by "wga:"de.innovationgate.webgate.api.WGException
public Design resolveSystemScriptModule(java.lang.String name, java.lang.String type) throws de.innovationgate.webgate.api.WGException
name
- Name of the script module, without the "wga:" prefixtype
- Code type of the scriptde.innovationgate.webgate.api.WGException
public Design resolveSystemFileContainer(java.lang.String name, boolean unqualifiedFallback) throws de.innovationgate.webgate.api.WGException
name
- Name of the system resource, without the "wga:" prefixunqualifiedFallback
- Specify true if you also want to search for resources not qualified by "wga:"de.innovationgate.webgate.api.WGException
public Design resolveSystemFileContainer(java.lang.String name) throws de.innovationgate.webgate.api.WGException
name
- Name of the system resource, without the "wga:" prefixde.innovationgate.webgate.api.WGException
public Design resolveSystemTMLModule(java.lang.String name, java.lang.String mediaKey, boolean unqualifiedFallback) throws de.innovationgate.webgate.api.WGException
name
- Name of the WebTML module, without the "wga:" prefixmediaKey
- Media key of the moduleunqualifiedFallback
- Specify true if you also want to search for resources not qualified by "wga:"de.innovationgate.webgate.api.WGException
public Design resolveSystemTMLModule(java.lang.String name, java.lang.String mediaKey) throws de.innovationgate.webgate.api.WGException
name
- Name of the WebTML module, without the "wga:" prefixmediaKey
- Media key of the modulede.innovationgate.webgate.api.WGException
public java.lang.String getFileEncoding()
public Design resolveSystemContainerWithFile(java.lang.String fileName) throws de.innovationgate.webgate.api.WGException
fileName
- de.innovationgate.webgate.api.WGException
public java.util.ArrayList<Design> resolveSystemResources(java.lang.String name, int docType, java.lang.String codeType, boolean unqualifiedFallback) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public DesignResourceReference resolveReference(java.lang.String refString) throws de.innovationgate.webgate.api.WGException
refString
- The reference string addressing the resourcede.innovationgate.webgate.api.WGException
public DesignResourceReference resolveReference(DesignResourceReference ref) throws de.innovationgate.webgate.api.WGException
ref
- Design resouce reference to resolvede.innovationgate.webgate.api.WGException
public de.innovationgate.wga.common.beans.csconfig.v1.Version getVersionCompliance() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public Design.DesignOccasion startProblemOccasion(java.lang.String occasion, boolean clearOldProblems) throws de.innovationgate.webgate.api.WGException
occasion
- Key string of the occasionclearOldProblems
- Whether already registered problems for this occasion key should be cleared nowaddProblem(ProblemOccasion, String, Map)
de.innovationgate.webgate.api.WGException
public Design.DesignOccasion startProblemOccasion(java.lang.String occasion) throws de.innovationgate.webgate.api.WGException
occasion
- Key string of the occasionaddProblem(ProblemOccasion, String, Map)
de.innovationgate.webgate.api.WGException
public void addProblem(ProblemOccasion occasion, java.lang.String key) throws de.innovationgate.webgate.api.WGException
occasion
- An occasion object created via startProblemOccasion(String)
key
- Key string of the problemde.innovationgate.webgate.api.WGException
public void addProblem(java.lang.String occasionKey, java.lang.String key) throws de.innovationgate.webgate.api.WGException
occasionKey
- Key string of the occasionkey
- Key string of the problemde.innovationgate.webgate.api.WGException
public void addProblem(java.lang.String occasionKey, java.lang.String key, java.util.Map<java.lang.Object,java.lang.Object> params) throws de.innovationgate.webgate.api.WGException
occasionKey
- Key string of the occasionkey
- Key string of the problemparams
- Additional parameters. Use constants ADDPROBLEM_PARAM_... for predefined parameters. All others are used as message variables.de.innovationgate.webgate.api.WGException
public void addProblem(ProblemOccasion occasion, java.lang.String key, java.util.Map<java.lang.Object,java.lang.Object> params) throws de.innovationgate.webgate.api.WGException
occasion
- An occasion object created via startProblemOccasion(String)
key
- Key string of the problemparams
- Additional parameters. Use constants ADDPROBLEM_PARAM_... for predefined parameters. All others are used as message variables.de.innovationgate.webgate.api.WGException
public java.lang.String getTmlMedium() throws de.innovationgate.webgate.api.WGException
WGAServerException
de.innovationgate.webgate.api.WGException
public java.lang.String layoutURL(java.lang.String medium) throws de.innovationgate.webgate.api.WGException
medium
- The media key for which to create the URLde.innovationgate.webgate.api.WGException
public java.lang.String layoutURL() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.String scriptURL(java.lang.String codeType) throws de.innovationgate.webgate.api.WGException
codeType
- The code type of the script module, either "css" or "js"de.innovationgate.webgate.api.WGException
public java.util.List<java.lang.String> getTMLModuleNames(java.lang.String mediaKey, boolean descend) throws de.innovationgate.webgate.api.WGException
mediaKey
- The media key of modules to returndescend
- Specify true to return all contained modules at any folder level. Specify false to return only modules directly inside the base reference folder.de.innovationgate.webgate.api.WGException
public java.util.List<java.lang.String> getScriptModuleNames(java.lang.String codeType, boolean descend) throws de.innovationgate.webgate.api.WGException
codeType
- The code type of modules to returndescend
- Specify true to return all contained modules at any folder level. Specify false to return only modules directly inside the base reference folder.de.innovationgate.webgate.api.WGException
public java.util.List<java.lang.String> getFileContainerNames(boolean descend) throws de.innovationgate.webgate.api.WGException
descend
- Specify true to return all contained file containers at any folder level. Specify false to return only containers directly inside the base reference folder.de.innovationgate.webgate.api.WGException
public java.lang.String resolveScriptlets(Context context, java.lang.String input, java.util.Map<java.lang.String,java.lang.Object> objects) throws de.innovationgate.webgate.api.WGException
context
- The WebTML context under which to execute the scriptletsinput
- The input stringobjects
- Objects to make available to custom scriptletsde.innovationgate.webgate.api.WGException
public java.lang.String resolveScriptlets(Context context, java.lang.String input) throws de.innovationgate.webgate.api.WGException
context
- The WebTML context under which to execute the scriptletsinput
- The input streamde.innovationgate.webgate.api.WGException
public java.lang.String resolveScriptlets(java.lang.String input) throws de.innovationgate.webgate.api.WGException
input
- The input streamde.innovationgate.webgate.api.WGException
public java.lang.String getWebtmlScope() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
public java.lang.String getResourceName()
public java.lang.String fileURL(java.lang.String dbKey, java.lang.String containerName, java.lang.String fileName) throws de.innovationgate.webgate.api.WGException
dbKey
- The database key of the app holding the design. Specify null to use the current design.containerName
- The name of the file container in which the file residesfileName
- The name of the filede.innovationgate.webgate.api.WGException
public java.lang.String fileURL(java.lang.String containerName, java.lang.String fileName) throws de.innovationgate.webgate.api.WGException
containerName
- The name of the file container in which the file residesfileName
- The name of the filede.innovationgate.webgate.api.WGException
public java.lang.String fileURL(java.lang.String fileName) throws de.innovationgate.webgate.api.WGException
fileName
- The name of the filede.innovationgate.webgate.api.WGException