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

Updated ViewPolicy diagrams in DG #232

Merged
merged 2 commits into from
Nov 12, 2023
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
8 changes: 5 additions & 3 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,8 +246,6 @@ The following activity diagram shows how the AddTag operation works:
The following sequence diagram shows how the AddTag operation works:
<img src="diagrams/AddTagSequenceDiagram.png">

The


### DeleteTag feature

Expand Down Expand Up @@ -412,7 +410,11 @@ Given below is an example usage scenario and how the View Policy mechanism behav
5. The `CommandResult` is then returned by the `execute` method with the `toString()` of the `policy` indexed from the previous step
6. The UI will display the details of the policy specified by the index and a success message is displayed on the UI

The following activity diagram for viewing policy of a particular Client:
<img src="diagrams/ViewPolicyActivityDiagram.png" width="450" />

The following sequence diagram shows how the View Policy operation works:
<img src="diagrams/ViewPolicySequenceDiagram.png" width="450" />

### Filter Policy Description feature

Expand All @@ -432,7 +434,7 @@ Given below is an example usage scenario and how the Filter Policy mechanism beh
8. This object will then be passed to `Logic`.
9. The execution will then be over as the updated list of filtered `Person` objects are displayed on the Ui

The following sequence diagram shows how the Filter Policy Description operation works:
The following activity diagram shows how the Filter Policy Description operation works:
<img src="diagrams/FilterPolicyActivityDiagram.png" width="450" />

### Toggle Mode feature
Expand Down
Binary file added docs/diagrams/ViewPolicyActivityDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/diagrams/ViewPolicyActivityDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
@startuml
skin rose
skinparam ActivityFontSize 15
skinparam ArrowFontSize 12
start
:User executes ViewPolicyCommand;

'Since the beta syntax does not support placing the condition outside the
'diamond we place it as the true branch instead.

if () then ([user keys in valid command format])
:Displays information about policy the user wants to view;
else ([else])
:Display invalid command format error;
stop
endif
:Display success message;
stop
@enduml
Binary file added docs/diagrams/ViewPolicySequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
77 changes: 77 additions & 0 deletions docs/diagrams/ViewPolicySequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
@startuml
!include style.puml
skinparam ArrowFontStyle plain

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant ":ViewPolicyCommandParser" as ViewPolicyCommandParser LOGIC_COLOR
participant "v:ViewPolicyCommand" as ViewPolicyCommand LOGIC_COLOR
participant ":CommandResult" as CommandResult LOGIC_COLOR
end box

box Model MODEL_COLOR_T1
participant ":Model" as Model MODEL_COLOR
end box

[-> LogicManager : execute("viewPolicy 1 1")
activate LogicManager

LogicManager -> AddressBookParser : parseCommand("viewPolicy 1 1")
activate AddressBookParser

create ViewPolicyCommandParser
AddressBookParser -> ViewPolicyCommandParser
activate ViewPolicyCommandParser

ViewPolicyCommandParser --> AddressBookParser
deactivate ViewPolicyCommandParser

AddressBookParser -> ViewPolicyCommandParser : parse("1 1")
activate ViewPolicyCommandParser

create ViewPolicyCommand
ViewPolicyCommandParser -> ViewPolicyCommand
activate ViewPolicyCommand

ViewPolicyCommand --> ViewPolicyCommandParser : v
deactivate ViewPolicyCommand

ViewPolicyCommandParser --> AddressBookParser : v
deactivate ViewPolicyCommandParser
'Hidden arrow to position the destroy marker below the end of the activation bar.
ViewPolicyCommandParser -[hidden]-> AddressBookParser
destroy ViewPolicyCommandParser

AddressBookParser --> LogicManager : v
deactivate AddressBookParser

LogicManager -> ViewPolicyCommand : execute(model)
activate ViewPolicyCommand

ViewPolicyCommand -> Model : get(1)
activate Model

Model --> ViewPolicyCommand
deactivate Model

ViewPolicyCommand -> Model : getPolicies()
activate Model

Model --> ViewPolicyCommand
deactivate Model


create CommandResult
ViewPolicyCommand -> CommandResult
activate CommandResult

CommandResult --> ViewPolicyCommand
deactivate CommandResult

ViewPolicyCommand --> LogicManager : result
deactivate ViewPolicyCommand

[<--LogicManager
deactivate LogicManager
@enduml
6 changes: 3 additions & 3 deletions docs/team/aarontxz.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

### Project: Insurahub

Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers CLI over GUI to use the app.
The application is mainly used by financial advisors in their day to day planning and scheduling of meetings with clients,
Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers to use CLI over GUI to use the app.
The application is mainly used by financial advisors in their day-to-day planning and scheduling of meetings with clients,
assisting them by providing quick access to important information of each client stored in the database, displayed on the UI of InsuraHub.

While Insurahub have limited functionalities at this stage, there are further plans to improve the application with the timeline being set in place.
While Insurahub has limited functionalities at this stage, there are further plans to improve the application with the timeline being set in place.

Given below are my contributions to the project.

Expand Down
46 changes: 0 additions & 46 deletions docs/team/johndoe.md

This file was deleted.

6 changes: 5 additions & 1 deletion docs/team/johnnythesnake12.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@

### Project: Insurahub

Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers CLI over GUI to use the app.
Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers to use CLI over GUI to use the app.
The application is mainly used by financial advisors in their day-to-day planning and scheduling of meetings with clients,
assisting them by providing quick access to important information of each client stored in the database, displayed on the UI of InsuraHub.

While Insurahub has limited functionalities at this stage, there are further plans to improve the application with the timeline being set in place.

Given below are my contributions to the project.

Expand Down
6 changes: 4 additions & 2 deletions docs/team/luahjunyang.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@

### Project: Insurahub

Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers CLI over GUI to use the app.
The application is mainly used by financial advisors in their day to day planning and scheduling of meetings with clients,
Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers to use CLI over GUI to use the app.
The application is mainly used by financial advisors in their day-to-day planning and scheduling of meetings with clients,
assisting them by providing quick access to important information of each client stored in the database, displayed on the UI of InsuraHub.

While Insurahub has limited functionalities at this stage, there are further plans to improve the application with the timeline being set in place.

Given below are my contributions to the project.

- **New Feature**: Added the ability to addTags to clients.
Expand Down
6 changes: 4 additions & 2 deletions docs/team/zhanyang01.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@

### Project: Insurahub

Insurahub - Insurahub is a desktop app for managing clients, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Insurahub can get your contact management tasks done faster than traditional GUI apps. This app is mainly used by insurance agents who have many clients and tasks such as appointments to keep track of on a daily basis.
Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers to use CLI over GUI to use the app.
The application is mainly used by financial advisors in their day-to-day planning and scheduling of meetings with clients,
assisting them by providing quick access to important information of each client stored in the database, displayed on the UI of InsuraHub.

While Insurahub have limited functionalities at this stage, there are further plans to improve the application with the timeline being set in place.
While Insurahub has limited functionalities at this stage, there are further plans to improve the application with the timeline being set in place.

Given below are my contributions to the project.

Expand Down
Loading