Update DG #217
Merged
Update DG #217
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Kappaccinoh
reviewed
Apr 12, 2024
docs/DeveloperGuide.md
Outdated
| * Step 7. The `execute` method in `editCommand` also iterates through the `ObservableList<Appointments>` and retrieves all appointments that have the person to be edited, and calls the `setDoctorNric` or `setPatientNric` methods to update all relevant appointments related to the patient or doctor. | ||
| * Step 8. Success message gets printed onto the results display to notify user. | ||
|
|
||
| The sequence diagram below closely describes the interaction between the various components during the execution of the `DeleteCommand`. |
There was a problem hiding this comment.
change to editCommand
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Edit `Appointment` | ||
| Edits an `Appointment` entry by indicating their `Index`. | ||
| This command is implemented through the `EditAppointmentCommand` class which extend the `Command` class. |
docs/DeveloperGuide.md
Outdated
|
|
||
| <img src="images/EditAppointmentActivityDiagram.png" width="800" /> | ||
|
|
||
| * Step 4. The `parse` command in `editAppointmentCommandParser` return an instance of `editAppointmentCommand`. |
docs/DeveloperGuide.md
Outdated
| * Step 6. The `execute` method in `editAppointmentCommand` executes and calls `setAppointment` in model to set an updated appointment into the system. | ||
| * Step 7. Success message gets printed onto the results display to notify user. | ||
|
|
||
| The sequence diagram below closely describes the interaction between the various components during the execution of the `DeleteAppointmentCommand`. |
There was a problem hiding this comment.
EditAppointmentCommand
docs/DeveloperGuide.md
Outdated
| Alternative implementation for consideration | ||
| 1. Since both classes exhibit similarities in both code structure and behaviour, we might consider creating a generic class distinguished between `Person` and `Appointment` via enums to handle edits. | ||
| 2. This will centralise the behaviours, and reduce the amount of code needed to perform the edit function. | ||
| 3. A further extension is to do so with all other overlapping functionalities, such as `add` or `delete`, however we leave that possibility for future discussion and refinement. |
There was a problem hiding this comment.
indentation before 3.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.