io.spokestack.spokestack.dialogue.policy

Enum Model.Rule.Type

java.lang.Object

java.lang.Enum<Model.Rule.Type>

io.spokestack.spokestack.dialogue.policy.Model.Rule.Type

All Implemented Interfaces:

Serializable, Comparable<Model.Rule.Type>

Enclosing class:

Model.Rule

public static enum Model.Rule.Type
extends Enum<Model.Rule.Type>

The types of rules that can be attached to nodes or features.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONFIRMATION A rule specifying that the system needs extra confirmation from the user before leaving the current conversation state (if the rule is attached to a node) or executing the associated feature.
INTENT_OVERRIDE A rule that transforms the intent specified by its Model.Rule.key into the one specified by its Model.Rule.value.
REDIRECT_NEGATIVE A rule that redirects to a specified node ID if its Model.Rule.key does not match its Model.Rule.value.
REDIRECT_POSITIVE A rule that redirects to a specified node ID if its Model.Rule.key matches its Model.Rule.value.
SLOT A rule typically attached to features that requires the slot stored in Model.Rule.key be present before the feature can be executed.
SLOT_ONE_OF A rule typically attached to features that requires one of the slots stored in Model.Rule.keys be present before the feature can be executed.
UNKNOWN An unknown rule type, used to avoid errors during deserialization.

Method Summary

Modifier and Type	Method and Description
boolean	isRedirect()
static Model.Rule.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static Model.Rule.Type[]	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

SLOT

@SerializedName(value="slot")
public static final Model.Rule.Type SLOT

A rule typically attached to features that requires the slot stored in Model.Rule.key be present before the feature can be executed.

SLOT_ONE_OF

@SerializedName(value="slot_one_of")
public static final Model.Rule.Type SLOT_ONE_OF

A rule typically attached to features that requires one of the slots stored in Model.Rule.keys be present before the feature can be executed.

CONFIRMATION

@SerializedName(value="confirmation")
public static final Model.Rule.Type CONFIRMATION

A rule specifying that the system needs extra confirmation from the user before leaving the current conversation state (if the rule is attached to a node) or executing the associated feature.

INTENT_OVERRIDE

@SerializedName(value="intent_override")
public static final Model.Rule.Type INTENT_OVERRIDE

A rule that transforms the intent specified by its Model.Rule.key into the one specified by its Model.Rule.value.

REDIRECT_POSITIVE

@SerializedName(value="redirect_positive")
public static final Model.Rule.Type REDIRECT_POSITIVE

A rule that redirects to a specified node ID if its Model.Rule.key matches its Model.Rule.value.

REDIRECT_NEGATIVE

@SerializedName(value="redirect_negative")
public static final Model.Rule.Type REDIRECT_NEGATIVE

A rule that redirects to a specified node ID if its Model.Rule.key does not match its Model.Rule.value.

UNKNOWN

public static final Model.Rule.Type UNKNOWN

An unknown rule type, used to avoid errors during deserialization.

Method Detail

values

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

Returns:

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

valueOf

public static Model.Rule.Type 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

isRedirect

public boolean isRedirect()

Returns:

true if this rule redirects to a new conversation node when triggered; false otherwise.