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

java.lang.Object
  com.novell.nds.dirxml.engine.gcv.GCValue
      com.novell.nds.dirxml.engine.gcv.GCParent
          com.novell.nds.dirxml.engine.gcv.GCGroup

All Implemented Interfaces:

ConfigElement

public class GCGroup

extends GCParent

Class representing a GCV group.

A GCV group is a collection of related GCVs. The first definition in the group is the "group leader". The UI displays the other members of the group as subordinate to the group leader. The other members of the group may be definitions or they may be "subordinate sections". Subordinate sections may be conditionally displayed by the UI based on the value of the group leader.

Group leaders may be of type boolean or of type enum.

Although a GCV group is not an actual GCV, the objects are represented programmatically as GCValues for ease of manipulation via the GCDefinitions class.

See Also:

GCSubordinates

Field Summary

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

defsList, defsMap, owner

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

protected	GCGroup(Element definition, GCDefinitions owner) Constructor for use by GCValue.construct() method.
protected	GCGroup(GCDefinitions owner) Constructor for use by GCValue construct() method.

Method Summary

GCValue

getLeader() Return the "group leader" value.

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

appendValue, getOwner, getValue, insertValue, insertValue, iterator, parseValue, removeValue, removeValue, setValue, shallowIterator

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

GCGroup

protected GCGroup(GCDefinitions owner)
           throws GCVArgumentException

Constructor for use by GCValue construct() method.

Parameters:

owner - GCDefinitions instance that owns this group.

Throws:

GCVArgumentException - thrown if name is invalid

GCGroup

protected GCGroup(Element definition,
                  GCDefinitions owner)
           throws GCVException

Constructor for use by GCValue.construct() method.

Parameters:

definition - <group> element defining data.

owner - GCDefinitions instance that owns the group

Throws:

GCVException - thrown if XML is not complete or correct.

Method Detail

getLeader

public GCValue getLeader()

Return the "group leader" value.

Returns:

GCValue that is the group leader or null.