Merge pull request #215 from totoyoyo/dg-more-usecases

Dg more usecases

Author: totoyoyo

docs/DeveloperGuide.md

@@ -20,13 +20,13 @@ targeted towards users with a daily 7am - 4pm schedule, have frequent meetings d
 
 --------------------------------------------------------------------------------------------------------------------
 
-## **Setting up, getting started**
+## Setting up, getting started
 
 Refer to the guide [_Setting up and getting started_](SettingUp.md).
 
 --------------------------------------------------------------------------------------------------------------------
 
-## **Design**
+## Design
 
 ### Architecture
 
@@ -159,7 +159,7 @@ Classes used by multiple components are in the `seedu.addressbook.commons` packa
 
 --------------------------------------------------------------------------------------------------------------------
 
-## **Implementation**
+## Implementation
 
 This section describes some noteworthy details on how certain features are implemented.
 
@@ -394,7 +394,7 @@ Reason for choosing Alternative 1: Due to the time constraint of this project, o
 
 --------------------------------------------------------------------------------------------------------------------
 
-## **Documentation, logging, testing, configuration, dev-ops**
+## Documentation, logging, testing, configuration, dev-ops
 
 * [Documentation guide](Documentation.md)
 * [Testing guide](Testing.md)
@@ -404,15 +404,15 @@ Reason for choosing Alternative 1: Due to the time constraint of this project, o
 
 --------------------------------------------------------------------------------------------------------------------
 
-## **Appendix: Requirements**
+## Appendix: Requirements
 
 ### Product scope
 
 **Target user profile**:
 
 * Any user who like typing, and is most of the week spent moving about meeting people for his internship, lectures, or social life, have busy schedules
  from 7 am - 4pm. 
-* Has a lot of contacts and meeting alot of people out for events.
+* Has a lot of contacts and meeting many people out for events.
 * Is more visual and would like to see the meetings on a timetable, and see when he is free. 
 Is probably relatively young, and has friends with online gravatar profiles. 
 * Would like to keep track of contacts and organise them as well for 
@@ -441,14 +441,14 @@ Users would be better able to manage their social and academic commitments by to
 | medium   | person trying to back up data  | store information in a file       | I can clear and move my data to a different machine         |
 | medium   | student with a lot of groups | assign contacts to groups         | I can organise my contacts into the groups                  |
 | high     | user                           | close the app                     | I can clear up my memory and store the data into text files |
-| high     | student                        | add meetings                      | I can keep track of my meetings                             |
-| medium   | student                        | look up meeting by time           | I can tell if I'm busy during a time                        |
-| medium   | student                        | sort contacts                     | I can organize the contact list in a convenient way         |
-| medium   | student                        | sort meetings                     | I can organize the meeting list in a convenient way         |
-| high     | student                        | view all contacts                 | I can see all the contacts I added                          |
-| high     | student                        | view all meetings                 | I can see all the meetings I added                          |
-| high     | student                        | delete meetings                   | I can remove the meetings that already happened             |
-| high     | student                        | delete contacts                   | I can remove the unimportant contacts                       |
+| high     | user                        | add meetings                      | I can keep track of my meetings                             |
+| medium   | user                        | look up meeting by time           | I can tell if I'm busy during a time                        |
+| medium   | user                        | sort contacts                     | I can organize the contact list in a convenient way         |
+| medium   | user                        | sort meetings                     | I can organize the meeting list in a convenient way         |
+| high     | user                        | view all contacts                 | I can see all the contacts I added                          |
+| high     | user                        | view all meetings                 | I can see all the meetings I added                          |
+| high     | user                        | delete meetings                   | I can remove the meetings that already happened             |
+| high     | user                        | delete contacts                   | I can remove the unimportant contacts                       |
 
 ## Appendix: Use cases
 
@@ -462,9 +462,7 @@ Users would be better able to manage their social and academic commitments by to
 2.  MeetBuddy shows a list of persons
 3.  User requests to delete a specific person in the list
 4.  MeetBuddy deletes the person
-
-
-    Use case ends.
+    Use case ends
 
 **Extensions**
 
