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
|
/***************************************************************************
mymoneyseqaccessmgr.h - description
-------------------
begin : Sun May 5 2002
copyright : (C) 2000-2002 by Michael Edwardes
email : mte@users.sourceforge.net
Javier Campos Morales <javi_c@users.sourceforge.net>
Felix Rodriguez <frodriguez@users.sourceforge.net>
John C <thetacoturtle@users.sourceforge.net>
Thomas Baumgart <ipwizard@users.sourceforge.net>
Kevin Tambascio <ktambascio@users.sourceforge.net>
***************************************************************************/
/***************************************************************************
* *
* 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 MYMONEYSETQACCESSMGR_H
#define MYMONEYSETQACCESSMGR_H
// ----------------------------------------------------------------------------
// QT Includes
// ----------------------------------------------------------------------------
// Project Includes
#include "imymoneystorage.h"
#include "imymoneyserialize.h"
#include "mymoneymap.h"
/**
* @author Thomas Baumgart
*/
/**
* This member represents an item in the balance cache. The balance cache
* is used for fast processing of the balance of an account. Several
* of these objects are held by the MyMoneySeqAccessMgr() object in a map
* with the account Id as key. If such a cache item is present in the map,
* the contained balance of it will be used as current balance for this
* account. If the balance is changed by any operation, the
* MyMoneyBalanceCacheItem for the modified account will be removed from
* the map and the next time the balance for this account is requested,
* it has to be recalculated. After recalculation, a new MyMoneyBalanceCacheItem
* will be created containing the new balance value.
*
* @see MyMoneySeqAccessMgr::balance() and
* MyMoneySeqAccessMgr::invalidateBalanceCache() for a usage example
*/
class MyMoneyBalanceCacheItem {
public:
MyMoneyBalanceCacheItem() { valid = false; };
MyMoneyBalanceCacheItem(const MyMoneyMoney& val) { balance = val; valid = true; };
bool operator == (const MyMoneyBalanceCacheItem& right) const;
bool valid;
MyMoneyMoney balance;
};
/**
* The MyMoneySeqAccessMgr class represents the storage engine for sequential
* files. The actual file type and it's internal storage format (e.g. binary
* or XML) is not important and handled through the IMyMoneySerialize() interface.
*
* The MyMoneySeqAccessMgr must be loaded by an application using the
* IMyMoneySerialize() interface and can then be accessed through the
* IMyMoneyStorage() interface. All data is loaded into memory, modified
* and kept there. It is the subject of an outside object to store the
* modified data in a persistant storage area using the IMyMoneySerialize()
* interface. As indication, if data has been changed, the retrun value
* of the method dirty() can be used.
*/
class MyMoneySeqAccessMgr : public IMyMoneyStorage, public IMyMoneySerialize,
public MyMoneyKeyValueContainer
{
public:
MyMoneySeqAccessMgr();
~MyMoneySeqAccessMgr();
// general get functions
const MyMoneyPayee user(void) const { return m_user; };
const TQDate creationDate(void) const { return m_creationDate; };
const TQDate lastModificationDate(void) const { return m_lastModificationDate; };
unsigned int currentFixVersion(void) const { return m_currentFixVersion; };
unsigned int fileFixVersion(void) const { return m_fileFixVersion; };
// general set functions
void setUser(const MyMoneyPayee& user) { m_user = user;
touch(); };
void setCreationDate(const TQDate& val) { m_creationDate = val; touch(); };
void setLastModificationDate(const TQDate& val) { m_lastModificationDate = val; m_dirty = false; };
void setFileFixVersion(const unsigned int v) { m_fileFixVersion = v; };
/**
* This method is used to get a SQL reader for subsequent database access
*/
TDESharedPtr <MyMoneyStorageSql> connectToDatabase (const KURL& url);
/**
* This method is used when a database file is open, and the data is to
* be saved in a different file or format. It will ensure that all data
* from the database is available in memory to enable it to be written.
*/
virtual void fillStorage() { };
/**
* This method is used to duplicate the MyMoneySeqAccessMgr object and return
* a pointer to the newly created copy. The caller of this method is the
* new owner of the object and must destroy it.
*/
MyMoneySeqAccessMgr const * duplicate(void);
/**
* Returns the account addressed by it's id.
*
* @param id id of the account to locate.
* @return reference to MyMoneyAccount object. An exception is thrown
* if the id is unknown
*/
const MyMoneyAccount account(const TQString& id) const;
/**
* This method is used to check whether a given
* account id references one of the standard accounts or not.
*
* @param id account id
* @return true if account-id is one of the standards, false otherwise
*/
bool isStandardAccount(const TQString& id) 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. Possible
* values are:
*
* @li STD_ACC_LIABILITY
* @li STD_ACC_ASSET
* @li STD_ACC_EXPENSE
* @li STD_ACC_INCOME
* @li STD_ACC_EQUITY
*
* @param name TQString reference to the name to be set
*
*/
void setAccountName(const TQString& id, const TQString& name);
/**
* This method is used to create a new account
*
* An exception will be thrown upon error conditions.
*
* @param account MyMoneyAccount filled with data
*/
void addAccount(MyMoneyAccount& account);
/**
* 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 reference to 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 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 add one account as sub-ordinate to another
* (parent) account. The objects passed as arguments will be modified
* accordingly.
*
* @param parent parent account the account should be added to
* @param account the account to be added
*/
void addAccount(MyMoneyAccount& parent, MyMoneyAccount& account);
/**
* Adds an institution to the storage. A
* respective institution-ID will be generated within this record.
* 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);
/**
* Adds a transaction to the file-global transaction pool. A respective
* transaction-ID will be generated within this record. The ID is stored
* as TQString in the transaction object. The accounts of the referenced splits
* will be updated to have a reference to the transaction just added.
*
* @param transaction reference to the transaction
* @param skipAccountUpdate if set, the transaction lists of the accounts
* referenced in the splits are not updated. This is used for
* bulk loading a lot of transactions but not during normal operation
*/
void addTransaction(MyMoneyTransaction& transaction, const bool skipAccountUpdate = false);
/**
* 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
* @param skipCheck if @p true, skips the built in consistency check for
* the object to be updated. Do not set this parameter
* to true. This is only used for the MyMoneyFile::consistencyCheck()
* procedure to be able to reload accounts. The default
* setting of this parameter is @p false.
*/
void modifyAccount(const MyMoneyAccount& account, const bool skipCheck = false);
/**
* 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);
/**
* This method is used to update a specific transaction in the
* transaction pool of the MyMoneyFile object
*
* An exception will be thrown upon error conditions.
*
* @param transaction reference to transaction to be changed
*/
void modifyTransaction(const MyMoneyTransaction& transaction);
/**
* 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);
/**
* 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);
/**
* 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 an existing institution from the file global institution pool
* Also modifies the accounts that reference this institution as
* their institution.
*
* @param institution institution to be deleted.
*/
void removeInstitution(const MyMoneyInstitution& institution);
/**
* 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 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 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
* @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
* @return balance of the account as MyMoneyMoney object
*/
const MyMoneyMoney totalBalance(const TQString& id, const TQDate& date = TQDate()) 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 an indicator if the storage object has been
* changed after it has last been saved to permanent storage.
*
* @return true if changed, false if not
*/
bool dirty(void) const { return m_dirty; }
/**
* This method can be used by an external object to force the
* storage object to be dirty. This is used e.g. when an upload
* to an external destination failed but the previous storage
* to a local disk was ok.
*/
void setDirty(void) { m_dirty = true; };
/**
* This method returns a list of the institutions
* inside a MyMoneyFile object
*
* @return TQMap containing the institution information
*/
const TQValueList<MyMoneyInstitution> institutionList(void) const;
/**
* This method returns a list of accounts inside the storage object.
*
* @param list reference to TQValueList receiving the account objects
*
* @note The standard accounts will not be returned
*/
void accountList(TQValueList<MyMoneyAccount>& list) 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.
*
* The @p list will be cleared by this method.
*
* @param list reference to list
* @param filter MyMoneyTransactionFilter object with the match criteria
*
* @return set of transactions in form of a TQValueList<MyMoneyTransaction>
*/
void transactionList(TQValueList<MyMoneyTransaction>& list, MyMoneyTransactionFilter& filter) 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.
*
* The @p list will be cleared by this method.
*
* @param list reference to list
* @param filter MyMoneyTransactionFilter object with the match criteria
*
* @return set of transactions in form of a TQValueList<TQPair<MyMoneyTransaction,MyMoneySplit> >
*/
void transactionList(TQValueList< TQPair<MyMoneyTransaction, MyMoneySplit> >& list, MyMoneyTransactionFilter& filter) const;
/**
* Compatibility interface for the previous method.
*/
const TQValueList<MyMoneyTransaction> transactionList(MyMoneyTransactionFilter& filter) const;
/**
* This method returns whether a given transaction is already in memory, to avoid
* reloading it from the database
*/
bool isDuplicateTransaction(const TQString& id) const { return m_transactionKeys.contains(id); }
/**
* 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;
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;
/**
* This method is used to return the standard liability account
* @return MyMoneyAccount liability account(group)
*/
const MyMoneyAccount liability(void) const { return account(STD_ACC_LIABILITY); };
/**
* This method is used to return the standard asset account
* @return MyMoneyAccount asset account(group)
*/
const MyMoneyAccount asset(void) const { return account(STD_ACC_ASSET); };
/**
* This method is used to return the standard expense account
* @return MyMoneyAccount expense account(group)
*/
const MyMoneyAccount expense(void) const { return account(STD_ACC_EXPENSE); };
/**
* This method is used to return the standard income account
* @return MyMoneyAccount income account(group)
*/
const MyMoneyAccount income(void) const { return account(STD_ACC_INCOME); };
/**
* This method is used to return the standard equity account
* @return MyMoneyAccount equity account(group)
*/
const MyMoneyAccount equity(void) const { return account(STD_ACC_EQUITY); };
virtual void loadAccounts(const TQMap<TQString, MyMoneyAccount>& acc);
virtual void loadTransactions(const TQMap<TQString, MyMoneyTransaction>& map);
virtual void loadInstitutions(const TQMap<TQString, MyMoneyInstitution>& map);
virtual void loadPayees(const TQMap<TQString, MyMoneyPayee>& map);
virtual void loadSchedules(const TQMap<TQString, MyMoneySchedule>& map);
virtual void loadSecurities(const TQMap<TQString, MyMoneySecurity>& map);
virtual void loadCurrencies(const TQMap<TQString, MyMoneySecurity>& map);
virtual void loadPrices(const MyMoneyPriceList& list);
virtual void loadAccountId(const unsigned long id);
virtual void loadTransactionId(const unsigned long id);
virtual void loadPayeeId(const unsigned long id);
virtual void loadInstitutionId(const unsigned long id);
virtual void loadScheduleId(const unsigned long id);
virtual void loadSecurityId(const unsigned long id);
virtual void loadReportId(const unsigned long id);
virtual void loadBudgetId(const unsigned long id);
virtual unsigned long accountId(void) const { return m_nextAccountID; };
virtual unsigned long transactionId(void) const { return m_nextTransactionID; };
virtual unsigned long payeeId(void) const { return m_nextPayeeID; };
virtual unsigned long institutionId(void) const { return m_nextInstitutionID; };
virtual unsigned long scheduleId(void) const { return m_nextScheduleID; };
virtual unsigned long securityId(void) const { return m_nextSecurityID; };
virtual unsigned long reportId(void) const { return m_nextReportID; };
virtual unsigned long budgetId(void) const { return m_nextBudgetID; };
/**
* This method is used to extract a value from
* KeyValueContainer. For details see MyMoneyKeyValueContainer::value().
*
* @param key const reference to TQString containing the key
* @return TQString containing the value
*/
const TQString value(const TQString& key) const;
/**
* This method is used to set a value in the
* KeyValueContainer. For details see MyMoneyKeyValueContainer::setValue().
*
* @param key const reference to TQString containing the key
* @param val const reference to TQString containing the value
*/
void setValue(const TQString& key, const TQString& val);
/**
* This method is used to delete a key-value-pair from the
* 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);
// documented in IMyMoneySerialize base class
const TQMap<TQString, TQString> pairs(void) const;
// documented in IMyMoneySerialize base class
void setPairs(const TQMap<TQString, TQString>& list);
/**
* 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 create a new security object. The ID will be created
* automatically. The object passed with the parameter @p security is modified
* to contain the assigned id.
*
* An exception will be thrown upon error conditions.
*
* @param security MyMoneySecurity filled with data
*/
virtual 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 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 MyMoneySecurity security(const TQString& id) const;
/**
* This method returns a list of security objects that the engine has
* knowledge of.
*/
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 MyMoneyCurrency object
*/
void addCurrency(const MyMoneySecurity& currency);
/**
* This method is used to modify an existing MyMoneyCurrency
* object.
*
* An exception will be thrown upon erronous situations.
*
* @param currency reference to the MyMoneyCurrency object
*/
void modifyCurrency(const MyMoneySecurity& currency);
/**
* This method is used to remove an existing MyMoneyCurrency object
* from the engine.
*
* An exception will be thrown upon erronous situations.
*
* @param currency reference to the MyMoneyCurrency 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.
*
* 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 MyMoneyCurrency objects.
*/
const TQValueList<MyMoneySecurity> currencyList(void) 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
* accound @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 TQValueList<MyMoneySchedule> scheduleListEx( int scheduleTypes,
int scheduleOcurrences,
int schedulePaymentTypes,
TQDate startDate,
const TQStringList& accounts=TQStringList()) 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;
/**
* This method is used to add a new report 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 report reference to the MyMoneyReport object
*/
void addReport( MyMoneyReport& report );
/**
* This method is used to load a set of reports into the engine. This is
* used when loading from storage, and an ID is already known.
*
* An exception will be thrown upon erronous situations.
*
* @param reports reference to the map of MyMoneyReport objects
*/
void loadReports( const TQMap<TQString, MyMoneyReport>& reports );
/**
* This method is used to modify an existing MyMoneyReport
* object. Therefor, 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 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;
/**
* This method is used to add a new budget 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 budget reference to the MyMoneyBudget object
*/
void addBudget( MyMoneyBudget& budget );
/**
* This method is used to load a set of budgets into the engine. This is
* used when loading from storage, and an ID is already known.
*
* An exception will be thrown upon erronous situations.
*
* @param budgets reference to the map of MyMoneyBudget object
*/
void loadBudgets(const TQMap<TQString, MyMoneyBudget>& budgets);
/**
* 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 reference to object of budget
*/
const MyMoneyBudget budgetByName(const TQString& budget) const;
/**
* This method is used to modify an existing MyMoneyBudget
* object. Therefore, 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 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
*/
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 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 retrieves a price from the price list.
* If @p date is inValid, TQDate::currentDate() is assumed.
*/
const MyMoneyPrice price(const TQString& fromId, const TQString& toId, const TQDate& date, const bool exactDate) const;
/**
* This method returns a list of all price entries.
*/
const MyMoneyPriceList priceList(void) const;
/**
* Clear all internal caches (used internally for performance measurements)
*/
void clearCache(void);
/**
* 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 TQBitArray 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;
/**
* This method recalculates the balances of all accounts
* based on the transactions stored in the engine.
*/
void rebuildAccountBalances(void);
virtual void startTransaction(void);
virtual bool commitTransaction(void);
virtual void rollbackTransaction(void);
protected:
void removeReferences(const TQString& id);
private:
static const int INSTITUTION_ID_SIZE = 6;
static const int ACCOUNT_ID_SIZE = 6;
static const int TRANSACTION_ID_SIZE = 18;
static const int PAYEE_ID_SIZE = 6;
static const int SCHEDULE_ID_SIZE = 6;
static const int SECURITY_ID_SIZE = 6;
static const int REPORT_ID_SIZE = 6;
static const int BUDGET_ID_SIZE = 6;
/**
* This method is used to set the dirty flag and update the
* date of the last modification.
*/
void touch(void);
/**
* This method is used to invalidate the cached balance for
* the selected account and all it's parents.
*
* @param id id of the account in question
*/
void invalidateBalanceCache(const TQString& id);
/**
* This member variable keeps the User information.
* @see setUser()
*/
MyMoneyPayee m_user;
/**
* The member variable m_nextInstitutionID keeps the number that will be
* assigned to the next institution created. It is maintained by
* nextInstitutionID().
*/
unsigned long m_nextInstitutionID;
/**
* The member variable m_nextAccountID keeps the number that will be
* assigned to the next institution created. It is maintained by
* nextAccountID().
*/
unsigned long m_nextAccountID;
/**
* The member variable m_nextTransactionID keeps the number that will be
* assigned to the next transaction created. It is maintained by
* nextTransactionID().
*/
unsigned long m_nextTransactionID;
/**
* The member variable m_nextPayeeID keeps the number that will be
* assigned to the next payee created. It is maintained by
* nextPayeeID()
*/
unsigned long m_nextPayeeID;
/**
* The member variable m_nextScheduleID keeps the number that will be
* assigned to the next schedule created. It is maintained by
* nextScheduleID()
*/
unsigned long m_nextScheduleID;
/**
* The member variable m_nextSecurityID keeps the number that will be
* assigned to the next security object created. It is maintained by
* nextSecurityID()
*/
unsigned long m_nextSecurityID;
unsigned long m_nextReportID;
/**
* The member variable m_nextBudgetID keeps the number that will be
* assigned to the next budget object created. It is maintained by
* nextBudgetID()
*/
unsigned long m_nextBudgetID;
/**
* The member variable m_institutionList is the container for the
* institutions known within this file.
*/
MyMoneyMap<TQString, MyMoneyInstitution> m_institutionList;
/**
* The member variable m_accountList is the container for the accounts
* known within this file.
*/
MyMoneyMap<TQString, MyMoneyAccount> m_accountList;
/**
* The member variable m_balanceCache is the container for the
* accounts actual balance
*/
mutable TQMap<TQString, MyMoneyBalanceCacheItem> m_balanceCache;
/**
* This member keeps the date for which the m_balanceCache member
* is valid. In case the whole cache is invalid it is set to
* TQDate().
*/
mutable TQDate m_balanceCacheDate;
/**
* The member variable m_transactionList is the container for all
* transactions within this file.
* @see m_transactionKeys
*/
MyMoneyMap<TQString, MyMoneyTransaction> m_transactionList;
/**
* The member variable m_transactionKeys is used to convert
* transaction id's into the corresponding key used in m_transactionList.
* @see m_transactionList;
*/
MyMoneyMap<TQString, TQString> m_transactionKeys;
/**
* A list containing all the payees that have been used
*/
MyMoneyMap<TQString, MyMoneyPayee> m_payeeList;
/**
* A list containing all the scheduled transactions
*/
MyMoneyMap<TQString, MyMoneySchedule> m_scheduleList;
/**
* A list containing all the security information objects. Each object
* can represent a stock, bond, or mutual fund. It contains a price
* history that a user can add entries to. The price history will be used
* to determine the cost basis for sales, as well as the source of
* information for reports in a security account.
*/
MyMoneyMap<TQString, MyMoneySecurity> m_securitiesList;
/**
* A list containing all the currency information objects.
*/
MyMoneyMap<TQString, MyMoneySecurity> m_currencyList;
MyMoneyMap<TQString, MyMoneyReport> m_reportList;
/**
* A list containing all the budget information objects.
*/
MyMoneyMap<TQString, MyMoneyBudget> m_budgetList;
MyMoneyMap<MyMoneySecurityPair, MyMoneyPriceEntries> m_priceList;
/**
* This member signals if the file has been modified or not
*/
bool m_dirty;
/**
* This member variable keeps the creation date of this MyMoneySeqAccessMgr
* object. It is set during the constructor and can only be modified using
* the stream read operator.
*/
TQDate m_creationDate;
/**
* This member variable keeps the date of the last modification of
* the MyMoneySeqAccessMgr object.
*/
TQDate m_lastModificationDate;
/**
* This member variable contains the current fix level of application
* data files. (see kmymoneyview.cpp)
*/
unsigned int m_currentFixVersion;
/**
* This member variable contains the current fix level of the
* presently open data file. (see kmymoneyview.cpp)
*/
unsigned int m_fileFixVersion;
/**
* This method is used to get the next valid ID for a institution
* @return id for a institution
*/
TQString nextInstitutionID(void);
/**
* This method is used to get the next valid ID for an account
* @return id for an account
*/
TQString nextAccountID(void);
/**
* This method is used to get the next valid ID for a transaction
* @return id for a transaction
*/
TQString nextTransactionID(void);
/**
* This method is used to get the next valid ID for a payee
* @return id for a payee
*/
TQString nextPayeeID(void);
/**
* This method is used to get the next valid ID for a scheduled transaction
* @return id for a scheduled transaction
*/
TQString nextScheduleID(void);
/**
* This method is used to get the next valid ID for an security object.
* @return id for an security object
*/
TQString nextSecurityID(void);
TQString nextReportID(void);
/**
* This method is used to get the next valid ID for a budget object.
* @return id for an budget object
*/
TQString nextBudgetID(void);
/**
* 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
* @param sendNotification if true, notifications with the ids
* of all modified objects are send
*/
void reparentAccount(MyMoneyAccount &account, MyMoneyAccount& parent, const bool sendNotification);
/**
* This method will close a database and log the use roff
*/
void close(void) {}
/**
* This member variable is set when all transactions have been read from the database.
* This is would be probably the case when doing, for e.g., a full report,
* or after some types of transaction search which cannot be easily implemented in SQL
*/
bool m_transactionListFull;
};
#endif
|