Package: GWindows.Databases

Dependencies

with Ada.Finalization;

with GNATCOM.Dispinterface;
with GNATCOM.Types;

with ADO.uConnection_Interface;
with ADO.uRecordset_Interface;

Description

GWINDOWS - Ada 95 Framework for Win32 Development

G W I N D O W S . D A T A B A S E S

S p e c

$Revision: 1.2 $

This is free software; you can redistribute it and/or modify it under terms of the GNU General Public License as published by the Free Soft- ware Foundation; either version 2, or (at your option) any later ver- sion. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License distributed with this; see file COPYING. If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

As a special exception, if other files instantiate generics from this unit, or you link this unit with other files to produce an executable, this unit does not by itself cause the resulting executable to be covered by the GNU General Public License. This exception does not however invalidate any other reasons why the executable file might be covered by the GNU Public License.

More information about GWindows and the latest current release can be located on the web at http://www.gnavi.org/gwindows

Database_Type

Database connection object

Header

package GWindows.Databases is

Type Summary

`Before_Change_Event`
`Before_Field_Change_Event`
`Change_Event`
`Cursor_Type`
`Database_Type` derived from `Limited_Controlled`
New Operations:	`Close`, `Execute`, `Execute`, `Interface`, `Open`
Inherited Operations:	`Finalize`, `Initialize`
`Field_Change_Event`
`Lock_Type`
`Move_From_Type`
`Recordset_Type` derived from `Limited_Controlled`
New Operations:	`Add_New`, `BOF`, `Cancel_Update`, `Close`, `Delete`, `Edit_Mode`, `EOF`, `Field_Count`, `Field_Name`, `Field_Updatable`, `Field_Updatable`, `Field_Value`, `Field_Value`, `Field_Value`, `Field_Value`, `Field_Value`, `Field_Value`, `Field_Value`, `Field_Value`, `Fire_On_Add_New`, `Fire_On_Before_Add_New`, `Fire_On_Before_Change`, `Fire_On_Before_Delete`, `Fire_On_Before_Field_Change`, `Fire_On_Before_Update`, `Fire_On_Change`, `Fire_On_Delete`, `Fire_On_Field_Change`, `Fire_On_Update`, `Interface`, `Move`, `Move_First`, `Move_Last`, `Move_Next`, `Move_Previous`, `On_Add_New`, `On_Add_New_Handler`, `On_Before_Add_New`, `On_Before_Add_New_Handler`, `On_Before_Change`, `On_Before_Change_Handler`, `On_Before_Delete`, `On_Before_Delete_Handler`, `On_Before_Field_Change`, `On_Before_Field_Change_Handler`, `On_Before_Update`, `On_Before_Update_Handler`, `On_Change`, `On_Change_Handler`, `On_Delete`, `On_Delete_Handler`, `On_Field_Change`, `On_Field_Change_Handler`, `On_Update`, `On_Update_Handler`, `Open`, `Record_Count`, `Requery`, `Resync`, `Update`
Inherited Operations:	`Finalize`, `Initialize`

Other Items:

type Database_Type is
  new Ada.Finalization.Limited_Controlled with private;

function Interface (This : Database_Type)
                   return GNATCOM.Dispinterface.Dispinterface_Type;

Database_Type - Methods

procedure Open (Database          : in out Database_Type;
                Connection_String : in     GString;
                User_ID           : in     GString        := "";
                Password          : in     GString        := "");

Open connection to database

procedure Close (Database : in out Database_Type);

Close connection to database

function Execute (Database : in Database_Type;
                  Query    : in GString)
                 return Natural;

Executes a Query and returns number of affected rows

procedure Execute (Database : in out Database_Type;
                   Query    : in     GString);

Executes a Query

type Recordset_Type is
  new Ada.Finalization.Limited_Controlled with private;

Recordset_Type

function Interface (This : Recordset_Type)
                   return GNATCOM.Dispinterface.Dispinterface_Type;

Recordset_Type - Properties

