java.lang.Object
- java.lang.Enum<TriggerPoint>
- - com.redwood.scheduler.api.model.enumeration.TriggerPoint

All Implemented Interfaces:

BaseSchedulerEnumeration<TriggerPoint,Character>, SchedulerEnumeration<TriggerPoint>, Serializable, Comparable<TriggerPoint>
```
public enum TriggerPoint
extends Enum<TriggerPoint>
implements SchedulerEnumeration<TriggerPoint>
```
The points at which a trigger can be activated. (Character Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`BeforeDefinitionChange`	Synchronous trigger called before the Object definition has been changed.
`BeforeJobOnChange`	Synchronous trigger called before a Process (excluding System Maintenance Processes) changes status.
`BeforeJobOnChangeMaintenance`	Synchronous trigger called before a System Maintenance Process changes status.
`BeforeJobPostRunning`	Synchronous trigger called after a Process runs.
`BeforeJobPreRunning`	Synchronous trigger called before a Process is run.
`BeforeUserMessageOperation`	Synchronous trigger called before a user message operation is run.
`OnBeforeJobUserChange`	Synchronous trigger called when a user changed a process.
`OnJobFileContentAccess`	Synchronous trigger called when a user attempts to access the file content.

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`BeforeDefinitionChangeCode`	The char returned from BeforeDefinitionChange.getCodeEx().
`static char`	`BeforeJobOnChangeCode`	The char returned from BeforeJobOnChange.getCodeEx().
`static char`	`BeforeJobOnChangeMaintenanceCode`	The char returned from BeforeJobOnChangeMaintenance.getCodeEx().
`static char`	`BeforeJobPostRunningCode`	The char returned from BeforeJobPostRunning.getCodeEx().
`static char`	`BeforeJobPreRunningCode`	The char returned from BeforeJobPreRunning.getCodeEx().
`static char`	`BeforeUserMessageOperationCode`	The char returned from BeforeUserMessageOperation.getCodeEx().
`static char`	`OnBeforeJobUserChangeCode`	The char returned from OnBeforeJobUserChange.getCodeEx().
`static char`	`OnJobFileContentAccessCode`	The char returned from OnJobFileContentAccess.getCodeEx().

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`char`	`getCodeEx()`	Get the code that is used to represent this enumeration in the database.
`Character`	`getCodeExCharacter()`	Get the code that is used to represent this enumeration in the database.
`String`	`getCodeExString()`	Get the code that is used to represent this enumeration in the database.
`Character`	`getCodeExValue()`	Return the code for the enumeration item as the database type of this enumeration.
`String`	`getDescriptionKey()`	Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.
`String`	`getTranslationEN()`	Get the English name of this enumeration.
`String`	`getTranslationKey()`	Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.
`static TriggerPoint`	`safeValueOf(String value)`	Helper function to return the TriggerPoint represented by `value`.
`static TriggerPoint`	`valueOf(char code)`	Helper function to return the TriggerPoint represented by code.
`static TriggerPoint`	`valueOf(Character code)`	Helper function to return the TriggerPoint represented by code.
`static TriggerPoint`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static TriggerPoint`	`valueOfCode(String code)`	Helper function to return the TriggerPoint represented by code.
`static TriggerPoint[]`	`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

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal

Methods inherited from interface java.lang.Comparable
compareTo

- Enum Constant Detail
  - BeforeDefinitionChange
```
public static final TriggerPoint BeforeDefinitionChange
```
    Synchronous trigger called before the Object definition has been changed.
  - BeforeJobOnChange
```
public static final TriggerPoint BeforeJobOnChange
```
    Synchronous trigger called before a Process (excluding System Maintenance Processes) changes status.
  - BeforeJobOnChangeMaintenance
```
public static final TriggerPoint BeforeJobOnChangeMaintenance
```
    Synchronous trigger called before a System Maintenance Process changes status.
  - BeforeJobPreRunning
```
public static final TriggerPoint BeforeJobPreRunning
```
    Synchronous trigger called before a Process is run.
  - BeforeJobPostRunning
```
public static final TriggerPoint BeforeJobPostRunning
```
    Synchronous trigger called after a Process runs.
  - OnJobFileContentAccess
```
public static final TriggerPoint OnJobFileContentAccess
```
    Synchronous trigger called when a user attempts to access the file content.
  - BeforeUserMessageOperation
```
public static final TriggerPoint BeforeUserMessageOperation
```
    Synchronous trigger called before a user message operation is run.
  - OnBeforeJobUserChange
```
public static final TriggerPoint OnBeforeJobUserChange
```
    Synchronous trigger called when a user changed a process.
- Field Detail
  - BeforeDefinitionChangeCode
```
public static final char BeforeDefinitionChangeCode
```
    The char returned from BeforeDefinitionChange.getCodeEx().
    
    See Also:
    
    BeforeDefinitionChange, Constant Field Values
  - BeforeJobOnChangeCode
```
public static final char BeforeJobOnChangeCode
```
    The char returned from BeforeJobOnChange.getCodeEx().
    
    See Also:
    
    BeforeJobOnChange, Constant Field Values
  - BeforeJobOnChangeMaintenanceCode
```
public static final char BeforeJobOnChangeMaintenanceCode
```
    The char returned from BeforeJobOnChangeMaintenance.getCodeEx().
    
    See Also:
    
    BeforeJobOnChangeMaintenance, Constant Field Values
  - BeforeJobPreRunningCode
```
public static final char BeforeJobPreRunningCode
```
    The char returned from BeforeJobPreRunning.getCodeEx().
    
    See Also:
    
    BeforeJobPreRunning, Constant Field Values
  - BeforeJobPostRunningCode
```
public static final char BeforeJobPostRunningCode
```
    The char returned from BeforeJobPostRunning.getCodeEx().
    
    See Also:
    
    BeforeJobPostRunning, Constant Field Values
  - OnJobFileContentAccessCode
```
public static final char OnJobFileContentAccessCode
```
    The char returned from OnJobFileContentAccess.getCodeEx().
    
    See Also:
    
    OnJobFileContentAccess, Constant Field Values
  - BeforeUserMessageOperationCode
```
public static final char BeforeUserMessageOperationCode
```
    The char returned from BeforeUserMessageOperation.getCodeEx().
    
    See Also:
    
    BeforeUserMessageOperation, Constant Field Values
  - OnBeforeJobUserChangeCode
```
public static final char OnBeforeJobUserChangeCode
```
    The char returned from OnBeforeJobUserChange.getCodeEx().
    
    See Also:
    
    OnBeforeJobUserChange, Constant Field Values
- Method Detail
  - values
```
public static TriggerPoint[] 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 (TriggerPoint c : TriggerPoint.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TriggerPoint 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
  - valueOfCode
```
public static TriggerPoint valueOfCode(String code)
```
    Helper function to return the TriggerPoint represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.
    
    Parameters:
    
    code - A string with one character that is one of the codes for TriggerPoint
    
    Returns:
    
    The TriggerPoint corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static TriggerPoint safeValueOf(String value)
```
    Helper function to return the TriggerPoint represented by value. If value is null, or not a valid TriggerPoint enumeration then this method will return null.
    The main difference between this method and valueOf(String), is that this method will return null when passed an invalid value, valueOf(String) will throw an IllegalArgumentException.
    
    Parameters:
    
    value - The string value that corresponds to the requested enumeration value
    
    Returns:
    
    The TriggerPoint corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static TriggerPoint valueOf(Character code)
```
    Helper function to return the TriggerPoint represented by code. If code is null, or not a valid TriggerPoint code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The TriggerPoint corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static TriggerPoint valueOf(char code)
```
    Helper function to return the TriggerPoint represented by code. If code is not a valid TriggerPoint code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The TriggerPoint corresponding to code, or null, if code is not a valid code
  - getCodeEx
```
public char getCodeEx()
```
    Description copied from interface: SchedulerEnumeration
    
    Get the code that is used to represent this enumeration in the database.
    
    Specified by:
    
    getCodeEx in interface SchedulerEnumeration<TriggerPoint>
    
    Returns:
    
    the database code for the enumeration
  - getCodeExValue
```
public Character getCodeExValue()
```
    Description copied from interface: BaseSchedulerEnumeration
    
    Return the code for the enumeration item as the database type of this enumeration.
    
    Specified by:
    
    getCodeExValue in interface BaseSchedulerEnumeration<TriggerPoint,Character>
    
    Returns:
    
    the enumeration code
  - getCodeExCharacter
```
public Character getCodeExCharacter()
```
    Description copied from interface: SchedulerEnumeration
    
    Get the code that is used to represent this enumeration in the database.
    
    Specified by:
    
    getCodeExCharacter in interface SchedulerEnumeration<TriggerPoint>
    
    Returns:
    
    the database code for the enumeration
  - getTranslationKey
```
public String getTranslationKey()
```
    Description copied from interface: BaseSchedulerEnumeration
    
    Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.
    
    Specified by:
    
    getTranslationKey in interface BaseSchedulerEnumeration<TriggerPoint,Character>
    
    Returns:
    
    the key.
  - getTranslationEN
```
public String getTranslationEN()
```
    Description copied from interface: BaseSchedulerEnumeration
    
    Get the English name of this enumeration.
    
    Specified by:
    
    getTranslationEN in interface BaseSchedulerEnumeration<TriggerPoint,Character>
    
    Returns:
    
    the English name of this enumeration.
  - getDescriptionKey
```
public String getDescriptionKey()
```
    Description copied from interface: BaseSchedulerEnumeration
    
    Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.
    
    Specified by:
    
    getDescriptionKey in interface BaseSchedulerEnumeration<TriggerPoint,Character>
    
    Returns:
    
    the key that can be passed to SchedulerSession.translateField(String) to retrieve the translated description.
  - getCodeExString
```
public String getCodeExString()
```
    Description copied from interface: SchedulerEnumeration
    
    Get the code that is used to represent this enumeration in the database.
    
    Specified by:
    
    getCodeExString in interface SchedulerEnumeration<TriggerPoint>
    
    Returns:
    
    the database code for the enumeration

Enum TriggerPoint

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration

Methods inherited from interface java.lang.Comparable

Enum Constant Detail

BeforeDefinitionChange

BeforeJobOnChange

BeforeJobOnChangeMaintenance

BeforeJobPreRunning

BeforeJobPostRunning

OnJobFileContentAccess

BeforeUserMessageOperation

OnBeforeJobUserChange

Field Detail

BeforeDefinitionChangeCode

BeforeJobOnChangeCode

BeforeJobOnChangeMaintenanceCode

BeforeJobPreRunningCode

BeforeJobPostRunningCode

OnJobFileContentAccessCode

BeforeUserMessageOperationCode

OnBeforeJobUserChangeCode

Method Detail

values

valueOf

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExCharacter

getTranslationKey

getTranslationEN

getDescriptionKey

getCodeExString