ca.utoronto.atrc.web4all.configuration
Class ParameterState

java.lang.Object
  ca.utoronto.atrc.web4all.configuration.ParameterState

public class ParameterState

extends java.lang.Object

Stores state information about a specific third party technology parameter, or setting. States stored include whether the parameter has been set, whether the third party technolgy requires that the parameter be set, and, if required, but not set, the setting's default value.

Constructor Summary

ParameterState(java.lang.String inParamName, boolean inRequiredFlag, java.lang.Object inDefaultValue)
Initialize the state object given a parameter name, whether it is required, and its default value.

Method Summary

java.lang.Object	getDefaultValue() Get the default value of the parameter.
java.lang.String	getParamName() Retrieve the third party technology specific name of this parameter.
boolean	getRequiredFlag() Is it required that the parameter be set?
boolean	getSetState() Get the "set" state of this parameter.
boolean	isRequired() Is it required that the parameter be set?
void	setDefaultValue(java.lang.Object inDefaultValue) Set the default value of this parameter.
void	setSetState(boolean inSetState) Set the "set" state of this parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterState

public ParameterState(java.lang.String inParamName,
                      boolean inRequiredFlag,
                      java.lang.Object inDefaultValue)

Initialize the state object given a parameter name, whether it is required, and its default value. The "set" state is initialized to false.

Parameters:

inParamName - The technology specific name of the parameter. This is not a preference name from the ACCLIP, but the third party technology's corresponding name.

inRequiredFlag - Is this parameter required by the third party technology?

inDefaultValue - If it is required, this is the default value if it can't be set via the ACCLIP document.

Method Detail

getParamName

public java.lang.String getParamName()

Retrieve the third party technology specific name of this parameter.

Returns:

The parameter name.

getSetState

public boolean getSetState()

Get the "set" state of this parameter.

Returns:

Whether the parameter was set.

See Also:

setSetState(boolean)

setSetState

public void setSetState(boolean inSetState)

Set the "set" state of this parameter.

Parameters:

inSetState - true if the parameter has been set; false, otherwise.

See Also:

getSetState()

getRequiredFlag

public boolean getRequiredFlag()

Is it required that the parameter be set?

Returns:

Whether the parameter is required.

See Also:

isRequired(), setDefaultValue(Object), getDefaultValue()

isRequired

public boolean isRequired()

Is it required that the parameter be set?

Returns:

Whether the parameter is required.

See Also:

getRequiredFlag(), setDefaultValue(Object), getDefaultValue()

setDefaultValue

public void setDefaultValue(java.lang.Object inDefaultValue)

Set the default value of this parameter.

Parameters:

inDefaultValue - Object that represents the default value.

See Also:

getDefaultValue(), getRequiredFlag()

getDefaultValue

public java.lang.Object getDefaultValue()

Get the default value of the parameter.

Returns:

Object that represents the default value.

See Also:

setDefaultValue(Object), getRequiredFlag()