@@ -486,8 +484,7 @@ Users would be better able to manage their social and academic commitments by to
 1.  User requests to add a meeting with priority
 2.  MeetBuddy shows the list of meetings after adding.
 
-
-    Use case ends.
+    Use case ends
 
 **Extensions**
 
@@ -509,6 +506,83 @@ New features on V1.2
 7.  Sort contacts by (priorities/personName/groups)
 8.  Last meetup date for each contact
 
+**Use case: Sort contact list**
+
+**MSS**
+
+1.  User requests to sort the contact list
+2.  MeetBuddy updates the contact list following the sorting criterion.
+
+    Use case ends.
+
+**Extensions**
+
+* 1a. The sort parameters are invalid
+
+    * 1a1. MeetBuddy shows an error message.
+
+  Use case ends.
+
+**Use case: Unsort contact list**
+
+**MSS**
+
+1.  User requests to unsort the contact list
+2.  MeetBuddy updates the contact list to the original state without sorting.
+    
+    Use case ends.
+
+
+
+**Use case: Sort meeting list**
+
+**MSS**
+
+1.  User requests to sort the meeting list
+2.  MeetBuddy updates the meeting list following the sorting criterion.
+
+    Use case ends.
+
+**Extensions**
+
+* 1a. The sort parameters are invalid
+
+    * 1a1. MeetBuddy shows an error message.
+
+  Use case ends.
+
+**Use case: Unsort contact list**
+
+**MSS**
+
+1.  User requests to unsort the meeting list
+2.  MeetBuddy updates the meeting list to the original state without sorting.
+
+    Use case ends.
+
+**Use case: Find meeting**
+
+**MSS**
+
+1.  User searches for a meeting with some criteria.
+2.  MeetBuddy updates the meeting list following the criteria.
+
+    Use case ends.
+
+**Extensions**
+
+* 1a. The search parameters are invalid
+
+    * 1a1. MeetBuddy shows an error message.
+    
+  Use case ends.
+
+* 2a. No meeting is found.
+    * 2a1. MeetBuddy shows an empty meeting list.
+  
+    Use case ends.
+
+
 ## Appendix: Non-Functional Requirements
 
 1.  Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
@@ -533,7 +607,7 @@ especially by adding the event into the app.
 --------------------------------------------------------------------------------------------------------------------
 
 
-## **Appendix: Instructions for manual testing**
+## Appendix: Instructions for manual testing
 
 Given below are instructions to test the app manually.
 

docs/UserGuide.md

@@ -30,9 +30,9 @@ their profile pictures.
 
    * **`listp`** : Lists all contacts.
 
-   * **`add`**`n/John Doe ph/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to MeetBuddy.
+   * **`addp`**`n/John Doe ph/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to MeetBuddy.
 
-   * **`delete`**`3` : Deletes the 3rd contact shown in the current list.
+   * **`deletep`**`3` : Deletes the 3rd contact shown in the current list.
 
    * **`exit`** : Exits the app.
 
@@ -122,7 +122,7 @@ If your changes to the data file makes its format invalid, MeetBuddy will discar
 
 Adds a person to MeetBuddy.
 
-Format: `add n/NAME ph/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GROUP]…​`
+Format: `addp n/NAME [ph/PHONE] [e/EMAIL] [a/ADDRESS] [g/GROUP]...​`
 
 <div markdown="span" class="alert alert-primary">:bulb: **Tip:**
 A person can have any number of groups (including 0)
@@ -132,8 +132,8 @@ In MeetBuddy we assume that all the persons in the contact list have different n
 </div>
 
 Examples:
-* `add n/John Doe ph/98765432 e/johnd@example.com a/John street, block 123, #01-01`
-* `add n/Betsy Crowe g/CS2103 e/betsycrowe@example.com a/Newgate Prison ph/1234567 g/badminton`
+* `addp n/John Doe ph/98765432 e/johnd@example.com a/John street, block 123, #01-01`
+* `addp n/Betsy Crowe g/CS2103 e/betsycrowe@example.com a/Newgate Prison ph/1234567 g/badminton`
 
 ### Listing all persons : `listp`
 
