com.ibm.portal.pcm.dialog.state
Enum DialogStateManager.Scope

java.lang.Object
  java.lang.Enum<DialogStateManager.Scope>
      com.ibm.portal.pcm.dialog.state.DialogStateManager.Scope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DialogStateManager.Scope>

Enclosing interface:

DialogStateManager

public static enum DialogStateManager.Scope
extends java.lang.Enum<DialogStateManager.Scope>

Scope in which dialog state details should be accumulated.

Since:

8.5

Enum Constant Summary

ACTIVE_DIALOG_EXPAND_NESTED
Exclude parent dialogs and expand nested dialogs into their respective dialog steps.

ACTIVE_DIALOG_WRAP_NESTED
Exclude parent dialogs and treat nested dialogs as one dialog step.

FULL_TRAIL_EXPAND_NESTED
Include parent dialogs and expand nested dialogs into their respective dialog steps.

FULL_TRAIL_WRAP_NESTED
Include parent dialogs and treat nested dialogs as one dialog step.

Method Summary

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

FULL_TRAIL_EXPAND_NESTED

public static final DialogStateManager.Scope FULL_TRAIL_EXPAND_NESTED

Include parent dialogs and expand nested dialogs into their respective dialog steps.

FULL_TRAIL_WRAP_NESTED

public static final DialogStateManager.Scope FULL_TRAIL_WRAP_NESTED

Include parent dialogs and treat nested dialogs as one dialog step.

ACTIVE_DIALOG_EXPAND_NESTED

public static final DialogStateManager.Scope ACTIVE_DIALOG_EXPAND_NESTED

Exclude parent dialogs and expand nested dialogs into their respective dialog steps.

ACTIVE_DIALOG_WRAP_NESTED

public static final DialogStateManager.Scope ACTIVE_DIALOG_WRAP_NESTED

Exclude parent dialogs and treat nested dialogs as one dialog step.

Method Detail

values

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

Returns:

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

valueOf

public static DialogStateManager.Scope 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