com.pcbsys.nirvana.nAdminAPI.nScheduler Class Reference

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

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

com.pcbsys.nirvana.nAdminAPI.nNode com.pcbsys.nirvana.nAdminAPI.nRemovable

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.
String getSource ()
 Returns the actual source text for the scheduler.
String getSubject ()
 Returns the subject which this scheduler should run within.
Vector getTriggers ()
 Returns a Vector of known nTrigger objects for this source.
boolean isClusterWide ()
 Boolean indicating if this scheduler should be run within all nodes of the cluster.
void remove (boolean removeChildren) throws nUnsupportedRemoveException, nNodeException
 Removes this scheduler entry from the Realm.

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.

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.
nNodeException 

Implements com.pcbsys.nirvana.nAdminAPI.nRemovable.