|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--ciagent.CIAgent | +--pamanager.SchedulerAgent
The SchedulerAgent
class fires events on specified
intervals or at a single specified date and time.
Field Summary | |
protected java.lang.String |
actionString
|
protected int |
interval
|
protected boolean |
oneShot
|
protected java.util.Date |
time
|
Fields inherited from class ciagent.CIAgent |
agentPlatform,
children,
DEFAULT_ASYNCTIME,
DEFAULT_SLEEPTIME,
name,
parent,
traceLevel |
Constructor Summary | |
SchedulerAgent()
Creates a SchedulerAgent object. |
|
SchedulerAgent(java.lang.String name)
Creates a SchedulerAgent object with the given name. |
Method Summary | |
java.lang.String |
getActionString()
Retrieves the actionString this agent sends in events. |
int |
getInterval()
Retrieves the interval time, in seconds. |
boolean |
getOneShot()
Retrieves the one-shot flag. |
java.lang.String |
getTaskDescription()
Retrieves a string for display that contains information about this agent. |
java.util.Date |
getTime()
Retrieves the time setting for the one-shot timer. |
void |
initialize()
Initializes this agent by setting the timers. |
void |
process()
Does nothing because this agent only processes timer pops. |
void |
processCIAgentEvent(CIAgentEvent e)
Does nothing because this agent only processes timer pops. |
void |
processTimerPop()
Processes the timer pop by sending an event to the event listeners for this agent. |
void |
setActionString(java.lang.String actionString)
Sets the action string to be sent by this agent in an EVENT. |
void |
setInterval(int secs)
Sets the interval time to the given number of seconds. |
void |
setOneShot(boolean flag)
Sets the one-shot flag. |
void |
setTime(java.util.Date date)
Sets the time for the one-shot timer. |
Methods inherited from class java.lang.Object |
|
Field Detail |
protected int interval
protected boolean oneShot
protected java.util.Date time
protected java.lang.String actionString
Constructor Detail |
public SchedulerAgent()
SchedulerAgent
object.public SchedulerAgent(java.lang.String name)
SchedulerAgent
object with the given name.name
- the String objectMethod Detail |
public java.lang.String getTaskDescription()
public void setInterval(int secs)
secs
- the integer that represents the number of seconds for
the intervalpublic int getInterval()
public void setOneShot(boolean flag)
flag
- the boolean that indicates whether this is a one-shot
scheduler or notpublic boolean getOneShot()
true
) or not (false
)public void setTime(java.util.Date date)
date
- the Date object that contains the time when the one-shot
timer should poppublic java.util.Date getTime()
public void setActionString(java.lang.String actionString)
actionString
- the integer that represents the actionpublic java.lang.String getActionString()
public void initialize()
public void process()
public void processTimerPop()
public void processCIAgentEvent(CIAgentEvent e)
e
- the CIAgentEvent object to be processed
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |