Arena
1.0
A content management system
|
An object that generates events and which has access to a log for status and debugging messages. More...
Public Member Functions | |
def | __init__ |
Constructor. More... | |
def | init |
Initializer. | |
def | error |
Generate an error event. More... | |
def | log |
Log the specified item. More... | |
def | Log |
Retrieve the log used by the class. | |
Public Member Functions inherited from Library.Base.Events.AnEventfulObject | |
def | __init__ |
Constructor. More... | |
def | init |
Initializer. | |
def | __del__ |
Destructor. | |
def | parseParams |
Parse the specified parameters, looking for named events and setting event handlers as appropriate. More... | |
def | generate |
Generate the named event. | |
def | update |
Update the events generated by the object. | |
def | error |
Generate an error event. More... | |
def | toString |
Construct a string representation of the object. More... | |
def | on |
Set the handler for the specified event. More... | |
def | onMultiple |
Set handlers for multiple events. More... | |
def | handlerFor |
Retrieve the handler for the specified event. More... | |
def | generates |
Determine whether or not the object generates the named event. More... | |
def | __getitem__ |
Retrieve the value of the named property. | |
def | __setitem__ |
Set the value of the named property. | |
Public Member Functions inherited from Library.Base.Classwork.AnObject | |
def | init |
Initialize a new object instance. More... | |
def | __init__ |
Construct and initialize a new instance of AnObject. More... | |
def | __del__ |
Destroy the object instance. More... | |
def | displayName |
Construct a "pretty" display name for the class instance, based on the name of its class. More... | |
def | implements |
Determine whether the class instance is related to the specified class. More... | |
def | toString |
Return a string representation of the class, suitable for output to a console or text-based device. More... | |
def | __str__ |
Return a string representation of the class. More... | |
def | classname |
Return the name of the class from which the instance was created. More... | |
def | name |
Return the name of the class. More... | |
Public Member Functions inherited from Library.String.Utilities.IsPrintable | |
def | toString |
Return a string representation of the class conveniently. More... | |
def | __str__ |
Return a string representation of the class. More... | |
def | printTo |
Print a string representation of the class to the specified stream. More... | |
An object that generates events and which has access to a log for status and debugging messages.
def Library.Base.Events.ALoggingEventfulObject.__init__ | ( | Self, | |
params | |||
) |
Constructor.
The constructor expects that params
will contain the following items:
Log
– A reference to an instance of AMessageLog that will be used to log status messages and errors. def Library.Base.Events.ALoggingEventfulObject.error | ( | Self, | |
Error | |||
) |
Generate an error event.
If an event handler is specified for this event, it will receive an instance of AnEvent with a parameter named Error
that refers to the exception that was raised because of the error. The handler should set Event.handled() to True
in order to prevent the exception from being raised; otherwise, if the event is not handled, it will be logged to the log associated with the class, and then an exception will be raised.
This routine generates the error
event.
def Library.Base.Events.ALoggingEventfulObject.log | ( | Self, | |
Item, | |||
freeItem = True |
|||
) |
Log the specified item.
This routine generates the log
event.