Package com.kenshoo.pl.entity.audit

Enum AuditTrigger

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AuditTrigger>
    public enum AuditTrigger
extends java.lang.Enum<AuditTrigger>
    Indicates the rule by which to trigger the auditing of a field, following execution of a command.
    See Also:
    Audited, AuditRecord

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static AuditTrigger valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AuditTrigger[] 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

      • ON_CREATE_OR_UPDATE

        public static final AuditTrigger ON_CREATE_OR_UPDATE
        Indicates that a field should be audited only if it is either being created, or its value has been changed by an update.
        This means that:
        Upon create, the new value will be included in AuditRecord.getFieldRecords().
        Upon update if the value has changed - the old and new values will be included in AuditRecord.getFieldRecords().

      • ON_UPDATE

        public static final AuditTrigger ON_UPDATE
        Indicates that a field should be audited only if its value has been changed by an update.
        This means that upon update if the value has changed - the old and new values will be included in AuditRecord.getFieldRecords().

    • Method Detail

      • values

        public static AuditTrigger[] 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 (AuditTrigger c : AuditTrigger.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AuditTrigger valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null