1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
|
/***************************************************************************
mymoneyfile.h
-------------------
copyright : (C) 2002, 2007 by Thomas Baumgart
email : [email protected]
***************************************************************************/
/***************************************************************************
* *
* 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. *
* *
***************************************************************************/
#ifndef MYMONEYFILE_H
#define MYMONEYFILE_H
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
// ----------------------------------------------------------------------------
// QT Includes
#include <tqobject.h>
#include <tqstring.h>
#include <tqmap.h>
#include <tqvaluelist.h>
// ----------------------------------------------------------------------------
// Project Includes
#include <kmymoney/imymoneystorage.h>
#include <kmymoney/mymoneyexception.h>
#include <kmymoney/mymoneyutils.h>
#include <kmymoney/mymoneyinstitution.h>
#include <kmymoney/mymoneyaccount.h>
#include <kmymoney/mymoneytransaction.h>
#include <kmymoney/mymoneypayee.h>
#include <kmymoney/mymoneykeyvaluecontainer.h>
#include <kmymoney/mymoneysecurity.h>
#include <kmymoney/mymoneyprice.h>
#include <kmymoney/mymoneyreport.h>
#include <kmymoney/mymoneybudget.h>
#include <kmymoney/mymoneyscheduled.h>
#include <kmymoney/export.h>
/**
* @author Thomas Baumgart, Michael Edwardes, Kevin Tambascio
*/
class IMyMoneyStorage;
class MyMoneyTransactionFilter;
/**
* This class represents the interface to the MyMoney engine.
* For historical reasons it is still called MyMoneyFile.
* It is implemented using the singleton pattern and thus only
* exists once for each running instance of an application.
*
* The instance of the MyMoneyFile object is accessed as follows:
*
* @code
* MyMoneyFile *file = MyMoneyFile::instance();
* file->anyMemberFunction();
* @endcode
*
* The first line of the above code creates a unique MyMoneyFile
* object if it is called for the first time ever. All subsequent
* calls to this functions return a pointer to the object created
* during the first call.
*
* As the MyMoneyFile object represents the business logic, a storage
* manager must be attached to it. This mechanism allows to use different
* access methods to store the objects. The interface to access such an
* storage manager is defined in the class IMyMoneyStorage. The methods
* attachStorage() and detachStorage() are used to attach/detach a
* storage manager object. The following code can be used to create a
* functional MyMoneyFile instance:
*
* @code
* IMyMoneyStorage *storage = ....
* MyMoneyFile *file = MyMoneyFile::instance();
* file->attachStorage(storage);
* @endcode
*
* The methods addAccount(), modifyAccount() and removeAccount() implement the
* general account maintenance functions. The method reparentAccount() is
* available to move an account from one superordinate account to another.
* account() and accountList() are used to retrieve a single instance or a
* TQValueList of MyMoneyAccount objects.
*
* The methods addInstitution(), modifyInstitution() and removeInstitution()
* implement the general institution maintenance functions. institution() and
* institutionList() are used to retrieve a single instance or a
* TQValueList of MyMoneyInstitution objects.
*
* The methods addPayee(), modifyPayee() and removePayee()
* implement the general institution maintenance functions.
* payee() and payeeList() are used to retrieve a single instance or a
* TQValueList of MyMoneyPayee objects.
*
* The methods addTransaction(), modifyTransaction() and removeTransaction()
* implement the general transaction maintenance functions.
* transaction() and transactionList() are used to retrieve
* a single instance or a TQValueList of MyMoneyTransaction objects.
*
* The methods addSecurity(), modifySecurity() and removeSecurity()
* implement the general access to equities held in the engine.
*
* The methods addCurrency(), modifyCurrency() and removeCurrency()
* implement the general access to multiple currencies held in the engine.
* The methods baseCurrency() and setBaseCurrency() allow to retrieve/set
* the currency selected by the user as base currency. If a currency
* reference is emtpy, it will usually be interpreted as baseCurrency().
*
* The methods liability(), asset(), expense(), income() and equity() are
* used to retrieve the five standard accounts. isStandardAccount()
* checks if a given accountId references one of the or not.
* setAccountName() is used to specify a name for the standard accounts
* from the GUI.
*
* The MyMoneyFile object emits the dataChanged() signal when data
* has been changed.
*
* For abritrary values that have to be stored with the storage object
* but are of importance to the application only, the object is derived
* for MyMoneyKeyValueContainer which provides a container to store
* these values indexed by an alphanumeric key.
*
* @exception MyMoneyException is thrown whenever an error occurs
* while the engine code is running. The MyMoneyException:: object
* describes the problem.
*/
class KMYMONEY_EXPORT MyMoneyFile : public TQObject
{
Q_OBJECT
TQ_OBJECT
public:
class MyMoneyNotifier
{
public:
MyMoneyNotifier(MyMoneyFile* file) { m_file = file; m_file->clearNotification(); };
~MyMoneyNotifier() { m_file->notify(); };
private:
MyMoneyFile* m_file;
};
friend class MyMoneyNotifier;
/**
* This is the function to access the MyMoneyFile object.
* It returns a pointer to the single instance of the object.
*/
static inline MyMoneyFile* instance() { return &file; }
/**
* This is the destructor for any MyMoneyFile object
*/
~MyMoneyFile();
/**
* @deprecated This is a convenience constructor. Do not use it anymore.
* It will be deprecated in a future version of the engine.
*
* @param storage pointer to object that implements the IMyMoneyStorage
* interface.
*/
MyMoneyFile(IMyMoneyStorage *storage);
// general get functions
const MyMoneyPayee user(void) const;
// general set functions
void setUser(const MyMoneyPayee& user);
/**
* This method is used to attach a storage object to the MyMoneyFile object
* Without an attached storage object, the MyMoneyFile object is
* of no use.
*
* After successful completion, the dataChanged() signal is emitted.
*
* In case of an error condition, an exception is thrown.
* The following error conditions are checked:
*
* - @a storage is not equal to 0
* - there is no other @a storage object attached (use detachStorage()
* to revert the attachStorage() operation.
*
* @param storage pointer to object that implements the IMyMoneyStorage
* interface.
*
* @sa detachStorage()
*/
void attachStorage(IMyMoneyStorage* const storage);
/**
* This method is used to detach a previously attached storage
* object from the MyMoneyFile object. If no storage object
* is attached to the engine, this is a NOP.
*
* @param storage pointer to object that implements the IMyMoneyStorage
* interface.
*
* @sa attachStorage()
*/
void detachStorage(IMyMoneyStorage* const storage = 0);
/**
* This method returns whether a storage is currently attached to
* the engine or not.
*
* @return true if storage object is attached, false otherwise
*/
bool storageAttached(void) const { return m_storage != 0; };
/**
* This method returns a pointer to the storage object
*
* @return const pointer to the current attached storage object.
* If no object is attached, returns 0.
*/
IMyMoneyStorage* storage(void) const { return m_storage; };
/**
* This method must be called before any single change or a series of changes
* in the underlying storage area is performed.
* Once all changes are complete (i.e. the transaction is completed),
* commitTransaction() must be called to finalize all changes. If an error occurs
* during the processing of the changes call rollbackTransaction() to undo the
* changes done so far.
*/
void startTransaction(void);
/**
* This method returns whether a transaction has been started (@a true)
* or not (@a false).
*/
bool hasTransaction(void) const;
/**
* @sa startTransaction()
*/
void commitTransaction(void);
/**
* @sa startTransaction()
*/
void rollbackTransaction(void);
/**
* This method is used to return the standard liability account
* @return MyMoneyAccount liability account(group)
*/
const MyMoneyAccount& liability(void) const;
/**
* This method is used to return the standard asset account
* @return MyMoneyAccount asset account(group)
*/
const MyMoneyAccount& asset(void) const;
/**
* This method is used to return the standard expense account
* @return MyMoneyAccount expense account(group)
*/
const MyMoneyAccount& expense(void) const;
/**
* This method is used to return the standard income account
* @return MyMoneyAccount income account(group)
*/
const MyMoneyAccount& income(void) const;
/**
* This method is used to return the standard equity account
* @return MyMoneyAccount equity account(group)
*/
const MyMoneyAccount& equity(void) const;
/**
* This method returns the account information for the opening
* balances account for the given @p security. If the respective
* account does not exist, it will be created. The name is constructed
* using MyMoneyFile::OpeningBalancesPrefix and appending " (xxx)" in
* case the @p security is not the baseCurrency(). The account created
* will be a sub-account of the standard equity account provided by equity().
*
* @param security Security for which the account is searched
*
* @return The opening balance account
*
* @note No notifications will be sent!
*/
const MyMoneyAccount openingBalanceAccount(const MyMoneySecurity& security);
/**
* This method is essentially the same as the above, except it works on
* const objects. If there is no opening balance account, this method
* WILL NOT create one. Instead it will thrown an exception.
*
* @param security Security for which the account is searched
*
* @return The opening balance account
*
* @note No notifications will be sent!
*/
const MyMoneyAccount openingBalanceAccount(const MyMoneySecurity& security) const;
/**
* Create an opening balance transaction for the account @p acc
* with a value of @p balance. If the corresponding opening balance account
* for the account's currency does not exist it will be created. If it exists
* and it's opening date is later than the opening date of @p acc,
* the opening date of the opening balances account will be adjusted to the
* one of @p acc.
*
* @param acc reference to account for which the opening balance transaction
* should be created
* @param balance reference to the value of the opening balance transaction
*
* @returns The created MyMoneyTransaction object. In case no transaction has been
* created, the id of the object is empty.
*/
MyMoneyTransaction createOpeningBalanceTransaction(const MyMoneyAccount& acc, const MyMoneyMoney& balance);
/**
* Retrieve the opening balance transaction for the account @p acc.
* If there is no opening balance transaction, TQString() will be returned.
*
* @param acc reference to account for which the opening balance transaction
* should be retrieved
* @return TQString id for the transaction, or TQString() if no transaction exists
*/
TQString openingBalanceTransaction(const MyMoneyAccount& acc) const;
/**
* This method returns an indicator if the MyMoneyFile object has been
* changed after it has last been saved to permanent storage.
*
* @return true if changed, false if not
*/
bool dirty(void) const;
/**
* This method is used to force the attached storage object to
* be dirty. This is used by the application to re-set the dirty
* flag after a failed upload to a server when the save operation
* to a local temp file was OK.
*/
void setDirty(void) const;
/**
* Adds an institution to the file-global institution pool. A
* respective institution-ID will be generated for this object.
* The ID is stored as TQString in the object passed as argument.
*
* An exception will be thrown upon error conditions.
*
* @param institution The complete institution information in a
* MyMoneyInstitution object
*/
void addInstitution(MyMoneyInstitution& institution);
/**
* Modifies an already existing institution in the file global
* institution pool.
*
* An exception will be thrown upon error conditions.
*
* @param institution The complete new institution information
*/
void modifyInstitution(const MyMoneyInstitution& institution);
/**
* Deletes an existing institution from the file global institution pool
* Also modifies the accounts that reference this institution as
* their institution.
*
* An exception will be thrown upon error conditions.
*
* @param institution institution to be deleted.
*/
void removeInstitution(const MyMoneyInstitution& institution);
/**
* Adds an account to the file-global account pool. A respective
* account-ID will be generated within this record. The modified
* members of @a account will be updated.
*
* A few parameters of the account to be added are checked against
* the following conditions. If they do not match, an exception is
* thrown.
*
* An account must match the following conditions:
*
* a) the account must have a name with length > 0
* b) the account must not have an id assigned
* c) the transaction list must be empty
* d) the account must not have any sub-ordinate accounts
* e) the account must have no parent account
* f) the account must not have any reference to a MyMoneyFile object
*
* An exception will be thrown upon error conditions.
*
* @param account The complete account information in a MyMoneyAccount object
* @param parent The complete account information of the parent account
*/
void addAccount(MyMoneyAccount& account, MyMoneyAccount& parent);
/**
* Modifies an already existing account in the file global account pool.
*
* An exception will be thrown upon error conditions.
*
* @param account reference to the new account information
*/
void modifyAccount(const MyMoneyAccount& account);
/**
* This method re-parents an existing account
*
* An exception will be thrown upon error conditions.
*
* @param account MyMoneyAccount reference to account to be re-parented
* @param parent MyMoneyAccount reference to new parent account
*/
void reparentAccount(MyMoneyAccount &account, MyMoneyAccount& parent);
/**
* moves splits from one account to another
*
* @param oldAccount id of the current account
* @param newAccount if of the new account
*
* @return the number of modified splits
*/
unsigned int moveSplits(const TQString& oldAccount, const TQString& newAccount);
/**
* This method is used to determince, if the account with the
* given ID is referenced by any split in m_transactionList.
*
* @param id id of the account to be checked for
* @return true if account is referenced, false otherwise
*/
bool hasActiveSplits(const TQString& id) const;
/**
* This method is used to check whether a given
* account id references one of the standard accounts or not.
*
* An exception will be thrown upon error conditions.
*
* @param id account id
* @return true if account-id is one of the standards, false otherwise
*/
bool isStandardAccount(const TQString& id) const;
/**
* Returns @a true, if transaction @p t is a transfer transaction.
* A transfer transaction has two splits, both referencing either
* an asset, a liability or an equity account.
*/
bool isTransfer(const MyMoneyTransaction& t) const;
/**
* This method is used to set the name for the specified standard account
* within the storage area. An exception will be thrown, if an error
* occurs
*
* @param id TQString reference to one of the standard accounts.
* @param name TQString reference to the name to be set
*
*/
void setAccountName(const TQString& id, const TQString& name) const;
/**
* Deletes an existing account from the file global account pool
* This method only allows to remove accounts that are not
* referenced by any split. Use moveSplits() to move splits
* to another account. An exception is thrown in case of a
* problem.
*
* @param account reference to the account to be deleted.
*/
void removeAccount(const MyMoneyAccount& account);
/**
* Deletes existing accounts and their subaccounts recursivly
* from the global account pool.
* This method expects that all accounts and their subaccounts
* are no longer assigned to any transactions or splits.
* An exception is thrown in case of a problem deleting an account.
*
* The optional parameter level is used to keep track of the recursion level.
* If the recursion level exceeds 100 (some arbitrary number which seems a good
* maximum), an exception is thrown.
*
* @param account_list Reference to a list of account IDs to be deleted.
* @param level Parameter to keep track of recursion level (do not pass a value here).
*/
void removeAccountList(const TQStringList& account_list, unsigned int level = 0);
/**
* This member function checks all accounts identified by account_list
* and their subaccounts wether they are assigned to transactions/splits or not.
* The function calls itself recursively with the list of sub-accounts of
* the currently processed account.
*
* The optional parameter level is used to keep track of the recursion level.
* If the recursion level exceeds 100 (some arbitrary number which seems a good
* maximum), an exception is thrown.
*
* @param account_list A TQStringList with account IDs that need to be checked.
* @param level (optional) Optional parameter to indicate recursion level.
* @return Returns 'false' if at least one account has been found that
* is still referenced by a transaction.
*/
bool hasOnlyUnusedAccounts(const TQStringList& account_list, unsigned int level = 0);
/**
* Adds a transaction to the file-global transaction pool. A respective
* transaction-ID will be generated for this object. The ID is stored
* as TQString in the object passed as argument.
* Splits must reference valid accounts and valid payees. The payee
* id can be empty.
*
* An exception will be thrown upon error conditions.
*
* @param transaction reference to the transaction
*/
void addTransaction(MyMoneyTransaction& transaction);
/**
* This method is used to update a specific transaction in the
* transaction pool of the MyMoneyFile object.
* Splits must reference valid accounts and valid payees. The payee
* id can be empty.
*
* An exception will be thrown upon error conditions.
*
* @param transaction reference to transaction to be changed
*/
void modifyTransaction(const MyMoneyTransaction& transaction);
/**
* This method is used to extract a transaction from the file global
* transaction pool through an id. In case of an invalid id, an
* exception will be thrown.
*
* @param id id of transaction as TQString.
* @return reference to the requested transaction
*/
const MyMoneyTransaction transaction(const TQString& id) const;
/**
* This method is used to extract a transaction from the file global
* transaction pool through an index into an account.
*
* @param account id of the account as TQString
* @param idx number of transaction in this account
* @return reference to MyMoneyTransaction object
*/
const MyMoneyTransaction transaction(const TQString& account, const int idx) const;
/**
* This method is used to pull a list of transactions from the file
* global transaction pool. It returns all those transactions
* that match the filter passed as argument. If the filter is empty,
* the whole journal will be returned.
* The list returned is sorted according to the transactions posting date.
* If more than one transaction exists for the same date, the order among
* them is undefined.
*
* @param filter MyMoneyTransactionFilter object with the match criteria
*
* @return set of transactions in form of a TQValueList<MyMoneyTransaction>
*/
const TQValueList<MyMoneyTransaction> transactionList(MyMoneyTransactionFilter& filter) const;
void transactionList(TQValueList<MyMoneyTransaction>& list, MyMoneyTransactionFilter& filter) const;
void transactionList(TQValueList<TQPair<MyMoneyTransaction, MyMoneySplit> >& list, MyMoneyTransactionFilter& filter) const;
/**
* This method is used to remove a transaction from the transaction
* pool (journal).
*
* @param transaction const reference to transaction to be deleted
*/
void removeTransaction(const MyMoneyTransaction& transaction);
/**
* This method is used to return the actual balance of an account
* without it's sub-ordinate accounts. If a @p date is presented,
* the balance at the beginning of this date (not including any
* transaction on this date) is returned. Otherwise all recorded
* transactions are included in the balance.
*
* @param id id of the account in question
* @param date return balance for specific date (default = TQDate())
* @return balance of the account as MyMoneyMoney object
*/
const MyMoneyMoney balance(const TQString& id, const TQDate& date = TQDate()) const;
/**
* This method is used to return the actual balance of an account
* including it's sub-ordinate accounts. If a @p date is presented,
* the balance at the beginning of this date (not including any
* transaction on this date) is returned. Otherwise all recorded
* transactions are included in the balance.
*
* @param id id of the account in question
* @param date return balance for specific date (default = TQDate())
* @return balance of the account as MyMoneyMoney object
*/
const MyMoneyMoney totalBalance(const TQString& id, const TQDate& date = TQDate()) const;
/**
* This method returns the number of transactions currently known to file
* in the range 0..MAXUINT
*
* @param account TQString reference to account id. If account is empty
+ all transactions (the journal) will be counted. If account
* is not empty it returns the number of transactions
* that have splits in this account.
*
* @return number of transactions in journal/account
*/
unsigned int transactionCount(const TQString& account = TQString()) const;
/**
* This method returns a TQMap filled with the number of transactions
* per account. The account id serves as index into the map. If one
* needs to have all transactionCounts() for many accounts, this method
* is faster than calling transactionCount(const TQString& account) many
* times.
*
* @return TQMap with numbers of transactions per account
*/
const TQMap<TQString, unsigned long> transactionCountMap(void) const;
/**
* This method returns the number of institutions currently known to file
* in the range 0..MAXUINT
*
* @return number of institutions known to file
*/
unsigned int institutionCount(void) const;
/**
* This method returns the number of accounts currently known to file
* in the range 0..MAXUINT
*
* @return number of accounts currently known inside a MyMoneyFile object
*/
unsigned int accountCount(void) const;
/**
* Returns the institution of a given ID
*
* @param id id of the institution to locate
* @return MyMoneyInstitution object filled with data. If the institution
* could not be found, an exception will be thrown
*/
const MyMoneyInstitution& institution(const TQString& id) const;
/**
* This method returns a list of the institutions
* inside a MyMoneyFile object
*
* @param list reference to the list. It will be cleared by this method first
*/
void institutionList(TQValueList<MyMoneyInstitution>& list) const;
/**
* This method returns a list of the institutions
* inside a MyMoneyFile object. This is a convenience method
* to the one above
*
* @return TQValueList containing the institution objects
*/
const TQValueList<MyMoneyInstitution> institutionList(void) const;
/**
* Returns the account addressed by its id.
*
* @param id id of the account to locate.
* @return MyMoneyAccount object carrying the @p id. An exception is thrown
* if the id is unknown
*/
const MyMoneyAccount& account(const TQString& id) const;
/**
* Returns the account addressed by its name.
*
* @param name name of the account to locate.
* @return First MyMoneyAccount object found carrying the @p name.
* An empty MyMoneyAccount object will be returned if the name is not found.
*/
const MyMoneyAccount& accountByName(const TQString& name) const;
/**
* Returns the sub-account addressed by its name.
*
* @param acc account to search in
* @param name name of the account to locate.
* @return First MyMoneyAccount object found carrying the @p name.
* An empty MyMoneyAccount object will be returned if the name is not found.
*/
const MyMoneyAccount& subAccountByName(const MyMoneyAccount& acc, const TQString& name) const;
/**
* This method returns a list of accounts inside a MyMoneyFile object.
* An optional parameter is a list of id's. If this list is emtpy (the default)
* the returned list contains all accounts, otherwise only those referenced
* in the id-list.
*
* @param list reference to TQValueList receiving the account objects
* @param idlist TQStringList of account ids of those accounts that
* should be returned. If this list is empty, all accounts
* currently known will be returned.
*
* @param recursive if @p true, then recurse in all found accounts. The default is @p false
*/
void accountList(TQValueList<MyMoneyAccount>& list, const TQStringList& idlist = TQStringList(), const bool recursive = false) const;
/**
* This method is used to convert an account id to a string representation
* of the names which can be used as a category description. If the account
* is part of a hierarchy, the category name will be the concatenation of
* the single account names seperated by MyMoneyAccount::AccountSeperator.
*
* @param accountId TQString reference of the account's id
* @param includeStandardAccounts if true, the standard top account will be part
* of the name, otherwise it will not be included (default is @c false)
*
* @return TQString of the constructed name.
*/
TQString accountToCategory(const TQString& accountId, bool includeStandardAccounts = false) const;
/**
* This method is used to convert a string representing a category to
* an account id. A category can be the concatenation of multiple accounts
* representing a hierarchy of accounts. They have to be seperated by
* MyMoneyAccount::AccountSeperator.
*
* @param category const reference to TQString containing the category
* @param type account type if a specific type is required (defaults to UnknownAccountType)
*
* @return TQString of the corresponding account. If account was not found
* the return value will be an empty string.
*/
TQString categoryToAccount(const TQString& category, MyMoneyAccount::accountTypeE type = MyMoneyAccount::UnknownAccountType) const;
/**
* This method is used to convert a string representing an asset or
* liability account to an account id. An account name can be the
* concatenation of multiple accounts representing a hierarchy of
* accounts. They have to be seperated by MyMoneyAccount::AccountSeperator.
*
* @param name const reference to TQString containing the account name
*
* @return TQString of the corresponding account. If account was not found
* the return value will be an empty string.
*/
TQString nameToAccount(const TQString& name) const;
/**
* This method is used to extract the parent part of an account hierarchy
* name who's parts are seperated by MyMoneyAccount::AccountSeperator.
*
* @param name full account name
* @return parent name (full account name excluding the last part)
*/
TQString parentName(const TQString& name) const;
/**
* This method is used to create a new payee
*
* An exception will be thrown upon error conditions
*
* @param payee MyMoneyPayee reference to payee information
*/
void addPayee(MyMoneyPayee& payee);
/**
* This method is used to retrieve information about a payee
* An exception will be thrown upon error conditions.
*
* @param id TQString reference to id of payee
*
* @return MyMoneyPayee object of payee
*/
const MyMoneyPayee& payee(const TQString& id) const;
/**
* This method is used to retrieve the id to a corresponding
* name of a payee/receiver.
* An exception will be thrown upon error conditions.
*
* @param payee TQString reference to name of payee
*
* @return MyMoneyPayee object of payee
*/
const MyMoneyPayee& payeeByName(const TQString& payee) const;
/**
* This method is used to modify an existing payee
*
* An exception will be thrown upon error conditions
*
* @param payee MyMoneyPayee reference to payee information
*/
void modifyPayee(const MyMoneyPayee& payee);
/**
* This method is used to remove an existing payee.
* An error condition occurs, if the payee is still referenced
* by a split.
*
* An exception will be thrown upon error conditions
*
* @param payee MyMoneyPayee reference to payee information
*/
void removePayee(const MyMoneyPayee& payee);
/**
* This method returns a list of the payees
* inside a MyMoneyStorage object
*
* @return TQValueList<MyMoneyPayee> containing the payee information
*/
const TQValueList<MyMoneyPayee> payeeList(void) const;
/**
* This method is used to extract a value from the storage's
* KeyValueContainer. For details see MyMoneyKeyValueContainer::value().
*
* @param key const reference to TQString containing the key
* @return TQString containing the value
*/
TQString value(const TQString& key) const;
/**
* This method is used to set a value in the storage's
* KeyValueContainer. For details see MyMoneyKeyValueContainer::setValue().
*
* @param key const reference to TQString containing the key
* @param val const reference to TQString containing the value
*
* @note Keys starting with the leadin @p kmm- are reserved for internal use
* by the MyMoneyFile object.
*/
void setValue(const TQString& key, const TQString& val);
/**
* This method is used to delete a key-value-pair from the
* storage's KeyValueContainer identified by the parameter
* @p key. For details see MyMoneyKeyValueContainer::deletePair().
*
* @param key const reference to TQString containing the key
*/
void deletePair(const TQString& key);
/**
* This method is used to add a scheduled transaction to the engine.
* It must be sure, that the id of the object is not filled. When the
* method returns to the caller, the id will be filled with the
* newly created object id value.
*
* An exception will be thrown upon erronous situations.
*
* @param sched reference to the MyMoneySchedule object
*/
void addSchedule(MyMoneySchedule& sched);
/**
* This method is used to modify an existing MyMoneySchedule
* object. Therefor, the id attribute of the object must be set.
*
* An exception will be thrown upon erronous situations.
*
* @param sched const reference to the MyMoneySchedule object to be updated
*/
void modifySchedule(const MyMoneySchedule& sched);
/**
* This method is used to remove an existing MyMoneySchedule object
* from the engine. The id attribute of the object must be set.
*
* An exception will be thrown upon erronous situations.
*
* @param sched const reference to the MyMoneySchedule object to be updated
*/
void removeSchedule(const MyMoneySchedule& sched);
/**
* This method is used to retrieve a single MyMoneySchedule object.
* The id of the object must be supplied in the parameter @p id.
*
* An exception will be thrown upon erronous situations.
*
* @param id TQString containing the id of the MyMoneySchedule object
* @return MyMoneySchedule object
*/
const MyMoneySchedule schedule(const TQString& id) const;
/**
* This method is used to extract a list of scheduled transactions
* according to the filter criteria passed as arguments.
*
* @param accountId only search for scheduled transactions that reference
* account @p accountId. If accountId is the empty string,
* this filter is off. Default is @p TQString().
* @param type only schedules of type @p type are searched for.
* See MyMoneySchedule::typeE for details.
* Default is MyMoneySchedule::TYPE_ANY
* @param occurence only schedules of occurence type @p occurence are searched for.
* See MyMoneySchedule::occurenceE for details.
* Default is MyMoneySchedule::OCCUR_ANY
* @param paymentType only schedules of payment method @p paymentType
* are searched for.
* See MyMoneySchedule::paymentTypeE for details.
* Default is MyMoneySchedule::STYPE_ANY
* @param startDate only schedules with payment dates after @p startDate
* are searched for. Default is all dates (TQDate()).
* @param endDate only schedules with payment dates ending prior to @p endDate
* are searched for. Default is all dates (TQDate()).
* @param overdue if true, only those schedules that are overdue are
* searched for. Default is false (all schedules will be returned).
*
* @return const TQValueList<MyMoneySchedule> list of schedule objects.
*/
const TQValueList<MyMoneySchedule> scheduleList(const TQString& accountId = TQString(),
const MyMoneySchedule::typeE type = MyMoneySchedule::TYPE_ANY,
const MyMoneySchedule::occurenceE occurence = MyMoneySchedule::OCCUR_ANY,
const MyMoneySchedule::paymentTypeE paymentType = MyMoneySchedule::STYPE_ANY,
const TQDate& startDate = TQDate(),
const TQDate& endDate = TQDate(),
const bool overdue = false) const;
const TQStringList consistencyCheck(void);
/**
* MyMoneyFile::OpeningBalancesPrefix is a special string used
* to generate the name for opening balances accounts. See openingBalanceAccount()
* for details.
*/
static const TQString OpeningBalancesPrefix;
/**
* MyMoneyFile::AccountSeperator is used as the seperator
* between account names to form a hierarchy.
*/
static const TQString AccountSeperator;
/**
* createCategory creates a category from a text name.
*
* The whole account hierarchy is created if it doesnt
* already exist. e.g if name = Bills:Credit Card and
* base = expense(), Bills will first be checked to see if
* it exists and created if not. Credit Card will then
* be created with Bills as it's parent. The Credit Card account
* will have it's id returned.
*
* @param base The base account (expense or income)
* @param name The category to create
*
* @return The category account id or empty on error.
*
* @exception An exception will be thrown, if @p base is not equal
* expense() or income().
**/
TQString createCategory(const MyMoneyAccount& base, const TQString& name);
const TQValueList<MyMoneySchedule> scheduleListEx( int scheduleTypes,
int scheduleOcurrences,
int schedulePaymentTypes,
TQDate startDate,
const TQStringList& accounts=TQStringList()) const;
/**
* This method is used to add a new security object to the engine.
* The ID of the object is the trading symbol, so there is no need for an additional
* ID since the symbol is guaranteed to be unique.
*
* An exception will be thrown upon erronous situations.
*
* @param security reference to the MyMoneySecurity object
*/
void addSecurity(MyMoneySecurity& security);
/**
* This method is used to modify an existing MyMoneySchedule
* object.
*
* An exception will be thrown upon erronous situations.
*
* @param security reference to the MyMoneySecurity object to be updated
*/
void modifySecurity(const MyMoneySecurity& security);
/**
* This method is used to remove an existing MyMoneySecurity object
* from the engine.
*
* An exception will be thrown upon erronous situations.
*
* @param security reference to the MyMoneySecurity object to be removed
*/
void removeSecurity(const MyMoneySecurity& security);
/**
* This method is used to retrieve a single MyMoneySecurity object.
* The id of the object must be supplied in the parameter @p id.
* If no security with the given id is found, then a corresponding
* currency is searched. If @p id is empty, the baseCurrency() is returned.
*
* An exception will be thrown upon erronous situations.
*
* @param id TQString containing the id of the MyMoneySecurity object
* @return MyMoneySecurity object
*/
const MyMoneySecurity& security(const TQString& id) const;
/**
* This method is used to retrieve a list of all MyMoneySecurity objects.
*/
const TQValueList<MyMoneySecurity> securityList(void) const;
/**
* This method is used to add a new currency object to the engine.
* The ID of the object is the trading symbol, so there is no need for an additional
* ID since the symbol is guaranteed to be unique.
*
* An exception will be thrown upon erronous situations.
*
* @param currency reference to the MyMoneySecurity object
*/
void addCurrency(const MyMoneySecurity& currency);
/**
* This method is used to modify an existing MyMoneySecurity
* object.
*
* An exception will be thrown upon erronous situations.
*
* @param currency reference to the MyMoneySecurity object
*/
void modifyCurrency(const MyMoneySecurity& currency);
/**
* This method is used to remove an existing MyMoneySecurity object
* from the engine.
*
* An exception will be thrown upon erronous situations.
*
* @param currency reference to the MyMoneySecurity object
*/
void removeCurrency(const MyMoneySecurity& currency);
/**
* This method is used to retrieve a single MyMoneySchedule object.
* The id of the object must be supplied in the parameter @p id.
* If @p id is empty, this method returns baseCurrency().
*
* An exception will be thrown upon erronous situations.
*
* @param id TQString containing the id of the MyMoneySchedule object
* @return MyMoneySchedule object
*/
const MyMoneySecurity& currency(const TQString& id) const;
/**
* This method is used to retrieve the list of all currencies
* known to the engine.
*
* An exception will be thrown upon erronous situations.
*
* @return TQValueList of all MyMoneySecurity objects.
*/
const TQValueList<MyMoneySecurity> currencyList(void) const;
/**
* This method retrieves a MyMoneySecurity object representing
* the selected base currency. If the base currency is not
* selected (e.g. due to a previous call to setBaseCurrency())
* a standard MyMoneySecurity object will be returned. See
* MyMoneySecurity() for details.
*
* An exception will be thrown upon erronous situations.
*
* @return MyMoneySecurity describing base currency
*/
const MyMoneySecurity& baseCurrency(void) const;
/**
* This method returns the foreign currency of the given two
* currency ids. If second is the base currency id then @a first
* is returned otherwise @a second is returned.
*/
const TQString& foreignCurrency(const TQString& first, const TQString& second) const;
/**
* This method allows to select the base currency. It does
* not perform any changes to the data in the engine. It merely
* stores a reference to the base currency. The currency
* passed as argument must exist in the engine.
*
* An exception will be thrown upon erronous situations.
*
* @param currency
*/
void setBaseCurrency(const MyMoneySecurity& currency);
/**
* This method adds/replaces a price to/from the price list
*/
void addPrice(const MyMoneyPrice& price);
/**
* This method removes a price from the price list
*/
void removePrice(const MyMoneyPrice& price);
/**
* This method is used to retrieve a price for a specific security
* on a specific date. If there is no price for this date, the last
* known price for this currency is used. If no price information
* is available, 1.0 will be returned as price.
*
* @param fromId the id of the currency in question
* @param toId the id of the currency to convert to (if emtpy, baseCurrency)
* @param date the date for which the price should be returned (default = today)
* @param exactDate if true, entry for date must exist, if false any price information
* with a date less or equal to @p date will be returned
*
* @return price found as MyMoneyPrice object
* @note This throws an exception when the base currency is not set and toId is empty
*/
const MyMoneyPrice price(const TQString& fromId, const TQString& toId = TQString(), const TQDate& date = TQDate::currentDate(), const bool exactDate = false) const;
/**
* This method returns a list of all prices.
*
* @return MyMoneyPriceList of all MyMoneyPrice objects.
*/
const MyMoneyPriceList priceList(void) const;
/**
* This method allows to interrogate the engine, if a known account
* with id @p id has a subaccount with the name @p name.
*
* @param id id of the account to look at
* @param name account name that needs to be searched force
* @retval true account with name @p name found as subaccounts
* @retval false no subaccount present with that name
*/
bool hasAccount(const TQString& id, const TQString& name) const;
/**
* This method is used to retrieve the list of all reports
* known to the engine.
*
* An exception will be thrown upon erronous situations.
*
* @return TQValueList of all MyMoneyReport objects.
*/
const TQValueList<MyMoneyReport> reportList( void ) const;
/**
* Adds a report to the file-global institution pool. A
* respective report-ID will be generated for this object.
* The ID is stored as TQString in the object passed as argument.
*
* An exception will be thrown upon error conditions.
*
* @param report The complete report information in a
* MyMoneyReport object
*/
void addReport( MyMoneyReport& report );
/**
* Modifies an already existing report in the file global
* report pool.
*
* An exception will be thrown upon error conditions.
*
* @param report The complete new report information
*/
void modifyReport( const MyMoneyReport& report );
/**
* This method returns the number of reports currently known to file
* in the range 0..MAXUINT
*
* @return number of reports known to file
*/
unsigned countReports( void ) const;
/**
* This method is used to retrieve a single MyMoneyReport object.
* The id of the object must be supplied in the parameter @p id.
*
* An exception will be thrown upon erronous situations.
*
* @param id TQString containing the id of the MyMoneyReport object
* @return MyMoneyReport object
*/
const MyMoneyReport report( const TQString& id ) const;
/**
* This method is used to remove an existing MyMoneyReport object
* from the engine. The id attribute of the object must be set.
*
* An exception will be thrown upon erronous situations.
*
* @param report const reference to the MyMoneyReport object to be updated
*/
void removeReport(const MyMoneyReport& report);
/**
* This method is used to retrieve the list of all budgets
* known to the engine.
*
* An exception will be thrown upon erronous situations.
*
* @return TQValueList of all MyMoneyBudget objects.
*/
const TQValueList<MyMoneyBudget> budgetList( void ) const;
/**
* Adds a budget to the file-global institution pool. A
* respective budget-ID will be generated for this object.
* The ID is stored as TQString in the object passed as argument.
*
* An exception will be thrown upon error conditions.
*
* @param budget The complete budget information in a
* MyMoneyBudget object
*/
void addBudget( MyMoneyBudget& budget );
/**
* This method is used to retrieve the id to a corresponding
* name of a budget.
* An exception will be thrown upon error conditions.
*
* @param budget TQString reference to name of budget
*
* @return MyMoneyBudget refernce to object of budget
*/
const MyMoneyBudget budgetByName(const TQString& budget) const;
/**
* Modifies an already existing budget in the file global
* budget pool.
*
* An exception will be thrown upon error conditions.
*
* @param budget The complete new budget information
*/
void modifyBudget( const MyMoneyBudget& budget );
/**
* This method returns the number of budgets currently known to file
* in the range 0..MAXUINT
*
* @return number of budgets known to file
*/
unsigned countBudgets( void ) const;
/**
* This method is used to retrieve a single MyMoneyBudget object.
* The id of the object must be supplied in the parameter @p id.
*
* An exception will be thrown upon erronous situations.
*
* @param id TQString containing the id of the MyMoneyBudget object
* @return MyMoneyBudget object
*/
const MyMoneyBudget budget( const TQString& id ) const;
/**
* This method is used to remove an existing MyMoneyBudget object
* from the engine. The id attribute of the object must be set.
*
* An exception will be thrown upon erronous situations.
*
* @param budget const reference to the MyMoneyBudget object to be updated
*/
void removeBudget(const MyMoneyBudget& budget);
/**
* This method checks, if the given @p object is referenced
* by another engine object.
*
* @param obj const reference to object to be checked
* @param skipCheck MyMoneyFileBitArray with ReferenceCheckBits set for which
* the check should be skipped
*
* @retval false @p object is not referenced
* @retval true @p institution is referenced
*/
bool isReferenced(const MyMoneyObject& obj, const MyMoneyFileBitArray& skipCheck = MyMoneyFileBitArray()) const;
/**
* Returns true if any of the accounts referenced by the splits
* of transaction @a t is closed.
*/
bool referencesClosedAccount(const MyMoneyTransaction& t) const;
/**
* Returns true if the accounts referenced by the split @a s is closed.
*/
bool referencesClosedAccount(const MyMoneySplit& s) const;
/**
* This method checks if the given check no &p no is used in
* a transaction referencing account &p accId. If @p accId is empty,
* @p false is returned.
*
* @param accId id of account to checked
* @param no check number to be verified if used or not
* @retval false @p no is not in use
* @retval true @p no is already assigned
*/
bool checkNoUsed(const TQString& accId, const TQString& no) const;
/**
* This method returns the highest assigned check no for
* account @p accId.
*
* @param accId id of account to be scanned
* @return highest check no. used
*/
TQString highestCheckNo(const TQString& accId) const;
/**
* Clear all internal caches (used internally for performance measurements)
*/
void clearCache(void);
void forceDataChanged(void) { emit dataChanged(); }
void preloadCache(void);
protected:
/**
* This is the constructor for a new empty file description
*/
MyMoneyFile();
signals:
/**
* This signal is emitted whenever any data has been changed in the engine
* via any of the methods of this object
*/
void dataChanged(void);
private:
static MyMoneyFile file;
MyMoneyFile& operator=(MyMoneyFile&); // not allowed for singleton
MyMoneyFile(const MyMoneyFile&); // not allowed for singleton
TQString locateSubAccount(const MyMoneyAccount& base, const TQString& category) const;
void ensureDefaultCurrency(MyMoneyAccount& acc) const;
void warningMissingRate(const TQString& fromId, const TQString& toId) const;
/**
* This method creates an opening balances account. The name is constructed
* using MyMoneyFile::OpeningBalancesPrefix and appending " (xxx)" in
* case the @p security is not the baseCurrency(). The account created
* will be a sub-account of the standard equity account provided by equity().
*
* @param security Security for which the account is searched
*/
const MyMoneyAccount createOpeningBalanceAccount(const MyMoneySecurity& security);
const MyMoneyAccount openingBalanceAccount_internal(const MyMoneySecurity& security) const;
private:
/**
* This method is used to add an id to the list of objects
* to be removed from the cache. If id is empty, then nothing is added to the list.
*
* @param id id of object to be notified
* @param reload reload the object (@c true) or not (@c false). The default is @c true
* @see attach, detach
*/
void addNotification(const TQString& id, bool reload = true);
/**
* This method is used to clear the notification list
*/
void clearNotification(void);
/**
* This method is used to clear all
* objects mentioned in m_notificationList from the cache.
*/
void notify(void);
/**
* This method checks if a storage object is attached and
* throws and exception if not.
*/
inline void checkStorage(void) const {
if(m_storage == 0)
throw new MYMONEYEXCEPTION("No storage object attached to MyMoneyFile");
}
/**
* This method checks that a transaction has been started with
* startTransaction() and throws an exception otherwise. Calls
* checkStorage() to make sure a storage object is present and attached.
*/
void checkTransaction(const char* txt) const;
private:
/**
* This member points to the storage strategy
*/
IMyMoneyStorage *m_storage;
/// \internal d-pointer class.
class Private;
/// \internal d-pointer instance.
Private* const d;
static MyMoneyFile* _instance;
};
class KMYMONEY_EXPORT MyMoneyFileTransaction
{
public:
MyMoneyFileTransaction();
~MyMoneyFileTransaction();
/**
* Commit the current transaction.
*
* @warning Make sure not to use any variable that might have been altered by
* the transaction. Please keep in mind, that changing transactions
* can also affect account objects. If you still need those variables
* just reload them from the engine.
*/
void commit(void);
void rollback(void);
void restart(void);
private:
bool m_isNested;
bool m_needRollback;
};
#endif
|