Merge pull request #354 from mfjkri/update-dg-diagrams

Update sequence diagrams

docs/DeveloperGuide.md

@@ -141,10 +141,18 @@ The `Storage` component,
 Classes used by multiple components are in the `seedu.addressbook.commons` package.
 
 <div style="page-break-after: always;"></div>
+
 ## **Implementation**
 
 This section describes some noteworthy details on how certain features are implemented.
 
+<div markdown="span" class="alert alert-info">
+
+:information_source: **Note:**
+For simplicity, some details such as parsing (`parseIndex`, `parseName`, etc) have been omitted from the implementation details below.
+
+</div>
+
 ### Add tutor feature
 
 The "Add Tutor" feature allows users to add a new tutor to the address book. Below, we provide an example usage scenario and a detailed description of how the add tutor mechanism behaves at each step.

docs/diagrams/AddScheduleSequenceDiagram.puml

@@ -8,12 +8,11 @@ participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":AddSchedule\nCommandParser" as AddScheduleCommandParser LOGIC_COLOR
 participant "add-s:AddSchedule\nCommand" as AddScheduleCommand LOGIC_COLOR
 participant "result:CommandResult" as CommandResult LOGIC_COLOR
-
+participant "s:Schedule" as Schedule MODEL_COLOR
 end box
 
 box Model MODEL_COLOR_T1
 participant ":Model" as Model MODEL_COLOR
