You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/DeveloperGuide.md
+3-12Lines changed: 3 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -254,8 +254,8 @@ The sequence diagram below demonstrates the command execution steps for `execute
254
254
This is the sequence of command execution for `execute` in `AddPatientCommand`, however `AddDoctorCommand` and `AddAppointmentCommand` follow similar design patterns within the execute command.
255
255
Add command execution sequence:
256
256
* Step 1. The `execute` method of the `AddPatientCommand` is called.
257
-
* Step 2. The method calls the `hasPerson` method of `Model` to check if there are any duplicate patients and throws an exception if there is.
258
-
* If there is a duplicate person, the method calls the `log` method of `logger` to log the incident.
257
+
* Step 2. The method calls the `hasPerson` method of `Model` to check if there are any duplicate patients.
258
+
* If there is a duplicate person, the method throws `CommandException` and calls the `log` method of `logger` to log the incident.
259
259
* Step 3. The `addPerson` method of `Model` is then called and the control is passed back to the `execute` method.
260
260
* Step 4. The `log` method of `logger` is then called to log the successful command execution.
261
261
* Step 5. A new `CommandResult` object with the success message is then created and returned by `execute`.
@@ -313,7 +313,7 @@ This command is implemented through the `DeleteCommand` class which extends the
313
313
314
314
* Step 1. The `execute` method of the `DeleteCommand` is called.
315
315
* Step 2. The `getFilteredPersonList` method of `Model` is called and finds its length.
316
-
* Step 3. The `getZeroBased` method of `Index` is called to convert the provided index to its zero-based equivilent.
316
+
* Step 3. The `getZeroBased` method of `Index` is called to convert the provided index to its zero-based equivalent.
317
317
* Step 4. The provided index is checked against the length of the current list of people.
318
318
* If the provided index is out of bounds, a `CommandException` is thrown.
319
319
* Step 4. The `deletePerson` method of `Model` is called to remove the designated person from the list of people.
@@ -334,7 +334,6 @@ Why is this implemented this way?
334
334
6. This results in a cleaner `Appointments` panel, and saves the user from the hassle of needing to delete unwanted `Appointment` entries one by one.
335
335
336
336
337
-
338
337
### Add a `Appointment`
339
338
340
339
Adds a new `Appointment` entry by indicating the `patientNric`, `doctorNric`, and an `appointmentDateTime`.
@@ -578,14 +577,6 @@ The following activity diagram summarizes what happens when a user executes a ne
578
577
* Cons: We must ensure that the implementation of each individual command are correct.
579
578
580
579
581
-
_{more aspects and alternatives to be added}_
582
-
583
-
584
-
### \[Proposed\] Data archiving
585
-
586
-
587
-
_{Explain here how the data archiving feature will be implemented}_
588
-
589
580
## Planned Enhancements
590
581
591
582
The MediCLI development team (consisting of 5 members) acknowledges the presense of known feature flaws in our system.
0 commit comments