Shui Yao (shuiyao-sg) - Project Portfolio for NUStudy

You can add a revision task for a note to the current revision task list with this command. The heading will copy the title. The GUI will display all tasks upon completing the command.
Format: rn t/TITLE_OF_NOTE dt/DATE tm/TIME

Example:

You can add a revision task for a question to the current revision task list with this command. The heading will copy the question body. The GUI will display all tasks upon completing the command.
Format: rq i/INDEX_OF_QUESTION dt/DATE tm/TIME
Example:
rq i/1 dt/11/11/2019 tm/1500

You can remove a particular revision task from current list with this command. The GUI will display the current list (all-task, done-task, not-done-task or overdue-task) view.
Format: rdelete INDEX_OF_TASK
Example: rdelete 2

You can mark a task as done once you finished it. The GUI will display the current list (all-task, done-task, not-done-task or overdue-task) view.
Format: rdone INDEX

Example:

You can edit a revision task with this command. You need to provide non-empty arguments with prefix h/, dt/ and tm/ for fields you want to change. Please take note that at least one field must be provided.
Format: redit INDEX [h/HEADING] [dt/DATE] [tm/TIME]
Example:
redit 1 h/CS2100 Logic Circuit dt/15/08/2019 tm/1200

You may view the whole revision task list using this command.
Format: rlist

You may use this command to view the list of revision tasks that you have completed.
Format: finished

You may use this command to the list of revision tasks that you have not completed.
Format: unfinished

You may use this command to view the revision tasks which you have not done but having passed the scheduled time.
Format: overdue

You may use this command to search for tasks with specified details. You may key in keyword(s) of the heading, or the date, or the time, with prefix h/ dt/ tm/ respectively. The GUI will display a task list of all tasks with the field (heading or date or time) that matches your input.
Format: rfind h/WORD [WORD]…​ or rfind dt/DATE or rfind tm/TIME

Example:
rfind h/hello world - This command gives you all tasks with headings containing "hello" or "world" or "hello world".
rfind dt/01/11/2019 - This command gives you all tasks on 1 November 2019.
rfind tm/1200 - This command gives you all tasks at 12:00 (12pm), regardless of date.

You can remove all revision tasks with this command.
Format: rclear

Apart from the documentation of my individual feature, I also helped the team by adding a command summary of everyone’s feature. You may refer to the Command Summary section in the User Guide.

Revision task management is facilitated by Model. Commands related to task manipulation extend Command class. The commands update the Model interface which is implemented by ModelManager class. The ModelManager then updates AppData which stores all the revision tasks in an internal data structure TaskList. TaskList is essentially an ObservableList of Task. Local data will be updated in the end by LogicManager.

Taking AddTaskForNoteCommand as an example, the following process illustrates the mechanism of adding a revision task for note to the task list (adding a revision task for question has a similar command but different parameters).

Step 1. The user enters command rn t/UML diagram dt/01/01/2019 tm/1200 for adding a task for note. The command is parsed by AddTaskForNoteCommandParser. AddTaskForNoteParser then creates an AddTaskForNoteCommand. The high-level logic of parsing and creating the command is similar to the process of deleting a note from the note list as illustrated by the sequence diagram for deleting a note. However, the execution stage of AddTaskForNoteCommand differs from that of deleting a note.

Step 2. The Logic Manager calls Command#execute(Model) which essentially calls AddTaskForNoteCommand#execute(Model) because of polymorphism.

Step 3. AddTaskForNoteCommand calls its own private method hasValidNote(Model) which checks if the Note with Title "UML diagram" exists in Model. If not, a CommandException will be thrown and execute(Model) stops because non-existing note title is not allowed to be the heading of any tasks.

Step 4. AddTaskForNoteCommand calls Model#hasTask(Task) to check whether the Model has a task identical to the one the user is adding. If there is an existing identical task, a CommandException will be thrown and execute(Model) stops to avoid duplicate tasks.

Step 5. AddTaskForNoteCommand calls Model#addTask(Task) to add the new task to the Model. Model calls AppData#addTask(Task) to add the task to AppData which keeps track of all data of the app. AppData then calls TaskList#add(Task) to add the task to TaskList, which is the underlying data structure storing tasks.

Step 6. A CommandResult is created and returned to the LogicManager to inform the user of successful addition of a new task to the revision plan.

The following sequence diagram illustrates the interaction between classes when calling AddTaskForNoteCommand#execute(Model).

Zooming in to Step 3, when calling hasValidNoteForTask(Model), AddTaskForNoteCommand creates a new Note with a Title "UML diagram" and a Content "dummy entry". The entry of Content is not important because AddTaskForNoteCommand only records the Title of a Note and the existence of a Note is checked against its Title only (if the title is in the note list, then the note exists in the list). The detailed process is illustrated by the sequence diagram below.

The following activity diagram summarizes the whole process of adding a task for note.