This class represents a parsed instance of a Nirvana Realm scheduler. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nScheduler:

Public Member Functions
Vector	getInitialTasks ()
	Returns a Vector of nTasks to be performed when the Realm startup or the script is sent to the Realm Server. More...

String	getSource ()
	Returns the actual source text for the scheduler. More...

String	getSubject ()
	Returns the subject which this scheduler should run within. More...

Vector	getTriggers ()
	Returns a Vector of known nTrigger objects for this source. More...

boolean	isClusterWide ()
	Boolean indicating if this scheduler should be run within all nodes of the cluster. More...

boolean	isMatch (Object o)
	Returns true if the parameter passed in is either a string which matches this scheduler's name, or a scheduler with the same name. More...

void	remove (boolean removeChildren) throws nUnsupportedRemoveException, nNodeException
	Removes this scheduler entry from the Realm. More...

Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nNode
boolean	equals (long aLong)
	Needed as part of the SortedObject interface.

synchronized String	getAbsolutePath ()
	This function walks the tree to the root to generate a fully qualified name for this node. More...

String	getName ()
	Returns the generic name of this node within the namespace. More...

nNode	getParent ()
	Returns this nodes parent node. More...

String	getRelativePath (nNode top) throws nAdminIllegalArgumentException
	This method returns the relative path from this node to the nNode passed. More...

boolean	isMatch (Object item)
	Compares this object with the passed object. More...

boolean	lessThan (long aLong)
	Needed as part of the SortedObject interface.

boolean	lessThan (Object item)
	Compares this object with the passed object. More...

Detailed Description

This class represents a parsed instance of a Nirvana Realm scheduler.

Member Function Documentation

Vector com.pcbsys.nirvana.nAdminAPI.nScheduler.getInitialTasks ( )

Returns a Vector of nTasks to be performed when the Realm startup or the script is sent to the Realm Server.

Returns: Vector of nTasks.

String com.pcbsys.nirvana.nAdminAPI.nScheduler.getSource ( )

Returns the actual source text for the scheduler.

Returns: source text.

String com.pcbsys.nirvana.nAdminAPI.nScheduler.getSubject ( )

Returns the subject which this scheduler should run within.

Returns: subject.

Vector com.pcbsys.nirvana.nAdminAPI.nScheduler.getTriggers ( )

Returns a Vector of known nTrigger objects for this source.

Returns: Vector of nTrigger.

boolean com.pcbsys.nirvana.nAdminAPI.nScheduler.isClusterWide ( )

Boolean indicating if this scheduler should be run within all nodes of the cluster.

If no cluster is defined then this is ignored.

Returns: cluster flag.

boolean com.pcbsys.nirvana.nAdminAPI.nScheduler.isMatch ( Object o )

Returns true if the parameter passed in is either a string which matches this scheduler's name, or a scheduler with the same name.

Parameters

o	the object to compare this scheduler to.

Returns: a boolean indicating if the parameter passed in is either a string which matches this scheduler's name, or a scheduler with the same name..

void com.pcbsys.nirvana.nAdminAPI.nScheduler.remove ( boolean removeChildren ) throws nUnsupportedRemoveException, nNodeException

Removes this scheduler entry from the Realm.

Parameters

removeChildren Not used in this implementation.

Exceptions

nUnsupportedRemoveException if a problem removing this node.

Implements com.pcbsys.nirvana.nAdminAPI.nRemovable.

Public Member Functions

Detailed Description

Member Function Documentation