-participant "s:Schedule" as Schedule MODEL_COLOR
 end box
 [-> LogicManager : execute("add-s 1\nst/2023-09-15T09:00\n  et/2023-09-15T11:00")
 activate LogicManager
@@ -36,7 +35,7 @@ create AddScheduleCommand
 AddScheduleCommandParser -> AddScheduleCommand
 activate AddScheduleCommand
 
-AddScheduleCommand -> AddScheduleCommandParser
+AddScheduleCommand --> AddScheduleCommandParser :  add-s
 deactivate AddScheduleCommand
 
 
@@ -46,7 +45,7 @@ deactivate AddScheduleCommandParser
 AddScheduleCommandParser -[hidden]-> AddressBookParser
 destroy AddScheduleCommandParser
 
-AddressBookParser --> LogicManager
+AddressBookParser --> LogicManager : add-s
 deactivate AddressBookParser
 
 LogicManager -> AddScheduleCommand : execute()

docs/diagrams/AddTutorSequenceDiagram.puml

@@ -8,7 +8,7 @@ participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":AddTutorCommandParser" as AddTutorCommandParser LOGIC_COLOR
 participant "person:Person" as Person MODEL_COLOR
 participant "d:AddTutorCommand" as AddTutorCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
@@ -67,12 +67,12 @@ create CommandResult
 AddTutorCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> AddTutorCommand
+CommandResult --> AddTutorCommand : r
 deactivate CommandResult
 
-AddTutorCommand --> LogicManager : result
+AddTutorCommand --> LogicManager : r
 deactivate AddTutorCommand
 
-[<--LogicManager
+[<--LogicManager : r
 deactivate LogicManager
 @enduml

docs/diagrams/ChangeThemeSequenceDiagram.puml

@@ -2,15 +2,15 @@
 !include style.puml
 skinparam ArrowFontStyle plain
 box Ui UI_COLOR_T1
-participant ":MainWindow" as Ui UI_COLOR
+participant ":Ui" as Ui UI_COLOR
 end box
 
 box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":ThemeCommandParser" as ThemeCommandParser LOGIC_COLOR
 participant "c:ThemeCommand" as ThemeCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 [-> Ui :
@@ -55,13 +55,13 @@ create CommandResult
 ThemeCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> ThemeCommand : result
+CommandResult --> ThemeCommand : r
 deactivate CommandResult
 
-ThemeCommand --> LogicManager : result
+ThemeCommand --> LogicManager : r
 deactivate ThemeCommand
 
-LogicManager --> Ui : result
+LogicManager --> Ui : r
 deactivate LogicManager
 
 Ui -> Ui : handle\nChange\nTheme()

docs/diagrams/EditScheduleSequenceDiagram.puml

@@ -8,12 +8,12 @@ participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":EditSchedule\nCommandParser" as EditScheduleCommandParser LOGIC_COLOR
 participant "e:EditSchedule\nDescriptor" as EditScheduleDescriptor LOGIC_COLOR
 participant "d:EditSchedule\nCommand" as EditScheduleCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
+participant "s:Schedule" as EditedSchedule MODEL_COLOR
 end box
 
 box Model MODEL_COLOR_T1
 participant ":Model" as Model MODEL_COLOR
-participant "editedSchedule:Schedule" as EditedSchedule MODEL_COLOR
 end box
 
 [-> LogicManager : execute("edit-s 1\n st/2023-09-15T09:00")
@@ -58,28 +58,40 @@ deactivate AddressBookParser
 LogicManager -> EditScheduleCommand : execute()
 activate EditScheduleCommand
 
+EditScheduleCommand -> Model ++ : getFilteredPersonList()
+return
+
 create EditedSchedule
 EditScheduleCommand -> EditedSchedule ++
+return s
+EditScheduleCommand -> Model ++ : hasSchedule(s)
 return
-EditScheduleCommand -> Model ++ : hasSchedule(editedSchedule)
+
+EditScheduleCommand -> Model ++ : getAddressBook()
 return
-EditScheduleCommand -> Model ++ : setSchedule(scheduleToEdit, editedSchedule)
+
+loop number of schedules in model
+    EditScheduleCommand -> EditedSchedule : isClashing(s)
+    activate EditedSchedule
+    EditedSchedule --> EditScheduleCommand
+    deactivate EditedSchedule
+end
+
+EditScheduleCommand -> Model ++ : setSchedule(scheduleToEdit, s)
 return
 EditScheduleCommand -> Model ++ : updateFilteredScheduleList()
-deactivate Model
-
-deactivate Model
+return
 
 create CommandResult
 EditScheduleCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> EditScheduleCommand
+CommandResult --> EditScheduleCommand : r
 deactivate CommandResult
 
-EditScheduleCommand --> LogicManager : result
+EditScheduleCommand --> LogicManager : r
 deactivate EditScheduleCommand
 
-[<--LogicManager
+[<--LogicManager : r
 deactivate LogicManager
 @enduml

docs/diagrams/EditTutorSequenceDiagram.puml

@@ -7,12 +7,12 @@ participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":EditTutorCommandParser" as EditTutorCommandParser LOGIC_COLOR
 participant "d:EditTutorCommand" as EditTutorCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
+participant "e:Person" as EditedPerson MODEL_COLOR
 end box
 
 box Model MODEL_COLOR_T1
 participant ":Model" as Model MODEL_COLOR
-participant "e:Person" as EditedPerson MODEL_COLOR
 end box
 
 [-> LogicManager : execute("edit-t 1 n/New Name")
@@ -52,7 +52,7 @@ activate EditTutorCommand
 
 create EditedPerson
 EditTutorCommand -> EditedPerson ++
-return
+return e
 
 EditTutorCommand -> Model ++ : hasPerson(e)
 return
@@ -73,12 +73,12 @@ create CommandResult
 EditTutorCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> EditTutorCommand
+CommandResult --> EditTutorCommand : r
 deactivate CommandResult
 
-EditTutorCommand --> LogicManager : result
+EditTutorCommand --> LogicManager : r
 deactivate EditTutorCommand
 
-[<--LogicManager
+[<--LogicManager : r
 deactivate LogicManager
 @enduml

docs/diagrams/FindTutorSequenceDiagram.puml

@@ -8,7 +8,7 @@ participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":FindTutorCommandParser" as FindTutorCommandParser LOGIC_COLOR
 participant "e:NameContains\nKeywordsPredicate" as NameContainsKeywordsPredicate LOGIC_COLOR
 participant "d:FindTutor\nCommand" as FindTutorCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
@@ -66,12 +66,12 @@ create CommandResult
 FindTutorCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> FindTutorCommand
+CommandResult --> FindTutorCommand : r
 deactivate CommandResult
 
-FindTutorCommand --> LogicManager : result
+FindTutorCommand --> LogicManager : r
 deactivate FindTutorCommand
 
-[<--LogicManager
+[<--LogicManager : r
 deactivate LogicManager
 @enduml

docs/diagrams/MarkScheduleSequenceDiagram.puml

@@ -7,12 +7,12 @@ participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":MarkScheduleCommandParser" as MarkScheduleCommandParser LOGIC_COLOR
 participant "d:MarkScheduleCommand" as MarkScheduleCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
+participant "e:Schedule" as EditedSchedule MODEL_COLOR
 end box
 
 box Model MODEL_COLOR_T1
 participant ":Model" as Model MODEL_COLOR
-participant "edited:Schedule" as EditedSchedule MODEL_COLOR
 end box
 
 [-> LogicManager : execute("mark 1 m/1")
@@ -53,9 +53,9 @@ activate MarkScheduleCommand
 
 create EditedSchedule
 MarkScheduleCommand -> EditedSchedule ++
-return
+return e
 
-MarkScheduleCommand -> Model ++ : setSchedule(scheduleToEdit, editedSchedule)
+MarkScheduleCommand -> Model ++ : setSchedule(scheduleToEdit, e)
 return
 
 MarkScheduleCommand -> Model ++ : updateFilteredScheduleList()
@@ -67,12 +67,12 @@ create CommandResult
 MarkScheduleCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> MarkScheduleCommand
+CommandResult --> MarkScheduleCommand : r
 deactivate CommandResult
 
-MarkScheduleCommand --> LogicManager : result
+MarkScheduleCommand --> LogicManager : r
 deactivate MarkScheduleCommand
 
-[<--LogicManager
+[<--LogicManager: r
 deactivate LogicManager
 @enduml

docs/diagrams/ShowCalendarSequenceDiagram.puml

@@ -7,7 +7,7 @@ participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":ShowCalendarCommandParser" as ShowCalendarCommandParser LOGIC_COLOR
 participant "d:ShowCalendarCommand" as ShowCalendarCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
@@ -61,12 +61,12 @@ create CommandResult
 ShowCalendarCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> ShowCalendarCommand
+CommandResult --> ShowCalendarCommand : r
 deactivate CommandResult
 
-ShowCalendarCommand --> LogicManager : result
+ShowCalendarCommand --> LogicManager : r
 deactivate ShowCalendarCommand
 
-[<--LogicManager
+[<--LogicManager : r
 deactivate LogicManager
 @enduml

docs/diagrams/UnmarkScheduleSequenceDiagram.puml

@@ -7,12 +7,13 @@ participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":UnmarkScheduleCommandParser" as UnmarkScheduleCommandParser LOGIC_COLOR
 participant "d:UnmarkScheduleCommand" as UnmarkScheduleCommand LOGIC_COLOR
-participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
+participant "e:Schedule" as EditedSchedule MODEL_COLOR
+
 end box
 
 box Model MODEL_COLOR_T1
 participant ":Model" as Model MODEL_COLOR
-participant "edited:Schedule" as EditedSchedule MODEL_COLOR
 end box
 
 [-> LogicManager : execute("unmark 1")
@@ -52,24 +53,22 @@ activate UnmarkScheduleCommand
 
 create EditedSchedule
 UnmarkScheduleCommand -> EditedSchedule ++
-return
-UnmarkScheduleCommand -> Model ++ : setSchedule(scheduleToEdit, edited)
+return e
+UnmarkScheduleCommand -> Model ++ : setSchedule(scheduleToEdit, e)
 return
 UnmarkScheduleCommand -> Model ++ : updateFilteredScheduleList()
-deactivate Model
-
-deactivate Model
+return
 
 create CommandResult
 UnmarkScheduleCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> UnmarkScheduleCommand
+CommandResult --> UnmarkScheduleCommand: r
 deactivate CommandResult
 
-UnmarkScheduleCommand --> LogicManager : result
+UnmarkScheduleCommand --> LogicManager : r
 deactivate UnmarkScheduleCommand
 
-[<--LogicManager
+[<--LogicManager: r
 deactivate LogicManager
 @enduml