Yang Hui Ting - Project Portfolio

You can easily adds cards to the application.

Let’s say that you have just gotten a fresh new credit card from the bank and you want to add it into your cards list.

You can type in the command.

Format: add d/DESCRIPTION c/CARDNUMBER v/CVC e/EXPIRY [t/TAG]

Example: add d/VisaPOSB c/5203123458392748 v/456 e/12/25 t/groceries

The result box will display the message as shown. You can see that your card has been successfully added into the list.

If you already have a card in mind and want to view its details, you can easily do so by entering the card description and its CVC. You can also obtain the same result by using a card’s index in the list with the correct CVC.

Format: read d/DESCRIPTION v/CVC OR read INDEX v/CVC

Example: read d/VisaPOSB v/456 OR read 1 v/456

Type in the command.

The result box will display the message as shown. You can see a new panel that contains your desired credit card details appearing at the side.

You can copy a specific card’s card number to your clipboard as well.

You can choose to copy the card number using its description. Alternatively, you can also perform the command with the card’s index in the list:

Format: copy d/DESCRIPTION v/CVC OR copy INDEX v/CVC

Example: copy d/VisaPOSB v/456 OR copy 1 v/456

Type in the command.

The result box will display the message as shown.

Upon pasting from your clipboard, the card number of your desired card should appear.

If your card has expired, you can easily remove it from the application.

Again, you could do this by the card’s description or by its index:

Format: delete DESCRIPTION OR delete INDEX

Example: delete VisaPOSB OR delete 1

Type in the command.

The result box will display the message as shown.

You can see that your card is no longer visible from the list.

When a user tries to add a card, there are various checks to ensure that the expiry entered is valid. As the name suggests, expiry validations are implemented within Expiry. Additionally, it implements the following operations:

ExpiryDate#isValidExpiryDate(String test) is implemented using ExpiryUtil#getMonthToExp(String expiry) to ensure that the number of months left is positive.

The other operations are used in ParserUtil#parseExpiryDate(String expiryDate) to ensure that user input passes these validations, before allowing the card to be added to the list. Upon startup of the app, the repopulation of data also checks against these validations to ensure that there are no illegal values stored in the list.

Given below is an example usage scenario and how the validations behave at each step. The following sequence diagram shows how the expiry validations work.

Step 1. The user executes add d/VisaPOSB v/4291728395018293 c/256 e/12/15 command to add a new card named 'VisaPOSB' in the card book. The CardBookParser#parseCommand(String userInput) calls AddCardCommandParser#parse(String args) and the command parser tries to breakdown the string in to various parameters.

Step 2. The AddCardCommandParser calls ParserUtil#parseExpiryDate(String expiryDate), which first calls ExpiryDate#isValidDate(String test) to check its validity, which returns true.

Step 3. The ParserUtil#parseExpiryDate(String expiry) then calls ExpiryDate#isValidExpiryDate(String test), which calls ExpiryUtil#getMonthToExp(String expiry). However, -47 is returned and the condition in ExpiryDate#isValidExpiryDate returns false.

Step 4. A ParseException is thrown from ParserUtil#parseExpiryDate(String expiryDate) and the error message is shown on the result box.

The expiry notification is facilitated by ExpiryDisplay. It exists as an attribute within MainWindow and obtains the required expiring cards list from LogicManager. This is internally stored as expiringCards. Additionally, it implements the following operations:

The following sequence diagram shows how the expiry notification shows up.

Step 1. The user opens the app and a new MainWindow is created. The logic in MainWindow` calls LogicManager#getExpiringCardList() to obtain a list of expiring cards.

Step 2. MainWindow creates a new instance of ExpiryDisplay using the list of expiring cards.

Step 3. The UiManager calls MainWindow#handleExpiry(), and the MainWindow checks if there are expiring cards with ExpiryDisplay#hasCards().

Step 4. The call returns true and MainWindow checks if the notification is showing with the call ExpiryDisplay#isShowing().

Step 5. This call returns false and MainWindow does a final call ExpiryDisplay#show() to render the expiry notification.

The reason why we chose alternative 1: It is much easier to code, and it is less susceptible to unforeseen circumstances such as a card having both expiring and expired tags.

The reason why we chose alternative 1: The main purpose of notifications is to remind users to take action and users can subsequently delete the card so that the notification stops appearing.