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