com.novell.nds.dirxml.engine.gcv
Class GCVRef

java.lang.Object
  com.novell.nds.dirxml.engine.gcv.GCValue
      com.novell.nds.dirxml.engine.gcv.GCVRef

All Implemented Interfaces:

ConfigElement

public class GCVRef

extends GCValue

Class representing a reference to a GCV from a ShimParams instance. This is implemented as a GCValue so that the reference can easily be manipulated via the GCDefinitions and GCParent classes.

Note that gcv-ref types cannot appear on base GCV definitions (i.e., in GCDefinitions).

Note that only a single reference to a give GCV can exist in a single ShimParams instance.

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_SUBORDINATES

Constructor Summary

GCVRef(String name)
Constructor for use by GCValue construct() method.

Method Summary

String	getValue() Return the current value of this instance.
void	parseValue(String value) Implement GCValue abstract.
void	setValue(String value) Implement GCValue abstract.

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

construct, construct, constructGCVRef, constructGroup, constructHeader, constructSubordinates, getDescription, getDescriptionRef, getDisplayName, getDisplayNameRef, getHidden, getName, getType, getTypeString, getXMLValue, hasBeenModified, localize, resetModified, setDescription, setDescriptionRef, setDisplayName, setDisplayNameRef, setHidden, toXML, typeFromString

Methods inherited from class java.lang.Object

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

Constructor Detail

GCVRef

public GCVRef(String name)
       throws GCVArgumentException

Constructor for use by GCValue construct() method.

Parameters:

name - name of GCV to reference

Throws:

GCVArgumentException - thrown if name is invalid

Method Detail

parseValue

public void parseValue(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 String getValue()

Return the current value of this instance.

Specified by:

getValue in class GCValue

Returns:

empty string

setValue

public void setValue(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.