@@ -215,9 +215,11 @@ Format: `sortp by/FIELD d/DIRECTION`
     * Sort by email : `EMAIL`
     * Sort by phone number : `PHONE`
     * Sort by address : `ADDRESS`
+    * These are all case-insensitive
 * `DIRECTION` is only restricted to the following cases:
     * Sort by ascending alphabetical order : `ASC`
     * Sort by descending alphabetical order : `DESC`
+    * These are all case-insensitive
 
 Examples:
 * `sortp by/NAME d/ASC` sorts the persons by name and present the result in ascending alphabetical order.
@@ -282,13 +284,17 @@ Examples:
 
 ### Locating meetings: `findm`
 
-Finds meetings whose information contain any of the given keywords.
+Finds meetings that satisfy all the given criteria.
 
-Format: `findm [n/NAME] [time/TIME] [desc/DESCRIPTION] [pr/PRIORITY] [g/GROUP]...[p/INDEX OF PERSON RELATED]...`
+Format: `findm [n/NAME] [time/TIME]... [desc/DESCRIPTION] [pr/PRIORITY] [g/GROUP]... [p/INDEX OF PERSON RELATED]...`
 
+* Though all fields are optional, we require the user to enter at least one.
 * The search is case-sensitive in name searching. e.g `CS2103` will not match `cs2103`
 * The order of the searching filed does not matter. e.g. `findm n/CS pr/3` will be the same as `findm pr/3 n/CS`.
-* Time field refers to a point of time, as long as this point of time is in between of a meeting's start time and ending time, the search will return this specific meeting.
+* Time field refers to a point of time, as long as this point of time is 
+  in between of a meeting's start time and ending time (inclusive), 
+  the search will return this specific meeting.
+* The user can enter many times. The meetings will have to satisfy all of them.
 * Time field must follow YYYY-MM-DD HH:MM format.
 * For other fields, the requirement is the same as addm (Adding a meeting). You can refer to the previous UG instruction.
 
@@ -309,7 +315,6 @@ Format: `showm INDEX`
 
 ### Sorting of meetings : `sortm`
 
-
 Sorts the meetings displayed according to a specified field.
 
 Format: `sortm by/FIELD d/DIRECTION`
@@ -321,9 +326,11 @@ Format: `sortm by/FIELD d/DIRECTION`
     * Sort by end time : `END`
     * Sort by priority : `PRIORITY`
     * Sort by description : `DESCRIPTION`
+    * These are all case-insensitive
 * `DIRECTION` is only restricted to the following cases:
     * Sort by ascending order : `ASC`
     * Sort by descending order : `DESC`
+    * These are all case-insensitive
 Examples:    
 * `sortm by/PRIORITY d/ASC` sorts the meetings by priority and present the result in ascending order.
 
@@ -423,13 +430,13 @@ Examples:
 
 Action | Format, Examples
 --------|------------------
-**Add** | `addp n/NAME ph/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GROUP]…​` <br> e.g., `addp n/James Ho ph/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 g/CS2106 g/badminton` <br> <br> `addm n/NAME st/START TIME ed/END TIME desc/DESCRIPTION pr/PRIORITY [g/GROUP]...[p/INDEX OF PERSON RELATED]...​` <br> e.g., `addm n/CS2103 Lecture st/2021-03-12 14:00 ed/2021-03-12 16:00 desc/Week 7 pr/3 g/lectures g/SoC p/1 p/2`
+**Add** | `addp n/NAME [ph/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/GROUP]…​` <br> e.g., `addp n/James Ho ph/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 g/CS2106 g/badminton` <br> <br> `addm n/NAME st/TIME ed/TIME [desc/DESCRIPTIONS] [pr/PRIORITY] [p/PERSON RELATED INDEX]… [g/GROUP]…​` <br> e.g., `addm n/CS2103 Lecture st/2021-03-12 14:00 ed/2021-03-12 16:00 desc/Week 7 pr/3 g/lectures g/SoC p/1 p/2`
 **Delete** | `deletep INDEX`<br> e.g., `deletep 3` <br> <br> `deletem INDEX`<br> e.g., `deletem 3`
 **Edit** | `editp INDEX [n/NAME] [ph/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/GROUP]…​`<br> e.g.,`editp 2 n/James Lee e/jameslee@example.com` <br> <br> `editm INDEX [n/NAME] [st/START TIME] [ed/END TIME] [desc/DESCRIPTION] [pr/PRIORITY] [p/PERSON RELATED INDEX] [g/GROUP]...​`<br> e.g.,`editm 2 n/CS2103 Lecture`
