com.hcl.domino.design

Interface DesignAgent

All Superinterfaces:

DesignElement, DesignElement.NamedDesignElement

public interface DesignAgent
extends DesignElement.NamedDesignElement

Access to a database design. Search for design, database as constructor parameter

Author:

t.b.d

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DesignAgent.AgentLanguage

Nested classes/interfaces inherited from interface com.hcl.domino.design.DesignElement

DesignElement.NamedDesignElement

Method Summary

Modifier and Type	Method and Description
AgentContent	getAgentContent() Retrieves the action content of the agent.
DesignAgent.AgentLanguage	getAgentLanguage() Language the agent is written using
Optional<DominoDateTime>	getEndDate() Gets the last date that the agent is able to run, if applicable
OptionalInt	getInterval() Retrieves the interval value for the agent.
AgentInterval	getIntervalType() Interval type for the agent
OptionalLong	getLastRunDuration() Analyses the last run log to work out the number of seconds for last run duration
OptionalInt	getRunDayOfMonth() Retrieves the 1-based day of the month that the agent should run.
Optional<DayOfWeek>	getRunDayOfWeek() Retrieves the day of the week that the agent should run.
Optional<LocalTime>	getRunEndLocalTime() Retrieves the local time of day when the agent should no longer be executed.
Optional<LocalTime>	getRunLocalTime() Retrieves the local time of day when the agent should be run or start execution, if the interval type is not NONE or EVENT.
String	getRunLocation() Gets the server to run on.
String	getRunLog() Gets the last run log for the agent.
List<String>	getRunLogAsList() Splits the run log into a String for each line
Optional<DominoDateTime>	getStartDate() Gets the earliest date that the agent is able to run, if applicable
AgentTrigger	getTrigger()
DesignAgent	initializeAgentLanguage(DesignAgent.AgentLanguage lang) Language the agent should parse as
boolean	isLastRunExceededTimeLimit() Analyses the last run log to work out if the last run exceeded the max run time for agents.
boolean	isRunOnWeekends() Whether or not the agent runs on weekends, only relevant for DAILY or MORE_THAN_DAILY

Methods inherited from interface com.hcl.domino.design.DesignElement.NamedDesignElement

getAliases, getTitle, setTitle

Methods inherited from interface com.hcl.domino.design.DesignElement

getComment, getDesignerVersion, getDocument, getItemNames, isHideFromMobile, isHideFromNotes, isHideFromWeb, isProhibitRefresh, save, setComment, setHideFromMobile, setHideFromNotes, setHideFromWeb, setProhibitRefresh, sign, sign

Method Detail

getTrigger

AgentTrigger getTrigger()

Returns:

the trigger type for the agent, or AgentTrigger#NONE if the agent is unavailable

getAgentLanguage

DesignAgent.AgentLanguage getAgentLanguage()

Language the agent is written using

Returns:

AgentLanguage

initializeAgentLanguage

DesignAgent initializeAgentLanguage(DesignAgent.AgentLanguage lang)

Language the agent should parse as

Parameters:

lang - the agent language

Returns:

this Agent

getRunLocation

String getRunLocation()

Gets the server to run on. This value will be one of:

• A server name when one is specified
• A user name when set to "Local"
• "*" when set to run on any server
• "" when set to prompt for a server name when enabled

Returns:

configured server run location

getIntervalType

AgentInterval getIntervalType()

Interval type for the agent

Returns:

the agent's interval type, or AgentInterval#NONE if not applicable

getInterval

OptionalInt getInterval()

Retrieves the interval value for the agent. The meaning of this number depends on the value of getIntervalType():

NONE

An empty value

MINUTES

The interval between invocations in minutes

DAYS

The interval between invocations in days*

WEEK

The interval between invocations in weeks*

MONTH

The interval between invocations in months*

AgentInterval.EVENT

An empty value

Note: other than for MINUTES, the interval value is not expressible in Domino Designer and may not affect the behavior of the agent on the server.

Returns:

an OptionalInt describing the interval, or an empty one if it is not applicable

getStartDate

Optional<DominoDateTime> getStartDate()

Gets the earliest date that the agent is able to run, if applicable

Returns:

a Optional representing the start date as a DominoDateTime, or an empty one if this is not applicable

getEndDate

Optional<DominoDateTime> getEndDate()

Gets the last date that the agent is able to run, if applicable

Returns:

a Optional representing the end datte as a DominoDateTime, or an empty one if this is not applicable

getRunLocalTime

Optional<LocalTime> getRunLocalTime()

Retrieves the local time of day when the agent should be run or start execution, if the interval type is not NONE or EVENT.

Returns:

an Optional describing the local time to run, or an empty one if this value does not apply

getRunEndLocalTime

Optional<LocalTime> getRunEndLocalTime()

Retrieves the local time of day when the agent should no longer be executed. This only applies when the interval type is MINUTES.

Returns:

an Optional describing the local end time of execution, or an empty one if the agent interval is not MINUTES

getRunDayOfWeek

Optional<DayOfWeek> getRunDayOfWeek()

Retrieves the day of the week that the agent should run. This only applies when the interval type is WEEK.

Returns:

an Optional describing the day of the week to execute, or an empty one if the agent interval is not WEEK

getRunDayOfMonth

OptionalInt getRunDayOfMonth()

Retrieves the 1-based day of the month that the agent should run. This only applies when the interval type is MONTH.

Returns:

an OptionalInt describing the day of the month to execute, or an empty one if the agent interval is not MONTH

isRunOnWeekends

boolean isRunOnWeekends()

Whether or not the agent runs on weekends, only relevant for DAILY or MORE_THAN_DAILY

Returns:

whether it runs on weekends. WEEKLY or MONTHLY returns true

getRunLog

String getRunLog()

Gets the last run log for the agent. If the agent has not run since last log, it is a blank String.

Returns:

String containing run log

getRunLogAsList

List<String> getRunLogAsList()

Splits the run log into a String for each line

Returns:

List of run log messages

getLastRunDuration

OptionalLong getLastRunDuration()

Analyses the last run log to work out the number of seconds for last run duration

Returns:

an OptionalLong describing the number of seconds between start and end of last run time, or an empty one if it has no run record

isLastRunExceededTimeLimit

boolean isLastRunExceededTimeLimit()

Analyses the last run log to work out if the last run exceeded the max run time for agents. Combine with getLastRunDuration() to work out what that max run time setting is.

Returns:

whether the last run time exceeded max run time for agents. If there is no run log, this will also be false

getAgentContent

AgentContent getAgentContent()

Retrieves the action content of the agent. The actual type of object depends on the language of the agent.

Returns:

an AgentContent instance representing the content of the agent