Foglight 7.1.0 - Web Component Guide

From within a JavaTM, Script or a Script with Map Function, a special FunctionHelper class is available for accessing additional information. See the javadoc for that class for more details on what information is available.

For Java Functions, FunctionHelper objects are passed as a parameter to the specified Java method.

For Script or Script with Map Functions, the FunctionHelper class is accessible through the reserved script parameter, functionHelper. To make things easier, the argument values of function parameters can also be accessed by directly referencing the name of the parameter. The reserved script parameters are also available:

•

resourceBundle: The Java Resource Bundle for the current locale with strings loaded from the module’s file strings.properties (uploaded using the Files tab available under Configuration > Definitions).

•

specificTimeRange: The current SpecificTimeRange. This value should always be passed when you access property values of any time-sensitive data object. For example:

To get property b, instead of writing:

x = a.b;

Write the following:

x = a.get("b", specificTimeRange);

Since these parameter names are reserved, they cannot be used as the name for declared Script or Script with Map Function parameters. The reserved script parameters should be referenced using the same notation used for other script parameters.

For Java Functions, these are available via the corresponding getter methods of the FunctionHelper parameter. The table shows the methods in FunctionHelper:

Table 15. FunctionHelper methods
Return Type	Method Name	Description
WritableData Object	createDataObject( String typeName, String storage, String objectId)	Creates a writable data object.
Map<String,?>	getArguments()	Returns a Map containing the argument values for the function's parameters.
Locale	getLocale()	Returns the user locale.
ResourceBundle	getResourceBundle()	Returns the ResourceBundle for the current Locale, loaded from the strings.properties file in the module to which the function belongs.
SpecificTimeRange	getSpecificTime Range()	Returns a SpecificTimeRange whose start/end dates are computed based on the TimeRange when the function was invoked.
Calendar	getTimestamp()	Returns the current timestamp.
String	getUser()	Returns the name of the current user.
String	getUserModule Name()	Returns the name of the user module.
String	getViewId()	Returns the ID of the view for the current view component.
Object	invokeFunction( String fqId, Object... arguments)	Invokes a function. Used for invoking a function within another function.
List<?>	invokeQuery( String fqId, Object... arguments)	Invokes a query.

Documents connexes

The document was helpful.

Sélectionner une évaluation

I easily found the information I needed.

Sélectionner une évaluation

Veuillez sélectionner votre produit

Afin de mieux répondre à vos besoins, précisez l'objet du tchat:

Solutions recommandées pour votre problème

Foglight 7.1.0 - Web Component Guide

Using Functions

Functions as Converters

Caching results of Functions

Information available from a Script, Script with Map or Java Function