-
Notifications
You must be signed in to change notification settings - Fork 840
/
AccountDAO.java
83 lines (72 loc) · 2.86 KB
/
AccountDAO.java
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
/*
* Copyright 2015 Department of Computer Science and Engineering, University of Moratuwa.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package lk.ac.mrt.cse.dbs.simpleexpensemanager.data;
import java.util.List;
import lk.ac.mrt.cse.dbs.simpleexpensemanager.data.exception.InvalidAccountException;
import lk.ac.mrt.cse.dbs.simpleexpensemanager.data.model.Account;
import lk.ac.mrt.cse.dbs.simpleexpensemanager.data.model.ExpenseType;
/**
* AccountDAO interface can be used to access the account details, including listing, adding, updating, removing
* accounts and updating account balance.
*/
public interface AccountDAO {
/***
* Get a list of account numbers.
*
* @return - list of account numbers as String
*/
public List<String> getAccountNumbersList();
/***
* Get a list of accounts.
*
* @return - list of Account objects.
*/
public List<Account> getAccountsList();
/***
* Get the account given the account number.
*
* @param accountNo as String
* @return - the corresponding Account
* @throws InvalidAccountException - if the account number is invalid
*/
public Account getAccount(String accountNo) throws InvalidAccountException;
/***
* Add an account to the accounts collection.
*
* @param account - the account to be added.
*/
public void addAccount(Account account);
/***
* Remove an account from the accounts collection.
*
* @param accountNo - of the account to be removed.
* @throws InvalidAccountException - if the account number is invalid
*/
public void removeAccount(String accountNo) throws InvalidAccountException;
/***
* Update the balance of the given account. The type of the expense is specified in order to determine which
* action to be performed.
* <p/>
* The implementation has the flexibility to figure out how the updating operation is committed based on the type
* of the transaction.
*
* @param accountNo - account number of the respective account
* @param expenseType - the type of the transaction
* @param amount - amount involved
* @throws InvalidAccountException - if the account number is invalid
*/
public void updateBalance(String accountNo, ExpenseType expenseType, double amount) throws InvalidAccountException;
}