org.rhq.core.clientapi.descriptor.configuration

Class ConfigurationProperty

java.lang.Object

org.rhq.core.clientapi.descriptor.configuration.ConfigurationProperty

Direct Known Subclasses:

DynamicProperty, ListProperty, MapProperty, SimpleProperty

public class ConfigurationProperty
extends Object

Base class for all configuration properties.

Java class for configurationProperty complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="configurationProperty">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" minOccurs="0">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}string">
               <whiteSpace value="collapse"/>
               <minLength value="1"/>
               <maxLength value="4000"/>
             </restriction>
           </simpleType>
         </element>
       </sequence>
       <attribute name="description">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <whiteSpace value="collapse"/>
             <minLength value="1"/>
             <maxLength value="1000"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="displayName">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <whiteSpace value="collapse"/>
             <minLength value="1"/>
             <maxLength value="100"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="name" use="required">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <whiteSpace value="collapse"/>
             <minLength value="1"/>
             <maxLength value="255"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="readOnly" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="required" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="summary" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected String	displayName
protected String	longDescription
protected String	name
protected Boolean	readOnly
protected Boolean	required
protected Boolean	summary

Constructor Summary

Constructors

Constructor and Description
ConfigurationProperty()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Gets the value of the description property.
String	getDisplayName() Gets the value of the displayName property.
String	getLongDescription() Gets the value of the longDescription property.
String	getName() Gets the value of the name property.
boolean	isReadOnly() Gets the value of the readOnly property.
boolean	isRequired() Gets the value of the required property.
boolean	isSummary() Gets the value of the summary property.
void	setDescription(String value) Sets the value of the description property.
void	setDisplayName(String value) Sets the value of the displayName property.
void	setLongDescription(String value) Sets the value of the longDescription property.
void	setName(String value) Sets the value of the name property.
void	setReadOnly(Boolean value) Sets the value of the readOnly property.
void	setRequired(Boolean value) Sets the value of the required property.
void	setSummary(Boolean value) Sets the value of the summary property.

Methods inherited from class java.lang.Object

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

Field Detail

longDescription

protected String longDescription

description

protected String description

displayName

protected String displayName

name

protected String name

readOnly

protected Boolean readOnly

required

protected Boolean required

summary

protected Boolean summary

Constructor Detail

ConfigurationProperty

public ConfigurationProperty()

Method Detail

getLongDescription

public String getLongDescription()

Gets the value of the longDescription property.

Returns:

possible object is String

setLongDescription

public void setLongDescription(String value)

Sets the value of the longDescription property.

Parameters:

value - allowed object is String

getDescription

public String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

public void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

getDisplayName

public String getDisplayName()

Gets the value of the displayName property.

Returns:

possible object is String

setDisplayName

public void setDisplayName(String value)

Sets the value of the displayName property.

Parameters:

value - allowed object is String

getName

public String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

isReadOnly

public boolean isReadOnly()

Gets the value of the readOnly property.

Returns:

possible object is Boolean

setReadOnly

public void setReadOnly(Boolean value)

Sets the value of the readOnly property.

Parameters:

value - allowed object is Boolean

isRequired

public boolean isRequired()

Gets the value of the required property.

Returns:

possible object is Boolean

setRequired

public void setRequired(Boolean value)

Sets the value of the required property.

Parameters:

value - allowed object is Boolean

isSummary

public boolean isSummary()

Gets the value of the summary property.

Returns:

possible object is Boolean

setSummary

public void setSummary(Boolean value)

Sets the value of the summary property.

Parameters:

value - allowed object is Boolean