com.mindoo.remote.api.jobs
Interface IRemoteJavascriptAction

All Superinterfaces:

IRemoteAgentAction

public interface IRemoteJavascriptAction
extends IRemoteAgentAction

Job action to execute a JavaScript method in a SSJS library while a job is running or when it is done.
To pass data between the Job code and the action, the API creates a temporary context Notes document. The document is shared between the job and the JavaScript method invocation and accessible via the global context variable.

This is the complete list of available global Javascript variables during the method invocation:
session - active Notes session
database - database containing the SSJS library
eclipseconnection - connection instance to call remote API Eclipse methods
context - temporary document to share Job results and progress

Method Summary

java.lang.String	getDbPath() Filepath of agent's database
java.lang.String	getDescription() Optional description text for the progress dialog of the agent
java.lang.String	getMethodName() Name of JavaScript method to be called
java.lang.String	getServer() Server of agent's database
java.lang.String	getSSJSLibName() Name of SSJS library

Method Detail

getServer

java.lang.String getServer()
                           throws RemoteEclipseAPIException

Server of agent's database

Returns:

server

Throws:

RemoteEclipseAPIException

getDbPath

java.lang.String getDbPath()
                           throws RemoteEclipseAPIException

Filepath of agent's database

Returns:

filepath

Throws:

RemoteEclipseAPIException

getSSJSLibName

java.lang.String getSSJSLibName()
                                throws RemoteEclipseAPIException

Name of SSJS library

Returns:

library name

Throws:

RemoteEclipseAPIException

getMethodName

java.lang.String getMethodName()
                               throws RemoteEclipseAPIException

Name of JavaScript method to be called

Returns:

method name

Throws:

RemoteEclipseAPIException

getDescription

java.lang.String getDescription()
                                throws RemoteEclipseAPIException

Optional description text for the progress dialog of the agent

Returns:

description or null to use the default text ("OK")

Throws:

RemoteEclipseAPIException