com.pcbsys.nirvana.nAdminAPI.nConfigGroup Class Reference

This class manages a group of nConfigEntry objects that are related. More...

Inherits Observable, and SortedObject.

Public Member Functions

boolean equals (long aLong)
 Compares this object with the passed object. More...
 
nConfigEntry find (String itemName) throws nAdminIllegalArgumentException
 Finds a nConfigEntry that matches the name specified from within this group. More...
 
String getDescription ()
 Retrieves the description of this group. More...
 
Enumeration getItems ()
 Returns the group as an Enumeration of all the nConfigEntry objects that the group consists of. More...
 
String getName ()
 Retrieve this groups unique name. More...
 
boolean isMatch (Object item)
 Compares this object with the passed object. More...
 
boolean isReadOnly ()
 Returns whether this config group is read only. More...
 
int Length ()
 Returns the length of the configureation group, ie the number of items. More...
 
boolean lessThan (long aLong)
 Compares this object with the passed object. More...
 
boolean lessThan (Object item)
 Compares this object with the passed object. More...
 

Detailed Description

This class manages a group of nConfigEntry objects that are related.

This class extends java.util.Observable so that if new nConfigEntry objects are added to this group the Observer will be notified with the new nConfigEntry

Member Function Documentation

boolean com.pcbsys.nirvana.nAdminAPI.nConfigGroup.equals ( long  aLong)

Compares this object with the passed object.

For internal use only

Parameters
aLonglong to compare against
Returns
True if this object is equal to the passed long
nConfigEntry com.pcbsys.nirvana.nAdminAPI.nConfigGroup.find ( String  itemName) throws nAdminIllegalArgumentException

Finds a nConfigEntry that matches the name specified from within this group.

Parameters
itemNameName of the nConfigEntry to find as a String
Returns
the nConfigEntry object found or null if the name does not exist within the group
Exceptions
nAdminIllegalArgumentExceptionis thrown if itemName is null
See Also
nConfigEntry
String com.pcbsys.nirvana.nAdminAPI.nConfigGroup.getDescription ( )

Retrieves the description of this group.

Returns
the description of this config group as a String
Enumeration com.pcbsys.nirvana.nAdminAPI.nConfigGroup.getItems ( )

Returns the group as an Enumeration of all the nConfigEntry objects that the group consists of.

Returns
An enumeration of all the nConfigEntry objects that the group consists of
See Also
java.util.Enumeration
String com.pcbsys.nirvana.nAdminAPI.nConfigGroup.getName ( )

Retrieve this groups unique name.

Returns
String name
boolean com.pcbsys.nirvana.nAdminAPI.nConfigGroup.isMatch ( Object  item)

Compares this object with the passed object.

For internal use only

Parameters
itemObject to compare against
Returns
True if this object is equal to the passed object
boolean com.pcbsys.nirvana.nAdminAPI.nConfigGroup.isReadOnly ( )

Returns whether this config group is read only.

Returns
boolean value representing if it's read only
int com.pcbsys.nirvana.nAdminAPI.nConfigGroup.Length ( )

Returns the length of the configureation group, ie the number of items.

Returns
The number of config entries in this group
boolean com.pcbsys.nirvana.nAdminAPI.nConfigGroup.lessThan ( long  aLong)

Compares this object with the passed object.

For internal use only

Parameters
aLonglong to compare against
Returns
True if this object is less than the passed long
boolean com.pcbsys.nirvana.nAdminAPI.nConfigGroup.lessThan ( Object  item)

Compares this object with the passed object.

For internal use only

Parameters
itemObject to compare against
Returns
True if this object is less than the passed object