com.ibm.rational.rpe.common.data
Class DomainValue

java.lang.Object
  extended by com.ibm.rational.rpe.common.data.DomainValue

public class DomainValue
extends java.lang.Object

Models the accepted domains for the various Rational Publishing Engine (RPE) properties.


Constructor Summary
DomainValue()
           
 
Method Summary
 void addDomainValue(java.lang.String value, java.lang.String label)
          Adds a new value to the collection of accepted values
 boolean getAcceptAny()
          If set, any value is accepted for the properties with this domain value.
 java.util.Collection<java.lang.String> getAcceptedValues()
          Returns the collection of accepted values
 java.lang.String getDefaultValue()
          Returns the default value to be used for properties with this domain.
 com.ibm.rational.rpe.common.data.Description getDescription()
          Returns the description of this domain value.
 java.lang.String getMax()
          Returns the maximum acceptable value for this domain.
 java.lang.String getMin()
          Returns the minimum acceptable value for this domain.
 java.lang.String getType()
          Returns the data type that is accepted for the values.
 void setAcceptAny(boolean acceptAny)
          If set, any value is accepted for the properties with this domain value.
 void setAcceptedValues(java.util.Collection<java.lang.String> acceptedValues)
          Sets the collection of accepted values
 void setDefaultValue(java.lang.String defaultValue)
          Sets the default value to be used for properties with this domain.
 void setDescription(com.ibm.rational.rpe.common.data.Description description)
          Sets the description of this domain value.
 void setMax(java.lang.String max)
          Sets the maximum acceptable value for this domain.
 void setMin(java.lang.String min)
          Sets the minimum acceptable value for this domain.
 void setType(java.lang.String type)
          Sets the data type that is accepted for the values.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DomainValue

public DomainValue()
Method Detail

getDescription

public com.ibm.rational.rpe.common.data.Description getDescription()
Returns the description of this domain value.

Returns:

setDescription

public void setDescription(com.ibm.rational.rpe.common.data.Description description)
Sets the description of this domain value. The description is used purely for display purposes and has no impact on the domain value or on how it is used.

Parameters:
description -

getType

public java.lang.String getType()
Returns the data type that is accepted for the values. Example of possible values: boolean, numeric. Other values can be added as needed or as supported by the user interface. It is up to the user interface to use and enforce the correctness of the values that are introduced.

Returns:

setType

public void setType(java.lang.String type)
Sets the data type that is accepted for the values. Example of possible values: boolean, numeric. Other values can be added as needed or as supported by the user interface. It is up to the user interface to use and enforce the correctness of the values that are introduced.


getAcceptAny

public boolean getAcceptAny()
If set, any value is accepted for the properties with this domain value.

Returns:

setAcceptAny

public void setAcceptAny(boolean acceptAny)
If set, any value is accepted for the properties with this domain value.


getAcceptedValues

public java.util.Collection<java.lang.String> getAcceptedValues()
Returns the collection of accepted values

Returns:

setAcceptedValues

public void setAcceptedValues(java.util.Collection<java.lang.String> acceptedValues)
Sets the collection of accepted values


addDomainValue

public void addDomainValue(java.lang.String value,
                           java.lang.String label)
Adds a new value to the collection of accepted values

Parameters:
value -
label -

getMin

public java.lang.String getMin()
Returns the minimum acceptable value for this domain. This value can be null.

Returns:

setMin

public void setMin(java.lang.String min)
Sets the minimum acceptable value for this domain.


getMax

public java.lang.String getMax()
Returns the maximum acceptable value for this domain. This value can be null.


setMax

public void setMax(java.lang.String max)
Sets the maximum acceptable value for this domain. This value can be null.


getDefaultValue

public java.lang.String getDefaultValue()
Returns the default value to be used for properties with this domain. This value can be null.


setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)
Sets the default value to be used for properties with this domain. This domain can be null.