com.hcl.domino.design.agent

Enum AgentTrigger

java.lang.Object

java.lang.Enum<AgentTrigger>

com.hcl.domino.design.agent.AgentTrigger

All Implemented Interfaces:

INumberEnum<Short>, Serializable, Comparable<AgentTrigger>

public enum AgentTrigger
extends Enum<AgentTrigger>
implements INumberEnum<Short>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCUPDATE When doc is updated
EVENT When an server event executes
MANUAL Manually executed
NEWMAIL When new mail delivered
NONE Unknown or unavailable
PASTED When documents pasted into database
SCHEDULED According to time schedule
SERVERSTART On server start
SYNCHNEWMAIL Synchronous new mail agent executed by router

Method Summary

Modifier and Type	Method and Description
long	getLongValue()
Short	getValue()
static AgentTrigger	valueOf(String name) Returns the enum constant of this type with the specified name.
static AgentTrigger[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final AgentTrigger NONE

Unknown or unavailable

SCHEDULED

public static final AgentTrigger SCHEDULED

According to time schedule

NEWMAIL

public static final AgentTrigger NEWMAIL

When new mail delivered

PASTED

public static final AgentTrigger PASTED

When documents pasted into database

MANUAL

public static final AgentTrigger MANUAL

Manually executed

DOCUPDATE

public static final AgentTrigger DOCUPDATE

When doc is updated

SYNCHNEWMAIL

public static final AgentTrigger SYNCHNEWMAIL

Synchronous new mail agent executed by router

EVENT

public static final AgentTrigger EVENT

When an server event executes

SERVERSTART

public static final AgentTrigger SERVERSTART

On server start

Method Detail

values

public static AgentTrigger[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AgentTrigger c : AgentTrigger.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AgentTrigger valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public Short getValue()

Specified by:

getValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum as a long