com.pcbsys.nirvana.nAdminAPI.nConfigGroup Class Reference

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

Inherits com.pcbsys.nirvana.client.Observable.

Public Member Functions
bool	Equals (long aLong)
	Compares this object with the passed object. More...
override bool	Equals (object item)
	Compares this object with the passed object. More...
virtual nConfigEntry	find (string itemName)
	Finds a nConfigEntry that matches the name specified from within this group More...
virtual System.Collections.IEnumerator	getItems ()
	Returns the group as an IEnumerator of all the nConfigEntry objects that the group consists of More...
virtual bool	isReadOnly ()
	Returns whether this config group is read only More...
virtual int	Length ()
	Returns the length of the configureation group, ie the number of items More...
virtual bool	lessThan (long aLong)
	Compares this object with the passed object. More...
virtual bool	lessThan (object item)
	Compares this object with the passed object. More...

Properties
virtual string	Description [get]
	Retrieves the description of this group More...
virtual string	Name [get]
	Retrieve this groups unique name More...

Detailed Description

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

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

Member Function Documentation

bool com.pcbsys.nirvana.nAdminAPI.nConfigGroup.Equals

(

long

aLong

)

Compares this object with the passed object.

For internal use only

Parameters

aLong

long to compare against

Returns

True if this object is equal to the passed long

override bool com.pcbsys.nirvana.nAdminAPI.nConfigGroup.Equals

(

object

item

)

Compares this object with the passed object.

For internal use only

Parameters

item	Object to compare against

Returns

True if this object is equal to the passed object

virtual nConfigEntry com.pcbsys.nirvana.nAdminAPI.nConfigGroup.find ( string  itemName )

virtual

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

nConfigEntry

Parameters

itemName

Name 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

nAdminIllegalArgumentException

is thrown if itemName is null

virtual System.Collections.IEnumerator com.pcbsys.nirvana.nAdminAPI.nConfigGroup.getItems ( )

virtual

Returns the group as an IEnumerator of all the nConfigEntry objects that the group consists of

Returns

An IEnumerator of all the nConfigEntry objects that the group consists of

virtual bool com.pcbsys.nirvana.nAdminAPI.nConfigGroup.isReadOnly ( )

virtual

Returns whether this config group is read only

Returns

boolean value representing if it's read only

virtual int com.pcbsys.nirvana.nAdminAPI.nConfigGroup.Length ( )

virtual

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

Returns

The number of config entries in this group

virtual bool com.pcbsys.nirvana.nAdminAPI.nConfigGroup.lessThan ( long  aLong )

virtual

Compares this object with the passed object.

For internal use only

Parameters

aLong

long to compare against

Returns

True if this object is less than the passed long

virtual bool com.pcbsys.nirvana.nAdminAPI.nConfigGroup.lessThan ( object  item )

virtual

Compares this object with the passed object.

For internal use only

Parameters

item	Object to compare against

Returns

True if this object is less than the passed object

Property Documentation

virtual string com.pcbsys.nirvana.nAdminAPI.nConfigGroup.Description

get

Retrieves the description of this group

Returns

the description of this config group as a String

virtual string com.pcbsys.nirvana.nAdminAPI.nConfigGroup.Name

get

Retrieve this groups unique name

Returns

String name