db_t.h

Go to the documentation of this file.

/* kort db interface class. -*-ObjC-*-
Copyright (C) 2005 Antti Järvinen

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program 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
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. */

/* "$Id: db_t.h,v 1.16 2005/05/13 21:25:23 costello Exp $" */

#ifndef DB_T_H_INCLUDED
#define DB_T_H_INCLUDED

#include <sys/types.h>
#include <objc/Object.h>
#include <mysql/mysql.h>
#include "ciroucset_common.h"
#include "pointerlist_t.h"
#include "valuepair_p.h"
#include "record_status_p.h"

// forward declare:
@class appbus_t ; 

#define MAX_SQL_STATEMENT_SIZE 40000  

typedef enum { no_res, 
               singlerow, 
               manyrows 
             } expected_query_result_t ; 

@interface db_t:Object
{
  appbus_t *bus ; 
  MYSQL mysli ;   
  char *sql_statement ; 
  MYSQL_RES *resultset_of_query ; 
  MYSQL_ROW exactly_one_row ; 
  my_ulonglong how_many_rows ; 
  char lock_info_string[200] ; 
  char lock_info_string_of_locked_record[200] ; 
} 
-init;
+init_with_values:(appbus_t *)aBus ; 
-(int)init_2nd_stage ; 

-free ;
//
// actual workhorse methods: 
//
-(int)save_record_to_db:(id<valuepair_p> *)values 
                       :(id<record_status_p>)recstat; 

-(int)fetch_record_from_db:(id<valuepair_p> *)values 
                          :(id<record_status_p>)recstat;

-(int)delete_record_in_db:(id<valuepair_p> *)values 
                         :(id<record_status_p>)recstat;

-(int)delete_subrecords_in_db:(record_t *)aRecord
                             :(long)record_id_master ; 


-(void)find_largest_keys_for_record:(id<valuepair_p> *)values 
                                    :(id<record_status_p>)recstat;

-(void)unlock_record_in_db :(id<record_status_p>)recstat;

-(maybe_t)lock_record_in_db :(id<record_status_p>)recstat;
-(char *)is_record_locked:(id<record_status_p>)recstat;
-(long)new_recid:(id<valuepair_p> *)values 
                :(id<record_status_p>)recstat;

-(maybe_t)find_keys_for_record:(id<valuepair_p> *)values 
                              :(id<record_status_p>)recstat; 

-(int)do_exec:(expected_query_result_t)aExpectedResult ; 
-(void)freeres ; 
-(void)update_kort_ui:(id<record_status_p>)aRecStat ;
-(pointerlist_t *)list_of_instances:(char *)recname
                                   :(long) recid
                                   :(long) recid_master ; 
-(int)find_last_saved_field : (id<valuepair_p> *)values ; 
-(maybe_t)find_allowed_value:(id<record_status_p>)aRecStat 
                            :(id<valuepair_p>)aValue
                            :(wchar_t *)aCurrentValue
                            :(char *)aAllowedValuesTable
                            :(char *)aAllowedValuesColumn ;

@end
/* end of db_t definition */
#endif

---