com.ace.moab.api.triggers
Class TriggerVariable

java.lang.Object
  com.ace.moab.api.triggers.TriggerVariable

public class TriggerVariable
extends java.lang.Object

This class represents trigger variables that can add greater flexibility and power to a site that wishes to automate certain tasks and system behaviors. Variables allow triggers to launch based on another trigger's behavior, state, and/or output.

Constructor Summary

TriggerVariable()

TriggerVariable(java.lang.String id)

TriggerVariable(java.lang.String id, TriggerVariableType type, java.lang.Object value)

TriggerVariable(java.lang.String id, TriggerVariableType type, java.lang.Object value, boolean isExported)

Method Summary

java.lang.String	getId()
TriggerVariableType	getType()
java.lang.Object	getValue()
boolean	isExported()
static java.util.Set<TriggerVariable>	parseMultipleVariablesString(java.lang.String string) Parses a period separated list of trigger variables and converts them into respective TriggerVariable objects.
static TriggerVariable	parseString(java.lang.String string)
void	setExported(boolean isExported)
void	setId(java.lang.String id)
void	setType(TriggerVariableType type)
void	setValue(java.lang.Object value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TriggerVariable

public TriggerVariable()

TriggerVariable

public TriggerVariable(java.lang.String id)

TriggerVariable

public TriggerVariable(java.lang.String id,
                       TriggerVariableType type,
                       java.lang.Object value)

TriggerVariable

public TriggerVariable(java.lang.String id,
                       TriggerVariableType type,
                       java.lang.Object value,
                       boolean isExported)

Method Detail

getId

public java.lang.String getId()

getType

public TriggerVariableType getType()

getValue

public java.lang.Object getValue()

isExported

public boolean isExported()

setExported

public void setExported(boolean isExported)

setId

public void setId(java.lang.String id)

setType

public void setType(TriggerVariableType type)

setValue

public void setValue(java.lang.Object value)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parseString

public static TriggerVariable parseString(java.lang.String string)
                                   throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

parseMultipleVariablesString

public static java.util.Set<TriggerVariable> parseMultipleVariablesString(java.lang.String string)

Parses a period separated list of trigger variables and converts them into respective TriggerVariable objects.

Parameters:

string - the string to be parsed.

Returns:

a set of TriggerVariable corresponding to the variables described by the input string. If no variables were detected, null is returned.