com.ibm.ram.extension
Class ConfigurationDetails

java.lang.Object
  extended by com.ibm.ram.extension.ConfigurationDetails
Direct Known Subclasses:
CategoryConfigurationDetails, MultiValuesConfigurationDetails, RelationshipConfigurationDetails, SelectBoxConfigurationDetails

public class ConfigurationDetails
extends java.lang.Object

The class contains information about configuration mappings for a custom review process.

Since:
7.0.1

Constructor Summary
ConfigurationDetails()
          Default Configuration Detail Constructor
ConfigurationDetails(java.lang.String key, java.lang.String label, java.lang.String description, boolean password, boolean connectionInformation)
           
ConfigurationDetails(java.lang.String key, java.lang.String label, java.lang.String description, java.lang.String defaultValue, boolean textArea)
           
ConfigurationDetails(java.lang.String key, java.lang.String label, java.lang.String description, java.lang.String defaultValue, boolean password, boolean connectionInformation)
           
 
Method Summary
 java.lang.String getDefaultValue()
          Returns the default value for the configuration.
 java.lang.String getDescription()
          Returns the description for the configuration.
 java.lang.String getKey()
          Returns the unique key for the configuration.
 java.lang.String getLabel()
          Returns the label for this configuration.
 boolean isConnectionInformation()
          Returns true if the configuration is connection information.
 boolean isPassword()
          Returns true if the configuration is a password.
 boolean isTextArea()
           
 void setConnectionInformation(boolean connectionInformation)
           
 void setDefaultValue(java.lang.String defaultValue)
           
 void setDescription(java.lang.String description)
           
 void setKey(java.lang.String key)
           
 void setLabel(java.lang.String label)
           
 void setPassword(boolean password)
           
 void setTextArea(boolean textArea)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConfigurationDetails

public ConfigurationDetails()
Default Configuration Detail Constructor

Since:
7.2

ConfigurationDetails

public ConfigurationDetails(java.lang.String key,
                            java.lang.String label,
                            java.lang.String description,
                            boolean password,
                            boolean connectionInformation)
Parameters:
key - A unique key for the configuration.
label - A label for the configuration that will be displayed to the Rational Asset Manager administrator.
description - A description for the configuration that will be displayed to the Rational Asset Manager administrator.
password - True if the configuration is a password.
connectionInformation - True if the configuration is connection information
Since:
7.0.1

ConfigurationDetails

public ConfigurationDetails(java.lang.String key,
                            java.lang.String label,
                            java.lang.String description,
                            java.lang.String defaultValue,
                            boolean password,
                            boolean connectionInformation)
Parameters:
key - A unique key for the configuration.
label - A label for the configuration that will be displayed to the Rational Asset Manager administrator.
description - A description for the configuration that will be displayed to the Rational Asset Manager administrator.
defaultValue - The default value of the configuration.
password - True if the configuration is a password.
connectionInformation - True if the configuration is connection information
Since:
7.0.1

ConfigurationDetails

public ConfigurationDetails(java.lang.String key,
                            java.lang.String label,
                            java.lang.String description,
                            java.lang.String defaultValue,
                            boolean textArea)
Parameters:
key - A unique key for the configuration.
label - A label for the configuration that will be displayed to the Rational Asset Manager administrator.
description - A description for the configuration that will be displayed to the Rational Asset Manager administrator.
defaultValue - The default value of the configuration.
textArea - True if the configuration is a textArea.
Since:
7.0.1
Method Detail

isTextArea

public boolean isTextArea()
Returns:
Returns the textArea.
Since:
7.5

setTextArea

public void setTextArea(boolean textArea)
Parameters:
textArea - The textArea to set.
Since:
7.5

getKey

public java.lang.String getKey()
Returns the unique key for the configuration.

Returns:
The key for the configuration.
Since:
7.0.1

getLabel

public java.lang.String getLabel()
Returns the label for this configuration.

Returns:
The label for the configuration.
Since:
7.0.1

getDefaultValue

public java.lang.String getDefaultValue()
Returns the default value for the configuration.

Returns:
The default value for the configuration.
Since:
7.0.1

getDescription

public java.lang.String getDescription()
Returns the description for the configuration.

Returns:
The default value for the configuration.
Since:
7.0.1

isPassword

public boolean isPassword()
Returns true if the configuration is a password.

Returns:
True if the configuration is a password.
Since:
7.0.1

isConnectionInformation

public boolean isConnectionInformation()
Returns true if the configuration is connection information. Connection information is displayed in a connection tab in Rational Asset Manager. This allows the same connection configuration can be used across multiple review processes.

Returns:
True if the configuration is connection information
Since:
7.0.1

setKey

public void setKey(java.lang.String key)
Parameters:
key - The key to set.
Since:
7.2

setLabel

public void setLabel(java.lang.String label)
Parameters:
label - The label to set.
Since:
7.2

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)
Parameters:
defaultValue - The defaultValue to set.
Since:
7.2

setDescription

public void setDescription(java.lang.String description)
Parameters:
description - The description to set.
Since:
7.2

setPassword

public void setPassword(boolean password)
Parameters:
password - The password to set.
Since:
7.2

setConnectionInformation

public void setConnectionInformation(boolean connectionInformation)
Parameters:
connectionInformation - The connectionInformation to set.
Since:
7.2