com.sap.tc.cmi.messages

Enum CMIMessageLifetime

java.lang.Object
  java.lang.Enum<CMIMessageLifetime>
      com.sap.tc.cmi.messages.CMIMessageLifetime

All Implemented Interfaces:

Serializable, Comparable<CMIMessageLifetime>

public enum CMIMessageLifetime
extends Enum<CMIMessageLifetime>

Enumeration of the possible lifetimes of a message.

Since:

NW NewYork

Type Classification:

This class is part of the Common Model Interface, so applications may reference it or call any method of this type, but they must not subclass it.

Enum Constant Summary

DISPLAY_ONCE
Messages need to be displayed exactly once to the end user and are then deleted.

PERMANENT
Messages with permanent lifetime must be displayed as long as they exist.

Method Summary

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

PERMANENT

public static final CMIMessageLifetime PERMANENT

Messages with permanent lifetime must be displayed as long as they exist. They can be marked as processed, to prevent multiple users from adding the same message more than once. Calling the method resetOrDelete() leads to resetting the processed flag, but the message is not deleted. It is up to the model type implementation to delete permanent messages when needed.

DISPLAY_ONCE

public static final CMIMessageLifetime DISPLAY_ONCE

Messages need to be displayed exactly once to the end user and are then deleted.

Method Detail

values

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

Returns:

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

valueOf

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

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] FRAMEWORK	[sap.com] tc/cm/ejb/api	api	BC-JAS-EJB
[sap.com] FRAMEWORK	[sap.com] tc/cmi	default	BC-WD-JAV-RUN