com.izforge.izpack.api.data

Interface DynamicVariable

All Superinterfaces:

Serializable

public interface DynamicVariable
extends Serializable

Version:

$Id: $

Author:

Dennis Reil,

Method Summary

Modifier and Type	Method and Description
void	addFilter(ValueFilter filter)
String	evaluate(VariableSubstitutor... substitutors)
String	getConditionid()
List<ValueFilter>	getFilters()
String	getName()
Value	getValue()
Set<String>	getVarRefs(RulesEngine rulesEngine) This element will be called when the order of variable resolutions is determined.
boolean	isAutoUnset() Check whether this dynamic variable should be automatically unset if its condition is not met.
boolean	isChecked()
boolean	isCheckonce()
void	setAutoUnset(boolean autounset) Configure whether this dynamic variable should be automatically unset if its condition is not met.
void	setChecked()
void	setCheckonce(boolean checkonce)
void	setConditionid(String conditionid)
void	setIgnoreFailure(boolean ignore)
void	setName(String name)
void	setValue(Value value)
void	validate()

Method Detail

getName

String getName()

Returns:

the name

setName

void setName(String name)

Parameters:

name - the name to set

getValue

Value getValue()

Returns:

the value

setValue

void setValue(Value value)

Parameters:

value - the value to set

getConditionid

String getConditionid()

Returns:

the conditionid

setConditionid

void setConditionid(String conditionid)

Parameters:

conditionid - the conditionid to set

validate

void validate()
       throws Exception

Throws:

Exception

evaluate

String evaluate(VariableSubstitutor... substitutors)
         throws Exception

Throws:

Exception

isCheckonce

boolean isCheckonce()

setCheckonce

void setCheckonce(boolean checkonce)

isChecked

boolean isChecked()

setChecked

void setChecked()

isAutoUnset

boolean isAutoUnset()

Check whether this dynamic variable should be automatically unset if its condition is not met.

Returns:

true if the variable is to be automatically unset

setAutoUnset

void setAutoUnset(boolean autounset)

Configure whether this dynamic variable should be automatically unset if its condition is not met.

Parameters:

autounset - true if the variable is to be automatically unset

setIgnoreFailure

void setIgnoreFailure(boolean ignore)

addFilter

void addFilter(ValueFilter filter)

getFilters

List<ValueFilter> getFilters()

getVarRefs

Set<String> getVarRefs(RulesEngine rulesEngine)

This element will be called when the order of variable resolutions is determined.

Returns:

the names of all variables referenced by this variable