function Edit_Mode (Recordset : Recordset_Type) return Boolean;

Returns true if current record is in edit mode

function BOF (Recordset : Recordset_Type) return Boolean;

Current record before first record

function EOF (Recordset : Recordset_Type) return Boolean;

Current record after last record

function Record_Count (Recordset : Recordset_Type) return Integer;

Number of records in recorset or -1 if this can not be determined

function Field_Count (Recordset : Recordset_Type) return Natural;

Number of fields in each record

function Field_Name (Recordset : Recordset_Type;
                     Index     : Positive)
                     return GString;

Name of field at index

function Field_Updatable (Recordset : in Recordset_Type;
                          Index     : in Positive)
                         return Boolean;

function Field_Updatable (Recordset : in Recordset_Type;
                          Name      : in GString)
                         return Boolean;

If field can be updated

function Field_Value (Recordset : Recordset_Type;
                      Index     : Positive)
                     return GString;

function Field_Value (Recordset : Recordset_Type;
                      Name      : GString)
                     return GString;

function Field_Value (Recordset : Recordset_Type;
                      Index     : Positive)
                     return GNATCOM.Types.VARIANT;

function Field_Value (Recordset : Recordset_Type;
                      Name      : GString)
                     return GNATCOM.Types.VARIANT;

procedure Field_Value (Recordset : in out Recordset_Type;
                       Index     : in     Positive;
                       Value     : in     GString);

procedure Field_Value (Recordset : in out Recordset_Type;
                       Name      : in     GString;
                       Value     : in     GString);

procedure Field_Value (Recordset : in out Recordset_Type;
                       Index     : in     Positive;
                       Value     : in     GNATCOM.Types.VARIANT;
                       Clear     : in     Boolean               := True);

procedure Field_Value (Recordset : in out Recordset_Type;
                       Name      : in     GString;
                       Value     : in     GNATCOM.Types.VARIANT;
                       Clear     : in     Boolean               := True);

Field value of this record

type Cursor_Type is (Dynamic, Forward_Only, Keyset, Static);

Recordset_Type - Methods

type Lock_Type is (Batch_Optimistic,
                   Optimistic,
                   Pessimistic,
                   Read_Only);

procedure Open (Recordset : in out Recordset_Type;
                Database  : in     Database_Type'Class;
                Query     : in     GString;
                Cursor    : in     Cursor_Type;
                Lock      : in     Lock_Type);

Open recordset

procedure Close (Recordset : in out Recordset_Type);

Close recordset

procedure Requery (Recordset : in out Recordset_Type);

Rerun recordset's query

procedure Resync (Recordset : in out Recordset_Type);

Refresh recordset data

procedure Add_New (Recordset : in out Recordset_Type);

Add a new record to recordset Call Update to post changes to the new record to the database

procedure Update (Recordset : in out Recordset_Type);

Post changes to current record

procedure Cancel_Update (Recordset : in out Recordset_Type);

Cancel an Add_New in progress or changes being made to the current record

procedure Delete (Recordset : in out Recordset_Type);

Delete current record

procedure Move_First (Recordset : in out Recordset_Type);

procedure Move_Last (Recordset : in out Recordset_Type);

procedure Move_Next (Recordset : in out Recordset_Type);

procedure Move_Previous (Recordset : in out Recordset_Type);

Move to XXXX record

type Move_From_Type is (Current, First, Last);

procedure Move (Recordset : in out Recordset_Type;
                Count     : in     Integer;
                From      : in     Move_From_Type := Current);

Move cursor count records from

type Before_Change_Event is access
  procedure (Recordset : in out Recordset_Type'Class;
             Change    : out    Boolean);

Recordset_Type - Event Types

