Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct reference from person to contact #205

Merged
merged 4 commits into from
Nov 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ title: Developer Guide
---
## **Developer Guide Information**

### **Purpose**
### Purpose

This developer guide aims to provide information regarding the design and implementation of Siasa, including the design considerations when implementing each feature.

### **Target Audience**
### Target Audience

This developer guide is made for Java developers who are or were formerly **student financial advisors**, the target audience of Siasa. Thus, it is assumed that readers have basic background knowledge on Java and is familiar with common terms used in insurance policies.

### **Acknowledgements**
### Acknowledgements

- This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

Expand Down Expand Up @@ -55,7 +55,7 @@ The rest of the App consists of four components.

**How the architecture components interact with each other**

The _Sequence Diagram_ below shows how the components interact with each other for the scenario where the user issues the command `delete 1`.
The _Sequence Diagram_ below shows how the components interact with each other for the scenario where the user issues the command `deletecontact 1`.

<img src="images/ArchitectureSequenceDiagram.png" width="574" />

Expand Down Expand Up @@ -127,13 +127,12 @@ The `Model` component,
- stores the SIASA data i.e., all `Contact` and `Policy` objects (which are contained in a `UniqueContactList` and
`UniquePolicyList `object respectively).
- stores the currently 'selected' `Contact` and `Policy` objects (e.g., results of a search query) in a separate filtered_list each
which is exposed to outsiders as an unmodifiable `ObservableList<Person>` that can be 'observed'
which is exposed to outsiders as an unmodifiable `ObservableList<Contact>` that can be 'observed'
e.g. the UI can be bound to this list so that the UI automatically updates when the data in the lists change.
- stores a `UserPref` object that represents the user’s preferences. This is exposed to the outside as a `ReadOnlyUserPref` objects.
- does not depend on any of the other three components
(as the `Model` represents data entities of the domain, they should make sense on their own without depending on other components)


### Storage component

**API** : [`Storage.java`](https://github.com/AY2122S1-CS2103-F10-4/tp/blob/2d1b8809aa8b78086507f8e2a5d48bc05a385e01/src/main/java/seedu/siasa/storage/Storage.java)
Expand Down Expand Up @@ -427,7 +426,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

(For all use cases below, the **System** is the `SIASA` and the **Actor** is the `user`, unless specified otherwise)

#### **UC1: Displaying Help**
#### UC1: Displaying Help

**MSS**

Expand All @@ -436,7 +435,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

#### **UC2: Add a Contact/Policy**
#### UC2: Add a Contact/Policy

**MSS**

Expand All @@ -455,7 +454,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

- *a. User can request to view help at any time [(UC1)](#uc1-displaying-help).

#### **UC3: Edit a Contact/Policy**
#### UC3: Edit a Contact/Policy

**MSS**

Expand All @@ -480,7 +479,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

- *a. User can request to view help at any time [(UC1)](#uc1-displaying-help).

#### **UC4: Delete a Contact/Policy**
#### UC4: Delete a Contact/Policy

**MSS**

Expand All @@ -505,7 +504,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

- *a. User can request to view help at any time [(UC1)](#uc1-displaying-help).

#### **UC5: List a Contact's Policies**
#### UC5: List a Contact's Policies

**MSS**

Expand All @@ -530,7 +529,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

- *a. User can request to view help at any time [(UC1)](#uc1-displaying-help).

#### **UC6: Clear a Contact's Policies**
#### UC6: Clear a Contact's Policies

**MSS**

Expand All @@ -555,7 +554,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

- *a. User can request to view help at any time [(UC1)](#uc1-displaying-help).

#### **UC7: Sort Contact/Policy List**
#### UC7: Sort Contact/Policy List

**MSS**

Expand All @@ -580,7 +579,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

- *a. User can request to view help at any time [(UC1)](#uc1-displaying-help).

#### **UC8: Download Statistics**
#### UC8: Download Statistics

**MSS**

Expand Down
8 changes: 4 additions & 4 deletions docs/diagrams/ArchitectureSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ Participant ":Logic" as logic LOGIC_COLOR
Participant ":Model" as model MODEL_COLOR
Participant ":Storage" as storage STORAGE_COLOR

user -[USER_COLOR]> ui : "delete 1"
user -[USER_COLOR]> ui : "deletecontact 1"
activate ui UI_COLOR

ui -[UI_COLOR]> logic : execute("delete 1")
ui -[UI_COLOR]> logic : execute("deletecontact 1")
activate logic LOGIC_COLOR

logic -[LOGIC_COLOR]> model : deletePerson(p)
logic -[LOGIC_COLOR]> model : deleteContact(p)
activate model MODEL_COLOR

model -[MODEL_COLOR]-> logic
deactivate model

logic -[LOGIC_COLOR]> storage : saveAddressBook(addressBook)
logic -[LOGIC_COLOR]> storage : saveSiasa(siasa)
activate storage STORAGE_COLOR

storage -[STORAGE_COLOR]> storage : Save to file
Expand Down
Binary file modified docs/images/ArchitectureSequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.