com.pcbsys.nirvana.nAdminAPI.nTrigger Class Reference

This class is used to query a trigger generated by a Scheduler script. More...


Public Member Functions

String getCondition ()
 Returns the condition which the trigger will occur.
String getDay ()
 The day on which to run the trigger.
Vector getElseTasks ()
 Returns a Vector of nTask objects which will fire when the trigger is inverted.
String getHour ()
 The hour on which to run the trigger.
String getMinutes ()
 The minute on which to run the trigger.
String getMonth ()
 The month on which to run the trigger.
String getName ()
 Returns the name of the trigger.
String[] getParameters ()
 Returns a String[] of parameters to be bassed to the trigger.
Vector getTasks ()
 Returns a Vector of nTask objects which will be run when the trigger is fired.
int getType ()
 The type of trigger that this represents.
boolean isCalendar ()
 Indicates if this trigger is calendar based or event based.
boolean onFriday ()
 Returns true if it will trigger on a Friday.
boolean onMonday ()
 Returns true if it will trigger on a Monday.
boolean onSaturday ()
 Returns true if it will trigger on a Saturday.
boolean onSunday ()
 Returns true if it will trigger on a Sunday.
boolean onThursday ()
 Returns true if it will trigger on a Thursday.
boolean onTuesday ()
 Returns true if it will trigger on a Tuesday.
boolean onWednesday ()
 Returns true if it will trigger on a Wednesday.

Static Public Attributes

static final int DAILY = 1
 Will trigger on a daily basis.
static final int HOURLY = 0
 Will trigger on an hourly basis.
static final int MONTHLY = 3
 Will trigger on a monthly basis.
static final int NON_CALENDAR = -1
 Represents an event based trigger.
static final int WEEKLY = 2
 Will trigger on a weekly basis.
static final int YEARLY = 4
 Will trigger on a yearly basis.

Detailed Description

This class is used to query a trigger generated by a Scheduler script.

It contains information relating to one trigger within a scheduler script, which could be a calender based trigger, of a condition based trigger.

Member Function Documentation

String com.pcbsys.nirvana.nAdminAPI.nTrigger.getCondition (  ) 

Returns the condition which the trigger will occur.

Returns:
String value.

String com.pcbsys.nirvana.nAdminAPI.nTrigger.getDay (  ) 

The day on which to run the trigger.

If calender based.

Returns:
String representing the day.

Vector com.pcbsys.nirvana.nAdminAPI.nTrigger.getElseTasks (  ) 

Returns a Vector of nTask objects which will fire when the trigger is inverted.

Returns:
Vector of nTask.

String com.pcbsys.nirvana.nAdminAPI.nTrigger.getHour (  ) 

The hour on which to run the trigger.

If calender based.

Returns:
String representing the hour.

String com.pcbsys.nirvana.nAdminAPI.nTrigger.getMinutes (  ) 

The minute on which to run the trigger.

If calender based.

Returns:
String representing the minute.

String com.pcbsys.nirvana.nAdminAPI.nTrigger.getMonth (  ) 

The month on which to run the trigger.

If calender based.

Returns:
String representing the month.

String com.pcbsys.nirvana.nAdminAPI.nTrigger.getName (  ) 

Returns the name of the trigger.

Returns:
String name of the trigger.

String [] com.pcbsys.nirvana.nAdminAPI.nTrigger.getParameters (  ) 

Returns a String[] of parameters to be bassed to the trigger.

Returns:
String[] of parameters.

Vector com.pcbsys.nirvana.nAdminAPI.nTrigger.getTasks (  ) 

Returns a Vector of nTask objects which will be run when the trigger is fired.

Returns:
Vector of nTask.

int com.pcbsys.nirvana.nAdminAPI.nTrigger.getType (  ) 

The type of trigger that this represents.

Returns:
int value representing the type.

boolean com.pcbsys.nirvana.nAdminAPI.nTrigger.isCalendar (  ) 

Indicates if this trigger is calendar based or event based.

Returns:
true if calendar based.

boolean com.pcbsys.nirvana.nAdminAPI.nTrigger.onFriday (  ) 

Returns true if it will trigger on a Friday.

Returns:
true of Friday is set.

boolean com.pcbsys.nirvana.nAdminAPI.nTrigger.onMonday (  ) 

Returns true if it will trigger on a Monday.

Returns:
true of Monday is set.

boolean com.pcbsys.nirvana.nAdminAPI.nTrigger.onSaturday (  ) 

Returns true if it will trigger on a Saturday.

Returns:
true of Saturday is set.

boolean com.pcbsys.nirvana.nAdminAPI.nTrigger.onSunday (  ) 

Returns true if it will trigger on a Sunday.

Returns:
true of Sunday is set.

boolean com.pcbsys.nirvana.nAdminAPI.nTrigger.onThursday (  ) 

Returns true if it will trigger on a Thursday.

Returns:
true of Thursday is set.

boolean com.pcbsys.nirvana.nAdminAPI.nTrigger.onTuesday (  ) 

Returns true if it will trigger on a Tuesday.

Returns:
true of Tuesday is set.

boolean com.pcbsys.nirvana.nAdminAPI.nTrigger.onWednesday (  ) 

Returns true if it will trigger on a Wednesday.

Returns:
true of Wednesday is set.