com.novell.nds.dirxml.engine.gcv

Class GCHeader

java.lang.Object

com.novell.nds.dirxml.engine.gcv.GCValue

com.novell.nds.dirxml.engine.gcv.GCHeader

All Implemented Interfaces:

ConfigElement

public class GCHeader
extends GCValue

Class representing a header element in a Global Configuration Value definition.

A header is a UI construct; the UI may display definitions following the header as subordinate to the header.

Although headers are not actual GCVs, the header is represented programmatically as a GCValue for ease of manipulation via the GCDefinitions class.

Nested Class Summary

Nested classes/interfaces inherited from class com.novell.nds.dirxml.engine.gcv.GCValue

GCValue.IllegalCloneStateException, GCValue.XmlComment, GCValue.XmlItem, GCValue.XmlProcessingInstruction

Field Summary

Fields inherited from class com.novell.nds.dirxml.engine.gcv.GCValue

modified, parent, TYPE_BOOLEAN, TYPE_DN, TYPE_DN_REF, TYPE_ENUM, TYPE_GCV_REF, TYPE_GROUP, TYPE_HEADER, TYPE_INTEGER, TYPE_LIST, TYPE_PASSWORD_REF, TYPE_REAL, TYPE_STRING, TYPE_STRUCTURED, TYPE_SUBORDINATES, xmlItems

Constructor Summary

Constructors

Constructor and Description
GCHeader() Constructor for use by GCValue construct() method.

Method Summary

Modifier and Type	Method and Description
GCValue	cloneValue(java.lang.String name) Clone this GCValue instance and return the cloned instance.
java.lang.String	getValue() Return the current value of this instance.
void	parseValue(java.lang.String value) Implement GCValue abstract.
void	setValue(java.lang.String value) Implement GCValue abstract.

Methods inherited from class com.novell.nds.dirxml.engine.gcv.GCValue

addXmlComment, addXmlItems, addXmlProcessingInstruction, cloneCommon, construct, construct, constructGCVRef, constructGCVRef, constructGroup, constructHeader, constructStructuredValue, constructSubordinates, getDescription, getDescriptionRef, getDisplayName, getDisplayNameRef, getHidden, getMandatory, getName, getOwner, getParent, getType, getTypeString, getXmlItemsIterator, getXMLValue, hasBeenModified, localize, resetModified, setDescription, setDescriptionRef, setDisplayName, setDisplayNameRef, setHidden, setMandatory, toXML, typeFromString

Methods inherited from class java.lang.Object

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

Constructor Detail

GCHeader

public GCHeader()
         throws GCVArgumentException

Constructor for use by GCValue construct() method.

Throws:

GCVArgumentException - thrown if name is invalid

Method Detail

cloneValue

public GCValue cloneValue(java.lang.String name)

Clone this GCValue instance and return the cloned instance.

Specified by:

cloneValue in class GCValue

Parameters:

the - name for the cloned value (ignored).

Returns:

the cloned instance

parseValue

public void parseValue(java.lang.String value)
                throws GCVException

Implement GCValue abstract. This method does nothing.

Specified by:

parseValue in class GCValue

Parameters:

value - ignored

Throws:

none

GCVException - thrown if value is not correct for this value instance.

getValue

public java.lang.String getValue()

Return the current value of this instance.

Specified by:

getValue in class GCValue

Returns:

empty string

setValue

public void setValue(java.lang.String value)
              throws GCVException

Implement GCValue abstract. This method does nothing.

Specified by:

setValue in class GCValue

Parameters:

value - ignored

Throws:

none

GCVException - thrown if value is not correct for this value instance.