org.lsst.ccs.bus.data

Class ConfigurationParameterInfo

java.lang.Object

org.lsst.ccs.bus.data.ConfigurationParameterInfo

All Implemented Interfaces:

Serializable

public class ConfigurationParameterInfo
extends Object
implements Serializable

Represents the state of a given parameter.

Author:

The LSST CCS Team

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigurationParameterInfo.ConfigurationParameterizedType

Constructor Summary

Constructors

Constructor and Description
ConfigurationParameterInfo()

Method Summary

Modifier and Type	Method and Description
Type	getActualType() Return the actual Type of the parameter
String	getCategoryName() The category the parameter belongs to.
String	getComponentName() Returns the name of the component the parameter represented by this object belongs to.
String	getConfiguredValue() The configured value for this parameter, i.e the value defined by the last configuration loading.
Object	getConfiguredValueObject() Return the configured Object value of this parameter
String	getCurrentValue() The current value for this parameter.
Object	getCurrentValueObject() Return the current Object value of this parameter
String	getDescription() Deprecated.
String	getParameterName() Returns the name of the parameter represented by this object.
String	getPathName() The Path name of the parameter.
String	getType() Deprecated.
String	getUnits() Deprecated.
boolean	isDirty() Boolean indicating if this parameter has been changed to a value and has not been saved yet.
boolean	isFinal()
boolean	isReadOnly()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationParameterInfo

public ConfigurationParameterInfo()

Method Detail

getPathName

public String getPathName()

The Path name of the parameter. e.g : "moduleName/parameterName"

Returns:

a String representation of the path name

getComponentName

public String getComponentName()

Returns the name of the component the parameter represented by this object belongs to.

Returns:

the component name

getParameterName

public String getParameterName()

Returns the name of the parameter represented by this object.

Returns:

the parameter name

getCategoryName

public String getCategoryName()

The category the parameter belongs to.

Returns:

the category the parameter represented by this object belongs to

getConfiguredValue

public String getConfiguredValue()

The configured value for this parameter, i.e the value defined by the last configuration loading.

Returns:

a String representation of the configured value.

getCurrentValue

public String getCurrentValue()

The current value for this parameter.

Returns:

a String representation of the current value assigned to the parameter

isDirty

public boolean isDirty()

Boolean indicating if this parameter has been changed to a value and has not been saved yet.

Returns:

True if the current value does not match the configured value.

getDescription

@Deprecated
public String getDescription()

Deprecated.

Returns:

The parameter's short description.

getUnits

@Deprecated
public String getUnits()

Deprecated.

Returns:

The parameter's units

getType

@Deprecated
public String getType()

Deprecated.

Return the type of the parameter.

Returns:

getActualType

public Type getActualType()

Return the actual Type of the parameter

Returns:

getCurrentValueObject

public Object getCurrentValueObject()

Return the current Object value of this parameter

Returns:

getConfiguredValueObject

public Object getConfiguredValueObject()

Return the configured Object value of this parameter

Returns:

isFinal

public boolean isFinal()

isReadOnly

public boolean isReadOnly()

toString

public String toString()

Overrides:

toString in class Object