com.silverpeas.notification
Enum SilverpeasNotificationCause

java.lang.Object
  java.lang.Enum<SilverpeasNotificationCause>
      com.silverpeas.notification.SilverpeasNotificationCause

All Implemented Interfaces:

Serializable, Comparable<SilverpeasNotificationCause>

public enum SilverpeasNotificationCause
extends Enum<SilverpeasNotificationCause>

In Silverpeas, the notifications that are sent through the Sivlerpeas Notification System are mainly for business object deletion, creation, ... This enumeration lists the different causes that has triggered a notification and they can then passed as parameter in the notification message (a SilverpeasNotification instance).

Enum Constant Summary

CREATION

DELETION

UPDATE

Field Summary

static String

CAUSE_TYPE The name of the parameter under which the cause should be set in the notification message.

Method Summary

static SilverpeasNotificationCause	valueOf(String name) Returns the enum constant of this type with the specified name.
static SilverpeasNotificationCause[]	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

DELETION

public static final SilverpeasNotificationCause DELETION

CREATION

public static final SilverpeasNotificationCause CREATION

UPDATE

public static final SilverpeasNotificationCause UPDATE

Field Detail

CAUSE_TYPE

public static String CAUSE_TYPE

The name of the parameter under which the cause should be set in the notification message.

Method Detail

values

public static SilverpeasNotificationCause[] 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 (SilverpeasNotificationCause c : SilverpeasNotificationCause.values())
    System.out.println(c);

Returns:

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

valueOf

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