com.zion.jbuddy.bots
Class BotParameterType

java.lang.Object
  com.zion.jbuddy.bots.BotParameterType

public class BotParameterType
extends Object

Available parameter types.

Parameter types tell the bot engine what type of value to expect from the user. Some parameters expect a certain value format, and if an entered value is invalid, the user will be sent an error message and prompted to enter a valid value again.

Types also dictate the kind of object that is saved to a BotActionTask after a user enters a valid parameter value.

See Also:

BotParameter, BotActionTask

Field Summary

static BotParameterType	BOOLEAN Accepts true/false values.
static BotParameterType	CURRENCY Accepts numeric currency values.
static BotParameterType	DATE Accepts date values.
static BotParameterType	DATE_TIME Accepts combined date/time values.
static BotParameterType	DOUBLE Accepts floating-point numbers between 2-1074 and (2 - 2-52) x 21023, inclusive.
static BotParameterType	INT Accepts whole numbers between -232 and 232-1, inclusive.
static BotParameterType	LONG Accepts whole numbers between -263 and 263-1, inclusive.
static BotParameterType	NUMBER Accepts numeric values.
static BotParameterType	PERCENT Accepts numeric percentage values.
static BotParameterType	STRING Accepts literal strings.
static BotParameterType	TIME Accepts time values.

Method Summary

static BotParameterType	get(String key)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STRING

public static BotParameterType STRING

Accepts literal strings. The string isn't expected to have any specific format, unless the parameter has validation patterns set.

The value can be retrieved from a BotActionTask as a String object.

This is the default parameter type.

BOOLEAN

public static BotParameterType BOOLEAN

Accepts true/false values.

Valid true values:

• true
• t
• yes
• y

Valid false values:

• false
• f
• no
• n

The available choices may be changed in the bot's resource bundle.

The value can be retrieved from a BotActionTask as a Boolean object.

INT

public static BotParameterType INT

Accepts whole numbers between -232 and 232-1, inclusive.

The value can be retrieved from a BotActionTask as a Integer object.

LONG

public static BotParameterType LONG

Accepts whole numbers between -263 and 263-1, inclusive.

The value can be retrieved from a BotActionTask as a Long object.

DOUBLE

public static BotParameterType DOUBLE

Accepts floating-point numbers between 2-1074 and (2 - 2-52) x 21023, inclusive.

The value can be retrieved from a BotActionTask as a Double object.

NUMBER

public static BotParameterType NUMBER

Accepts numeric values.

The format depends on the parameter's locale and numberFormat.

The value can be retrieved from a BotActionTask as a Number object.

CURRENCY

public static BotParameterType CURRENCY

Accepts numeric currency values.

The format depends on the parameter's locale and numberFormat.

The value can be retrieved from a BotActionTask as a Number object.

PERCENT

public static BotParameterType PERCENT

Accepts numeric percentage values.

The format depends on the parameter's locale and numberFormat.

The value can be retrieved from a BotActionTask as a Number object.

DATE

public static BotParameterType DATE

Accepts date values.

The format depends on the parameter's locale, dateStyle, and dateFormat.

The value can be retrieved from a BotActionTask as a Date object.

TIME

public static BotParameterType TIME

Accepts time values.

The format depends on the parameter's locale, timeStyle, and dateFormat.

The value can be retrieved from a BotActionTask as a Date object.

DATE_TIME

public static BotParameterType DATE_TIME

Accepts combined date/time values.

The format depends on the parameter's locale, dateStyle, timeStyle, and dateFormat.

The value can be retrieved from a BotActionTask as a Date object.

Method Detail

get

public static BotParameterType get(String key)

toString

public String toString()

Overrides:

toString in class Object