com.hpe.caf.worker.document.impl

Class ScriptImpl

java.lang.Object

com.hpe.caf.worker.document.impl.DocumentWorkerObjectImpl

com.hpe.caf.worker.document.impl.ScriptImpl

All Implemented Interfaces:

DocumentWorkerObject, Script

public final class ScriptImpl
extends DocumentWorkerObjectImpl
implements Script

Field Summary

Fields inherited from class com.hpe.caf.worker.document.impl.DocumentWorkerObjectImpl

application

Constructor Summary

Constructors

Constructor and Description
ScriptImpl(ApplicationImpl application, AbstractTask task)
ScriptImpl(ApplicationImpl application, AbstractTask task, DocumentWorkerScript script)

Method Summary

Modifier and Type	Method and Description
int	getIndex()
String	getName()
Object	getObject()
String	getScript()
Task	getTask()
void	install()
boolean	isInstalled()
boolean	isLoaded()
void	load()
void	raiseEvent(String event, Object... args) Raises the specified event in this script if it is currently loaded.
void	setName(String name)
void	setScriptByReference(String reference)
void	setScriptByReference(String reference, ScriptEngineType engineType)
void	setScriptByUrl(URL url)
void	setScriptByUrl(URL url, ScriptEngineType engineType)
void	setScriptInline(String script)
void	setScriptInline(String script, ScriptEngineType engineType)
boolean	shouldIncludeInResponse()
DocumentWorkerScript	toDocumentWorkerScript()
void	uninstall()
void	unload()

Methods inherited from class com.hpe.caf.worker.document.impl.DocumentWorkerObjectImpl

getApplication

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getApplication

Constructor Detail

ScriptImpl

public ScriptImpl(ApplicationImpl application,
                  AbstractTask task)

ScriptImpl

public ScriptImpl(ApplicationImpl application,
                  AbstractTask task,
                  DocumentWorkerScript script)
           throws InvalidScriptException

Throws:

InvalidScriptException

Method Detail

getIndex

public int getIndex()

Specified by:

getIndex in interface Script

getName

public String getName()

Specified by:

getName in interface Script

getObject

public Object getObject()

Specified by:

getObject in interface Script

getScript

public String getScript()
                 throws IOException

Specified by:

getScript in interface Script

Throws:

IOException

getTask

@Nonnull
public Task getTask()

Specified by:

getTask in interface Script

install

public void install()

Specified by:

install in interface Script

isInstalled

public boolean isInstalled()

Specified by:

isInstalled in interface Script

isLoaded

public boolean isLoaded()

Specified by:

isLoaded in interface Script

load

public void load()
          throws ScriptException

Specified by:

load in interface Script

Throws:

ScriptException

setName

public void setName(String name)

Specified by:

setName in interface Script

setScriptByReference

public void setScriptByReference(String reference)

Specified by:

setScriptByReference in interface Script

setScriptByReference

public void setScriptByReference(String reference,
                                 ScriptEngineType engineType)

Specified by:

setScriptByReference in interface Script

setScriptByUrl

public void setScriptByUrl(URL url)

Specified by:

setScriptByUrl in interface Script

setScriptByUrl

public void setScriptByUrl(URL url,
                           ScriptEngineType engineType)

Specified by:

setScriptByUrl in interface Script

setScriptInline

public void setScriptInline(String script)

Specified by:

setScriptInline in interface Script

setScriptInline

public void setScriptInline(String script,
                            ScriptEngineType engineType)

Specified by:

setScriptInline in interface Script

uninstall

public void uninstall()

Specified by:

uninstall in interface Script

unload

public void unload()

Specified by:

unload in interface Script

raiseEvent

public void raiseEvent(String event,
                       Object... args)

Raises the specified event in this script if it is currently loaded.

If the event throws a checked exception then this will be wrapped in a RuntimeException.

Parameters:

event - the event to raise

args - the arguments to be passed to the event

shouldIncludeInResponse

public boolean shouldIncludeInResponse()

toDocumentWorkerScript

public DocumentWorkerScript toDocumentWorkerScript()