-**Find** | `findp KEYWORD [MORE_KEYWORDS]`<br> e.g., `findp James Jake` <br> <br> `findpg KEYWORD [MORE_KEYWORDS]`<br> e.g., `findpg badminton` <br>  <br> `findm [n/NAME] [time/TIME] [desc/DESCRIPTION] [pr/PRIORITY] [g/GROUP]...[p/INDEX OF PERSON RELATED]...`<br> e.g., `findm n/CS pr/3` <br>
+**Find** | `findp KEYWORD [MORE_KEYWORDS]`<br> e.g., `findp James Jake` <br> <br> `findpg KEYWORD [MORE_KEYWORDS]`<br> e.g., `findpg badminton` <br>  <br> `findm [n/NAME] [time/TIME]... [desc/DESCRIPTION] [pr/PRIORITY] [g/GROUP]... [p/INDEX OF PERSON RELATED]...`<br> e.g., `findm n/CS pr/3` <br>
 **List** | `list`, `listm`, `listp`
 **Sort** | `sortp by/FIELD d/DIRECTION` <br>  `sortm by/FIELD d/DIRECTION`
 **Help** | `help`
 **SetTimetable**| `setTimetable DATE`
-**AddPersonRelatedToAMeeting**|`addptm INDEX p/PERSON RELATED INDEX1 p/PERSON RELATED INDEX2… ​`
-**DeletePersonRelatedFromAMeeting**|`deletepfm INDEX p/PERSON RELATED INDEX1 p/PERSON RELATED INDEX2… ​`
+**AddPersonRelatedToAMeeting**|`addptm INDEX p/PERSON RELATED INDEX1 [p/PERSON RELATED INDEX2]… ​`
+**DeletePersonRelatedFromAMeeting**|`deletepfm INDEX p/PERSON RELATED INDEX1 [p/PERSON RELATED INDEX2]… ​`

src/main/java/seedu/address/logic/commands/meetings/FindMeetingCommand.java

@@ -28,14 +28,14 @@ public class FindMeetingCommand extends Command {
 
     public static final String COMMAND_WORD = "findm";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds meetings with that has all the "
-            + "specified values.\n"
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds meetings that meet all the "
+            + "specified criteria.\n"
             + "Parameters: "
             + "[" + PREFIX_NAME + "NAME] "
-            + "[" + PREFIX_TIME + "TIME] "
+            + "[" + PREFIX_TIME + "TIME]... "
             + "[" + PREFIX_DESCRIPTION + "DESCRIPTION] "
             + "[" + PREFIX_PRIORITY + "PRIORITY] "
-            + "[" + PREFIX_GROUP + "GROUP]..."
+            + "[" + PREFIX_GROUP + "GROUP]... "
             + "[" + PREFIX_PERSON_CONNECTION + "INDEX OF PERSON RELATED]...\n"
             + "Example: " + COMMAND_WORD + " "
             + PREFIX_NAME + "CS2103 Lecture "

src/main/java/seedu/address/logic/commands/persons/AddPersonCommand.java

@@ -23,9 +23,9 @@ public class AddPersonCommand extends Command {
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to the address book. "
             + "Parameters: "
             + PREFIX_NAME + "NAME "
-            + PREFIX_PHONE + "PHONE "
-            + PREFIX_EMAIL + "EMAIL "
-            + PREFIX_ADDRESS + "ADDRESS "
+            + "[" +PREFIX_PHONE + "PHONE] "
+            + "[" +PREFIX_EMAIL + "EMAIL] "
+            + "[" +PREFIX_ADDRESS + "ADDRESS] "
             + "[" + PREFIX_GROUP + "GROUP]...\n"
             + "Example: " + COMMAND_WORD + " "
             + PREFIX_NAME + "John Doe "