diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc index 1877200da74d..bba2d4a2c002 100644 --- a/docs/DeveloperGuide.adoc +++ b/docs/DeveloperGuide.adoc @@ -941,6 +941,7 @@ Do take a look at <> before attempting to modify the `Storage` c ** See this https://github.com/se-edu/addressbook-level4/pull/594[PR] for the full solution. **** +[discrete] ==== `Session` component *Scenario:* You are in charge of `session`, whereby it is used to manage users logging in/out. Currently, there is a @@ -1643,6 +1644,17 @@ Use case resumes to step 1. + Use case ends. +*Extensions* + +* 2a. User logged in but is not holding a priority level of "I.T. UNIT". +** 2a1. AddressBook shows an error message. ++ +Use case ends. +* 2b. User is not logged in +** 2b1. AddressBook shows an error message. ++ +Use case ends. + [appendix] == Non Functional Requirements @@ -1672,7 +1684,7 @@ These instructions only provide a starting point for testers to work on; testers ==== The following prerequisites apply to *ALL* test cases: - + -. The following test cases assume a *default slate* when the app is first launched or reset, *without any prior +. The following test cases assume a *default state* when the app is first launched or reset, *without any prior modifications to the employees list and its' corresponding accounts*. Modify your test case according to whatever changes that were made prior to executing each individual test cases. . The following test cases assume that the employee list is *neither sorted nor filtered* prior to executing the @@ -1702,7 +1714,7 @@ The following prerequisites apply to *ALL* test cases: - + ... Login NRIC has to be registered in the application, either through the sample data or added manually by an administrator. ... You are *not logged in* prior to testing this function. .. Test case: `login ic/S1234567E pwd/Password` + - Expected: Status message box states that you are logged in successfully, with your name, and your shcedule (if any). + Expected: Status message box states that you are logged in successfully, with your name, and your schedule (if any). Status bar will now show that you are logged in with the corresponding name of the user who logged in. .. Test case: `login ic/S12345678 pwd/Password` + Expected: Not logged in. Format of NRIC is incorrect and Status message box shows the NRIC constraints. Status bar remains unchanged. @@ -1742,8 +1754,8 @@ The following prerequisites apply to *ALL* test cases: - + ==== Editing personal particulars of the person who is logged in [NOTE] ==== -Refer to <> for the list of -editable parameters. +Refer to <> for the +list of editable parameters. ==== . Edits the editable particulars of the person who is logged in. .. Prerequisites: User must be logged in to the application. @@ -1778,7 +1790,9 @@ Expected: No employee is added. The NRIC of `Carol Crowe` is the same as `Charlo . Deleting an employee while all employees are listed. -.. Prerequisites: List all employees using the `list` command. Multiple employees in the list. +.. Prerequisites: - + +... List all employees using the `list` command. Multiple employees in the list. +... User must be logged in as an administrator. .. Test case: `delete 1` + Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. .. Test case: `delete 0` + diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 4e43be1ab507..20bd3a7be4eb 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -121,7 +121,7 @@ Logs out of the application, allowing for other users to log in again. //end::jylee-git_login[] -==== Editing an employee : `edit` +==== Editing personal particulars : `edit` Edits the existing particulars of the logged in user. + Format : `edit [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]...` + @@ -158,7 +158,7 @@ This command will NOT be able to edit the following: Examples: * `edit p/91234567 e/johndoe@example.com` + -Sets the logged in employee's details to the aforementioned email and phone number, and also clears tags if any. + +Sets the logged in employee's details to the aforementioned email and phone number. + * `edit t/friend t/lecturer n/John Doe` + Sets the logged in employee's details to the name of John Doe; clears all tag and sets the two aforementioned tags. + @@ -180,7 +180,7 @@ Format: `add n/NAME ic/NRIC pwd/PASSWORD p/PHONE_NUMBER e/EMAIL d/DEPARTMENT a/A ==== * An employee can have any number of tags (including 0) * Priority level will be set to BASIC if left empty -* A recently added employee have no schedule allocated +* A recently added employee will have no schedule allocated * More than 2 decimal places for working rate is acceptable ==== @@ -709,7 +709,8 @@ image::checkedOut.PNG[width="700"] ==== This operation requires user to be logged in with a privilege level of `I.T. Unit` to perform. ==== -Resets the application into a default slate, by deleting data/AddressBook.xml and data/leave.xml. The application will also close upon +Resets the application into a default state, by deleting data/AddressBook.xml and data/leave.xml. The application will +also close upon deleting the two files. Refer to the <> upon app reset on the contacts available. @@ -738,10 +739,12 @@ There is no need to save manually. • *<>*: `login ic/NRIC pwd/PASSWORD` • *<>*: `checkloginstatus` • *<>*: `logout` -• *<>*: `edit [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]...` +• *<>*: `edit [n/NAME] [p/PHONE] [e/EMAIL] + [a/ADDRESS] [t/TAG]...` === Employee Management Database -• *<>*: `add n/NAME ic/NRIC pwd/PASSWORD p/PHONE NUMBER e/EMAIL d/DEPARTMENT a/ADDRESS wr/WORKING_RATE [plvl/PRIORITY_LEVEL] [t/TAGS]...` +• *<>*: `add n/NAME ic/NRIC pwd/PASSWORD p/PHONE_NUMBER e/EMAIL d/DEPARTMENT + a/ADDRESS wr/WORKING_RATE [plvl/PRIORITY_LEVEL] [t/TAG]...` • *<>*: `delete INDEX` • *<>*: `setplvl INDEX plvl/PRIORITY_LEVEL` • *<>*: `setdepartment INDEX d/DEPARTMENT` @@ -892,7 +895,8 @@ Department names should start with a name, and ends with 'Management'. | - Edit your own particulars + - Apply for leave + -- Check in/out to/from work for their own +- Check in/out to/from work for their own + +- Set and view your own schedule |MANAGER (2) | @@ -916,6 +920,7 @@ Department names should start with a name, and ends with 'Management'. - All privileges of a MANAGER Priority level + - Add and delete employees from the AddressBook + - Set the priority level of all employees + -- Set Department of all employees +- Set Department of all employees + +- Set and view other employee's schedules |=== //end::jylee-git_appendixB[] diff --git a/src/main/java/seedu/address/MainApp.java b/src/main/java/seedu/address/MainApp.java index 18a7572923c6..86c0aea5be76 100644 --- a/src/main/java/seedu/address/MainApp.java +++ b/src/main/java/seedu/address/MainApp.java @@ -45,7 +45,7 @@ */ public class MainApp extends Application { - public static final Version VERSION = new Version(3, 1, 10, true); + public static final Version VERSION = new Version(4, 0, 0, true); private static final Logger logger = LogsCenter.getLogger(MainApp.class);