org.wizard4j.engine
Enum EGroupType

java.lang.Object
  java.lang.Enum<EGroupType>
      org.wizard4j.engine.EGroupType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EGroupType>

public enum EGroupType
extends java.lang.Enum<EGroupType>

This enumeration lists the various ways to group user interactions.

The execution of a flowchart results in a sequence of user interactions. A user interaction is either a request to provide information (user-input) or an announcement to the user (user-info). The flowchart elements input and info map to user-input and user-info. For the other flowchart elements (switch, loop, ...) the mapping depends on the type and the context.

These user interactions can be presented one-by-one to the user or they can be combined in a single request-response cycle. A number of ways to group user interactions are supported.

Enum Constant Summary

COMBINE_NEIGHBOURING_INPUTS
Combine all neighbouring user-inputs corresponding to a flowchart input in a single response.

COMBINE_NEIGHBOURING_LEAVES
Combine all neighbouring user interactions corresponding to a flowchart input or a flowchart info in a single response.

COMBINE_NEIGHBOURING_LEAVES_NEXTSWITCHORLOOP
Combine all neighbouring user interactions corresponding to a flowchart input or a flowchart info in a single response and also include the user interaction (user-input or user-info) corresponding to the subsequent flowchart switch or flowchart loop.

SINGLE
Every user interaction (user-input or user-info) is presented to the user in a single response.

Method Summary

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

SINGLE

public static final EGroupType SINGLE

Every user interaction (user-input or user-info) is presented to the user in a single response.

COMBINE_NEIGHBOURING_INPUTS

public static final EGroupType COMBINE_NEIGHBOURING_INPUTS

Combine all neighbouring user-inputs corresponding to a flowchart input in a single response. I.e. neighbouring in the tree presentation of the flowchart.

COMBINE_NEIGHBOURING_LEAVES

public static final EGroupType COMBINE_NEIGHBOURING_LEAVES

Combine all neighbouring user interactions corresponding to a flowchart input or a flowchart info in a single response. I.e. neighbouring in the tree presentation of the flowchart.

COMBINE_NEIGHBOURING_LEAVES_NEXTSWITCHORLOOP

public static final EGroupType COMBINE_NEIGHBOURING_LEAVES_NEXTSWITCHORLOOP

Combine all neighbouring user interactions corresponding to a flowchart input or a flowchart info in a single response and also include the user interaction (user-input or user-info) corresponding to the subsequent flowchart switch or flowchart loop.

Method Detail

values

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

Returns:

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

valueOf

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

names

public static java.util.List<java.lang.String> names()