Arena  1.0
A content management system
 All Classes Files Functions Variables Pages
Library.DataSource.Databases.ADataOperation Class Reference

A basic operation performed against a database (i.e., a query or command). More...

+ Inheritance diagram for Library.DataSource.Databases.ADataOperation:

Public Member Functions

def __init__
 Construct a new data operation that will operate on the specified data source. More...
 
def init
 Initializer.
 
def execute
 Execute the operation. More...
 
def Source
 Retrieve the data source used by the operation. More...
 
def handle
 Retrieve the handle assigned to the operation by the data source. More...
 
def runtime
 Retrieve the amount of time elapsed while executing the operation. More...
 
def result
 Retrieve the result code returned by the data source after executing the operation. More...
 
def message
 Retrieve the message generated by the data source while executing the operation, if any. More...
 
- Public Member Functions inherited from Library.Base.Events.ALoggingEventfulObject
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...
 

Detailed Description

A basic operation performed against a database (i.e., a query or command).

Constructor & Destructor Documentation

def Library.DataSource.Databases.ADataOperation.__init__ (   Self,
  params 
)

Construct a new data operation that will operate on the specified data source.

The constructor expects the following items to be provided in params:

  • DataSource – a reference to the instance of ADataSource on which the data operation is to take place.

Member Function Documentation

def Library.DataSource.Databases.ADataOperation.execute (   Self)

Execute the operation.

This routine should be implemented by descendants of ADataOperation. It should return a status code to indicate whether the command or query was accepted and executed by the data source. It should also store this status code in the public 'result' attribute. A status code of zero (0) should be used to indicate success.

This method generates the execute event.

def Library.DataSource.Databases.ADataOperation.handle (   Self)

Retrieve the handle assigned to the operation by the data source.

def Library.DataSource.Databases.ADataOperation.message (   Self)

Retrieve the message generated by the data source while executing the operation, if any.

def Library.DataSource.Databases.ADataOperation.result (   Self)

Retrieve the result code returned by the data source after executing the operation.

def Library.DataSource.Databases.ADataOperation.runtime (   Self)

Retrieve the amount of time elapsed while executing the operation.

def Library.DataSource.Databases.ADataOperation.Source (   Self)

Retrieve the data source used by the operation.


The documentation for this class was generated from the following file: