Enum Event

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Event>

    public enum Event
    extends java.lang.Enum<Event>
    Indicates the event at an annotation-based Behaviour should be triggered.

    This enum maps directly to the Behaviour.NotificationFrequency used to register Behaviours.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALL
      Maps to Alfresco's EVERY_EVENT NotificationFrequency.
      COMMIT
      Indicates the Behaviour should be triggered at the end, at the commit of the transaction.
      FIRST
      Indicates the Behaviour should be triggered only at the start.
      INHERITED_OR_ALL
      Indicates that the value should be inherited or default to ALL.
    • Method Summary

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

      • FIRST

        public static final Event FIRST
        Indicates the Behaviour should be triggered only at the start.
        See Also:
        Behaviour.NotificationFrequency.FIRST_EVENT
      • ALL

        public static final Event ALL
        Maps to Alfresco's EVERY_EVENT NotificationFrequency. From the official Alfresco documentation: "The event handler is then just executed wherever it is being invoked in the code. The name of this notification frequency implies that the event handler will be called multiple times, which is true. The EVERY_EVENT notification frequency can be called numerous times within a single transaction (a lot more than you might expect), so unless your behavior logic is fast+in-repository-only (no RPCs, no external data access, etc.) or asynchronous, it’s easy to seriously impact Alfresco’s performance. ..."
        See Also:
        Behaviour.NotificationFrequency.EVERY_EVENT
      • COMMIT

        public static final Event COMMIT
        Indicates the Behaviour should be triggered at the end, at the commit of the transaction.
        See Also:
        Behaviour.NotificationFrequency.TRANSACTION_COMMIT
    • Method Detail

      • values

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

        public static Event 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