com.ibm.tivoli.imi.controller

Enum TsdIMException.Code

java.lang.Object

java.lang.Enum<TsdIMException.Code>

com.ibm.tivoli.imi.controller.TsdIMException.Code

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TsdIMException.Code>

Enclosing class:

TsdIMException

public static enum TsdIMException.Code
extends java.lang.Enum<TsdIMException.Code>

Every TsdIMException must have a code which identifies a generic reason or cause that generated the exception. This feature has two advantages:
1- Prevents the project to have a lot of different TsdIMException subclasses
2- Allows the programmer to use internationalization techniques using TsdIMException code instead of its message (String).

Note: the Exception.getMessage() method returns the default description of the code assigned to this IM exception (in English) and the message, (if set)

Author:

fabiosc

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHAT_ABORTED_NOT_SAVED
CHAT_ABORTION_EXCEPTION
INVALID_CHAT_IDENTIFIER This exception is used when a chat window (JavaScript on client side) attempts to get a ChatHelper but does not have a valid identifier.
NLS_RESOURCE_BUNDLE

Method Summary

Modifier and Type	Method and Description
static TsdIMException.Code	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TsdIMException.Code[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CHAT_ABORTION_EXCEPTION

public static final TsdIMException.Code CHAT_ABORTION_EXCEPTION

CHAT_ABORTED_NOT_SAVED

public static final TsdIMException.Code CHAT_ABORTED_NOT_SAVED

INVALID_CHAT_IDENTIFIER

public static final TsdIMException.Code INVALID_CHAT_IDENTIFIER

This exception is used when a chat window (JavaScript on client side) attempts to get a ChatHelper but does not have a valid identifier. It happens when there is already a ChatHelper for its sessionId being used by other chat window which requested that first

NLS_RESOURCE_BUNDLE

public static final TsdIMException.Code NLS_RESOURCE_BUNDLE

Method Detail

values

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

Returns:

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

valueOf

public static TsdIMException.Code 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