org.figure8.join.businessobjects.environment
Class ParameterValue

java.lang.Object
  org.figure8.join.core.EntityObject
      org.figure8.join.businessobjects.environment.ParameterValue

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ParameterValue
extends EntityObject

This entity represents a wrapper around available value for a deployment parameter (Parameter). Such a value is defined for a specific physical environment and for specific deployment target.

Version:

$Revision: 1.2 $

Author:

Jerome Evrard

See Also:

Target, Serialized Form

Field Summary

static java.lang.String	CURRENT Constant representing a currently available value
static java.lang.String	DELETED Constant representing a deleted value
static java.lang.String	HISTORICAL Constant representing an historical value

Constructor Summary

ParameterValue()
Creates a new instance of ParameterValue.

ParameterValue(java.lang.String value, Parameter parameter, Target target, PhysicalEnvironment environment)
Creates a new instance of ParameterValue with mandatory attributes.

Method Summary

void	delete() Delete this parameter value.
void	deprecate() Deprecate this parameter value.
java.util.Date	getDeprecationDate()
PhysicalEnvironment	getEnvironment() Get the environment to whom this value applies.
Parameter	getParameter() Get the parameter of the value.
java.lang.String	getStatus()
Target	getTarget() Get the target of the value
java.lang.String	getValue() Get the parameter value
void	setDeprecationDate(java.util.Date deprecation)
void	setEnvironment(PhysicalEnvironment environment)
void	setParameter(Parameter parameter)
void	setStatus(java.lang.String status)
void	setTarget(Target target)
void	setValue(java.lang.String value)
java.lang.String	toString()

Methods inherited from class org.figure8.join.core.EntityObject

clone, equals, getId, hashCode, isTransient

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CURRENT

public static final java.lang.String CURRENT

Constant representing a currently available value

See Also:

Constant Field Values

HISTORICAL

public static final java.lang.String HISTORICAL

Constant representing an historical value

See Also:

Constant Field Values

DELETED

public static final java.lang.String DELETED

Constant representing a deleted value

See Also:

Constant Field Values

Constructor Detail

ParameterValue

public ParameterValue()

Creates a new instance of ParameterValue.

ParameterValue

public ParameterValue(java.lang.String value,
                      Parameter parameter,
                      Target target,
                      PhysicalEnvironment environment)

Creates a new instance of ParameterValue with mandatory attributes.

Parameters:

value - The value to set.

parameter - The parameter instance corresponding to this value

target - The target this parameter value is available for.

environment - The environment this parameter value is available for.

Method Detail

getValue

public java.lang.String getValue()

Get the parameter value

Returns:

The parameter value

setValue

public void setValue(java.lang.String value)

Parameters:

value - The parameter value wrapped

getStatus

public java.lang.String getStatus()

Returns:

The status of this value wrapper (one of CURRENT, HISTORICAL or DELETED)

setStatus

public void setStatus(java.lang.String status)

Parameters:

status - The status of this value wrapper (one of CURRENT, HISTORICAL or DELETED)

getDeprecationDate

public java.util.Date getDeprecationDate()

Returns:

The date this value has been deprecated

setDeprecationDate

public void setDeprecationDate(java.util.Date deprecation)

Parameters:

deprecation - The date this value has been deprecated

delete

public void delete()

Delete this parameter value. Set the status to deleted and set the deprecation date to the current date.

deprecate

public void deprecate()

Deprecate this parameter value. Set the status to historical and set the deprecation date to the current date.

getParameter

public Parameter getParameter()

Get the parameter of the value.

Returns:

The parameter value

setParameter

public void setParameter(Parameter parameter)

Parameters:

parameter - The parameter definition corresponding to this value wrapper

getEnvironment

public PhysicalEnvironment getEnvironment()

Get the environment to whom this value applies.

Returns:

The environment corresponding to parameter value

setEnvironment

public void setEnvironment(PhysicalEnvironment environment)

Parameters:

environment - The environment to whom this value applies

getTarget

public Target getTarget()

Get the target of the value

Returns:

The target corresponding to parameter value

setTarget

public void setTarget(Target target)

Parameters:

target - The target to whom this value applies

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this value