com.hpe.caf.worker.document.model

Interface Script

All Superinterfaces:

DocumentWorkerObject

public interface Script
extends DocumentWorkerObject

Represents a customization script which is attached to a task.

The customization script may or may not be loaded. If it is loaded then any event handlers that it contains will be executed when the event occurs. The customization script can only be modified when it is not loaded.

The customization script may or may not be installed. If it is installed then it will be included in the response message. If the response message is sent to another Document Worker then it will automatically be loaded by that worker before the task is processed.

Method Summary

Modifier and Type	Method and Description
int	getIndex() Returns the current position of this customization script in the parent list.
String	getName() Returns the name of the customization script.
Object	getObject() This property allows for communication between scripts.
String	getScript() Retrieves the text of the script.
Task	getTask() Returns the task that this customization script is associated with.
void	install() Installs this customization script.
boolean	isInstalled() Checks whether this customization script is currently installed.
boolean	isLoaded() Checks whether this customization script is currently loaded.
void	load() Loads this customization script.
void	setName(String name) Sets the name of the customization script.
void	setScriptByReference(String reference) Sets the customization script.
void	setScriptByReference(String reference, ScriptEngineType engineType) Sets the customization script.
void	setScriptByUrl(URL url) Sets the customization script.
void	setScriptByUrl(URL url, ScriptEngineType engineType) Sets the customization script.
void	setScriptInline(String script) Sets the customization script.
void	setScriptInline(String script, ScriptEngineType engineType) Sets the customization script.
void	uninstall() Uninstalls this customization script.
void	unload() Unloads this customization script.

Methods inherited from interface com.hpe.caf.worker.document.model.DocumentWorkerObject

getApplication

Method Detail

getIndex

int getIndex()

Returns the current position of this customization script in the parent list.

Returns:

the current position of this customization script in the parent list

getName

String getName()

Returns the name of the customization script.

This can be used as an identifier for the script. It may appear in the log file, especially if there is an issue with the script.

Returns:

the name of the customization script

getObject

Object getObject()

This property allows for communication between scripts. When the customization script is loaded it may define a global variable named "thisScriptObject". This property can be used to access the contents of that global variable, which could be an object of any type, including a function. If the script is not loaded, or if the global variable is not set by the script, then null is returned.

Returns:

an object that the script has elected to expose, or null if the script is not loaded or does not expose an object

getScript

String getScript()
          throws IOException

Retrieves the text of the script.

Note that there is no guarantee that the script code is cached. If the script is remote then calling this method multiple times may result in it being fetched multiple times.

Returns:

the source code of the script

Throws:

IOException - if the script is remote and cannot be retrieved

getTask

@Nonnull
Task getTask()

Returns the task that this customization script is associated with.

Returns:

the task that this customization script is associated with

install

void install()

Installs this customization script. Calling this method has no effect if the script is already installed.

Installing this script means that it will be included in the response message.

isInstalled

boolean isInstalled()

Checks whether this customization script is currently installed.

If it is installed then it will be included in the response message, otherwise it will not be.

Returns:

true if this customization script is installed

isLoaded

boolean isLoaded()

Checks whether this customization script is currently loaded.

The customization script must be loaded in order for its event handlers to be fired. It can only be modified when it is not loaded.

Returns:

true if this customization script is loaded

load

void load()
   throws ScriptException

Loads this customization script. Calling this method has no effect if the script is already loaded.

Throws:

RuntimeException - if the script has not been initialized

ScriptException - if the script cannot be retrieved or interpreted, or if it throws an error when loading

setName

void setName(String name)

Sets the name of the customization script. This may be used as an identifier for the script. If there is an issue with the script then it may appear in log files or in error messages.

This method will throw a RuntimeException if it is called when the script is currently loaded.

Parameters:

name - the name of the customization script

Throws:

RuntimeException - if this customization script is currently loaded

setScriptByReference

void setScriptByReference(String reference)

Sets the customization script. This method may be used when the script has been stored in the remote data store using the UTF-8 encoding. It does not verify that the remote data store reference is valid. No attempt will be made to download the script from the remote data store until the script is loaded.

This method will throw a RuntimeException if it is called when the script is currently loaded.

Parameters:

reference - the reference to the script in the remote data store

Throws:

RuntimeException - if this customization script is currently loaded

setScriptByReference

void setScriptByReference(String reference,
                          ScriptEngineType engineType)

Sets the customization script. This method may be used when the script has been stored in the remote data store using the UTF-8 encoding. It does not verify that the remote data store reference is valid. No attempt will be made to download the script from the remote data store until the script is loaded.

This method will throw a RuntimeException if it is called when the script is currently loaded.

Parameters:

reference - the reference to the script in the remote data store

engineType - the scripting engine to use

Throws:

RuntimeException - if this customization script is currently loaded

setScriptByUrl

void setScriptByUrl(URL url)

Sets the customization script. This method may be used when the location of the script is identified by the specified URL. If the script does not contain a recognized Unicode BOM then it is assumed to be UTF-8 encoded. No attempt will be made to download the script until it is loaded.

This method will throw a RuntimeException if it is called when the script is currently loaded.

Parameters:

url - the reference to the location where the script can be retrieved from

Throws:

RuntimeException - if this customization script is currently loaded, or if the specified URL is not strictly formatted in accordance with RFC2396

setScriptByUrl

void setScriptByUrl(URL url,
                    ScriptEngineType engineType)

Sets the customization script. This method may be used when the location of the script is identified by the specified URL. If the script does not contain a recognized Unicode BOM then it is assumed to be UTF-8 encoded. No attempt will be made to download the script until it is loaded.

This method will throw a RuntimeException if it is called when the script is currently loaded.

Parameters:

url - the reference to the location where the script can be retrieved from

engineType - the scripting engine to use

Throws:

RuntimeException - if this customization script is currently loaded, or if the specified URL is not strictly formatted in accordance with RFC2396

setScriptInline

void setScriptInline(String script)

Sets the customization script. This method may be used to directly specify a customization script so that it does not need to be downloaded from an external location in order to be loaded.

This method will throw a RuntimeException if it is called when the script is currently loaded.

Parameters:

script - the customization script

Throws:

RuntimeException - if this customization script is currently loaded

setScriptInline

void setScriptInline(String script,
                     ScriptEngineType engineType)

Sets the customization script. This method may be used to directly specify a customization script so that it does not need to be downloaded from an external location in order to be loaded.

This method will throw a RuntimeException if it is called when the script is currently loaded.

Parameters:

script - the customization script

engineType - the scripting engine to use

Throws:

RuntimeException - if this customization script is currently loaded

uninstall

void uninstall()

Uninstalls this customization script. Calling this method has no effect if the script is already uninstalled.

Uninstalling this script means that it will not be included in the response message.

unload

void unload()

Unloads this customization script. Calling this method has no effect if the script is already unloaded.

Unloading this script means that its event handlers will no longer be fired. It is required that the script is first unloaded in order to make any modifications to it.