com.mindoo.remote.api.jobs
Interface IRemoteRunUIAgentAction

All Superinterfaces:

IRemoteAgentAction

public interface IRemoteRunUIAgentAction
extends IRemoteAgentAction

Job action to launch a Notes agent in the Notes UI thread 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. In the UI agent code, you can get the Notes URL for this context document by reading the "mndResultDocUrl" field of the DocumentContext document returned by lotus.domino.Session#getAgentContext() and lotus.domino.AgentContext#getDocumentContext()

Method Summary

java.lang.String	getAgentName() Name of agent
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	getServer() Server of agent's database

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

getAgentName

java.lang.String getAgentName()
                              throws RemoteEclipseAPIException

Name of agent

Returns:

agent 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