type Change_Event is access
  procedure (Recordset : in out Recordset_Type'Class);

type Before_Field_Change_Event is access
  procedure (Recordset : in out Recordset_Type'Class;
             Name      : in     GString;
             Value     : in out GNATCOM.Types.VARIANT;
             Change    :    out Boolean);

type Field_Change_Event is access
  procedure (Recordset : in out Recordset_Type'Class;
             Name      : in     GString;
             Value     : in     GNATCOM.Types.VARIANT);

Recordset_Type - Event Handlers

See Event Methods for details on each event

procedure On_Before_Change_Handler
  (Recordset  : in out Recordset_Type;
   Handler    : in     Before_Change_Event);

procedure Fire_On_Before_Change (Recordset : in out Recordset_Type;
                                 Change    :    out Boolean);

procedure On_Change_Handler
  (Recordset  : in out Recordset_Type;
   Handler    : in     Change_Event);

procedure Fire_On_Change (Recordset : in out Recordset_Type);

procedure On_Before_Field_Change_Handler
  (Recordset  : in out Recordset_Type;
   Handler    : in     Before_Field_Change_Event);

procedure Fire_On_Before_Field_Change
  (Recordset : in out Recordset_Type;
   Name      : in     GString;
   Value     : in out GNATCOM.Types.VARIANT;
   Change    :    out Boolean);

procedure On_Field_Change_Handler
  (Recordset  : in out Recordset_Type;
   Handler    : in     Field_Change_Event);

procedure Fire_On_Field_Change (Recordset : in out Recordset_Type;
                                Name      : in     GString;
                                Value     : in     GNATCOM.Types.VARIANT);

procedure On_Before_Update_Handler
  (Recordset  : in out Recordset_Type;
   Handler    : in     Before_Change_Event);

procedure Fire_On_Before_Update (Recordset : in out Recordset_Type;
                                 Change    :    out Boolean);

procedure On_Update_Handler
  (Recordset  : in out Recordset_Type;
   Handler    : in     Change_Event);

procedure Fire_On_Update (Recordset : in out Recordset_Type);

procedure On_Before_Add_New_Handler
  (Recordset  : in out Recordset_Type;
   Handler    : in     Before_Change_Event);

procedure Fire_On_Before_Add_New (Recordset : in out Recordset_Type;
                                  Change    :    out Boolean);

procedure On_Add_New_Handler
  (Recordset  : in out Recordset_Type;
   Handler    : in     Change_Event);

procedure Fire_On_Add_New (Recordset : in out Recordset_Type);

procedure On_Before_Delete_Handler
  (Recordset  : in out Recordset_Type;
   Handler    : in     Before_Change_Event);

procedure Fire_On_Before_Delete (Recordset : in out Recordset_Type;
                                  Change    :    out Boolean);

procedure On_Delete_Handler
  (Recordset  : in out Recordset_Type;
   Handler    : in     Change_Event);

procedure Fire_On_Delete (Recordset : in out Recordset_Type);

Recordset_Type - Events

procedure On_Before_Change (Recordset : in out Recordset_Type;
                            Change    :    out Boolean);

Request to current change record

procedure On_Change (Recordset : in out Recordset_Type);

Current record has changed

procedure On_Before_Field_Change (Recordset : in out Recordset_Type;
                                  Name      : in     GString;
                                  Value     : in out GNATCOM.Types.VARIANT;
                                  Change    :    out Boolean);

Request to change field value

procedure On_Field_Change (Recordset : in out Recordset_Type;
                           Name      : in     GString;
                           Value     : in     GNATCOM.Types.VARIANT);

Field value has changed

procedure On_Before_Update (Recordset : in out Recordset_Type;
                            Change    :    out Boolean);

Request to update record

procedure On_Update (Recordset : in out Recordset_Type);

Current record has been updated

procedure On_Before_Add_New (Recordset : in out Recordset_Type;
                             Change    :    out Boolean);

Request to add a new record

procedure On_Add_New (Recordset : in out Recordset_Type);

Current record represents a new record to be added

procedure On_Before_Delete (Recordset : in out Recordset_Type;
                            Change    :    out Boolean);

Request to update record

procedure On_Delete (Recordset : in out Recordset_Type);

Current record has been updated

private

   --  Implementation-defined ...

end GWindows.Databases;