com.hcl.domino.data

Interface Agent

public interface Agent

Details about the Agent

Author:

t.b.d.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Agent.AgentRunContext

Method Summary

Modifier and Type	Method and Description
Agent.AgentRunContext	createAgentContext() Initializes the AgentRunContext in which the agent should run, for defining settings like re-opening the database as the signer, which document the agent should run on, timeouts etc.
Optional<Document>	getAgentSavedData() The returned document is created when you save an agent, and it is stored in the same database as the agent. The document replicates, but is not displayed in views. Each time you edit and re-save an agent, its saved data document is deleted and a new, blank one is created.
List<String>	getAliases() Gets any aliases for the agent.
String	getComment() Gets any comment the developer has assigned for the agent
String	getName() Gets the agent's Name
int	getNoteID() NoteID location of the agent's design element, specific only for this replica of the Database
Database	getParentDatabase() Database containing the agent
String	getUNID() Domino UNID of the agent's design element
boolean	isEnabled() Gets whether or not the agent is set to be run on a schedule and is enabled
boolean	isRunAsWebUser() Gets whether or not the agent should run as the web user instead of the signer
void	run(Agent.AgentRunContext runCtx) Runs the agent with the specific agent context
void	runOnServer(boolean suppressPrintToConsole) Runs the agent on the server
void	runOnServer(int noteIdParamDoc, boolean suppressPrintToConsole) Runs the agent on the server

Method Detail

getName

String getName()

Gets the agent's Name

Returns:

agent's name, not null

getAliases

List<String> getAliases()

Gets any aliases for the agent. If there are no aliases, an empty List is returned.

Returns:

list of aliases

getParentDatabase

Database getParentDatabase()

Database containing the agent

Returns:

parent database in which the agent resides

getUNID

String getUNID()

Domino UNID of the agent's design element

Returns:

32 character hex string to retrieve the agent's design element

getNoteID

int getNoteID()

NoteID location of the agent's design element, specific only for this replica of the Database

Returns:

int corresponding to the String note ID of format 000020FA

getComment

String getComment()

Gets any comment the developer has assigned for the agent

Returns:

comment, not null

isEnabled

boolean isEnabled()

Gets whether or not the agent is set to be run on a schedule and is enabled

Returns:

true if the agent is scheduled and enabled

isRunAsWebUser

boolean isRunAsWebUser()

Gets whether or not the agent should run as the web user instead of the signer

Returns:

true if the agent should run as the web user

getAgentSavedData

Optional<Document> getAgentSavedData()

The returned document is created when you save an agent, and it is stored in the same database as the agent.
The document replicates, but is not displayed in views.
Each time you edit and re-save an agent, its saved data document is deleted and a new, blank one is created. When you delete an agent, its saved data document is deleted.

Returns:

an Optional describing the saved agent data, or an empty one if there is no saved data

createAgentContext

Agent.AgentRunContext createAgentContext()

Initializes the AgentRunContext in which the agent should run, for defining settings like re-opening the database as the signer, which document the agent should run on, timeouts etc.

Returns:

AGentRunContext, ready to receive setters

run

void run(Agent.AgentRunContext runCtx)

Runs the agent with the specific agent context

Parameters:

runCtx - AgentRunContext that defines run settings

runOnServer

void runOnServer(boolean suppressPrintToConsole)

Runs the agent on the server

Parameters:

suppressPrintToConsole - true to not write "Print" statements in the agent code to the server console

runOnServer

void runOnServer(int noteIdParamDoc,
                 boolean suppressPrintToConsole)

Runs the agent on the server

Parameters:

noteIdParamDoc - note id of parameter document

suppressPrintToConsole - true to not write "Print" statements in the agent code to the server console