Package AccessEngine :: Package AEEvent :: Module TimerAlert :: Class TimerAlert

Class TimerAlert

  object --+    
           |    
Base.AEEvent --+
               |
              TimerAlert

Event that fires when a registered timer triggers a notification.

This class registers its name and whether it should be monitored by default in an AEMonitor using the Base.registerEventType function when this module is first imported. The AEMonitor can use this information to build its menus.

Instance Methods

[hide private]

__init__(self, aid, task_key, interval, **kwargs)
Stores important references.

source code

string

__str__(self)
Returns a human readable representation of this event including its name and interval.

source code

boolean

execute(self)
Contacts the AETierManager and asks it to manage this chooser event.

source code

opaque object

getAppID(self)
Returns: Unique application ID identifying the top most container for the source of this event (i.e.

source code

tuple of ('task name', 'script name')

getTaskKey(self)
Gets the key of the task that should handle the timer event.

source code

dictionary

getDataForTask(self)
Fetches data out of this TimerAlert.

source code

Inherited from Base.AEEvent: getLayer, getPOR, getPriority, getTimestamp, setLayer, setPriority

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__

Instance Variables

[hide private]

opaque aid
Unique identifier for the application AETier with which the timer that fired this event is associated

integer interval
Interval on which the timer is triggered

tuple of ('task name', 'script name') task_key
Key to the task that will handle the timer event

Inherited from Base.AEEvent: layer, por, priority

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, aid, task_key, interval, **kwargs)
(Constructor)

source code

Stores important references.

Parameters:

aid (opaque) - Unique identifier for the application AETier with which the timer that fired this event is associated
task_key (tuple of ('task name', 'script name')) - Key to the task that will handle the timer event
interval (integer) - Interval on which the timer is triggered

Overrides: Base.AEEvent.__init__

str(self)
(Informal representation operator)

source code

Returns a human readable representation of this event including its name and interval.

Returns: string: Information about this event
Overrides: Base.AEEvent.__str__

execute(self)

source code

Contacts the AETierManager and asks it to manage this chooser event.

Returns: boolean: True to indicate the event executed properly
Overrides: Base.AEEvent.execute

getAppID(self)

source code

Returns: opaque object: Unique application ID identifying the top most container for the source of this event (i.e. the application)
Overrides: Base.AEEvent.getAppID

getTaskKey(self)

source code

Gets the key of the task that should handle the timer event. This information is used to locate the task that should handle this event.

Returns: tuple of ('task name', 'script name'): key of the task that will handle the event

getDataForTask(self)

source code

Fetches data out of this TimerAlert.

Returns: dictionary

Dictionary of parameters to be passed to a task function as follows:

interval: The interval on which the timer fires

Overrides: Base.AEEvent.getDataForTask

Class TimerAlert

__init__(self, aid, task_key, interval, **kwargs) (Constructor)

__str__(self) (Informal representation operator)

execute(self)

getAppID(self)

getTaskKey(self)

getDataForTask(self)

init(self, aid, task_key, interval, **kwargs)
(Constructor)

str(self)
(Informal representation operator)