Skip to content

Commit

Permalink
Merge pull request #244 from gyulong1/master
Browse files Browse the repository at this point in the history 
Update DG and PPP
  • Loading branch information
@abenx162
abenx162 authored Apr 9, 2023
2 parents 142962b + fd01e9e commit 1a9713c
Show file tree
Hide file tree
Showing 5 changed files with 139 additions and 25 deletions.
42 changes: 36 additions & 6 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ Executing the command edits the details of the employee into the ExecutivePro da

Below is a sequence diagram and the explanation of `edit` command.

![AddCommand](images/EditSequenceDiagram.png)
![EditCommand](images/EditSequenceDiagram.png)

Step 1. A user wants to change the name of the employee with ID of 1 to Jane. User will enter the command `edit 1 n/John`.

Expand All @@ -294,6 +294,31 @@ a message indicating no such employee will be shown. If an employee with the giv

Step 5. `storage#saveExecutiveProDb()` is then called, and updates the storage to contain the new `employee`.

### Leave Feature : `leave`

#### Implementation
This section explains the implementation of the `leave` feature.
The command takes in a first parameter which is the unique employee ID, then one integer which is the number of days of leave to take.
Executing the command reduces the number of days of leave of the employee into the ExecutivePro database (if employee has enough leave).

Below is a sequence diagram and the explanation of `leave` command.

![LeaveCommand](images/LeaveSequenceDiagram.png)

Step 1. A user wants to help the employee with ID of 1 to take 3 days of leave. User will enter the command `leave 1 l/3`.

Step 2. `LogicManager#execute` method is called on the user input. This prompts the `LeaveCommandParser`
to parse the user input. This creates a `LeaveCommand` object with the `EmployeeId` and number of days of leave.

Step 3. The `execute` method of `LeaveCommand` will be called. A `CommandException` will be thrown if days of leave is not in range 0-365 (inclusive) and a message indicating the error is shown.

Step 4. The `Model#getFilteredEmployeeList()` method is used to find the employee to be edited. If there is no employee with the given ID, a `CommandException` will be thrown and
a message indicating no such employee will be shown. A `CommandException` will be thrown if employee does not have enough leave.

Step 5. An equivalent `EditCommand` is created to update the leave count of the employee. The `execute` method of the `EditCommand` will be called.

Step 6. `storage#saveExecutiveProDb()` is then called, and updates the storage to contain the new `employee`.

### Delete Feature : `delete`

#### Implementation
Expand Down Expand Up @@ -436,13 +461,15 @@ operator to compare with inputted value. We plan to include further options for
employees based on the `Tag` too.
3. Currently, error messages do not appear in certain cases of invalid input for employees' fields like the negative payroll.
As such, we plan to implement more checks that return error messages: `Invalid input for payroll`
4. Currently, duplicated employees are not handled as we did not take case sensitivty into account for the names of employees.
4. Currently, it is possible to take `0` days of leave, however it may not be useful in actual usage.
As such, we plan to implement a check that requires at least `1` day specified for the `LeaveCommand`: `At least 1 day is needed`
5. Currently, duplicated employees are not handled as we did not take case sensitivity into account for the names of employees.
We plan to take into account case sensitivity in addition to the current check of phone number and email.
5. Currently, there are no error messages for invalid Date Of Birth, such as using future dates.
6. Currently, there are no error messages for invalid Date Of Birth, such as using future dates.
We plan to implement checks for date validity and return an error message: `Invalid Date Of Birth`
6. Currently, batchExport with invalid path is not handled. We plan to check for file path validity and
7. Currently, BatchExport with invalid path is not handled. We plan to check for file path validity and
return an error message: `Invalid file path`
7. Currently, the right panel of our application is not centralized and long inputs may go out of bounds. We plan to make
8. Currently, the right panel of our application is not centralized and long inputs may go out of bounds. We plan to make
the right panel horizontally scrollable as well as increase the size of the right panel to ensure that the information
remains centralized during the launch of our application.
--------------------------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -475,7 +502,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
| `* * *` | HR manager | clear all employees | prevent data leakage |
| `* *` | HR manager | batchadd the details of current employees | easily add multiple employees at once |
| `* *` | HR manager | batchexport the details of current employees | easily export multiple employees at once |
| `* *` | HR manager | check the leaves of current employees | keep track of the number of leaves remaining |
| `* *` | HR manager | check the leaves of current employees | see if employee has enough leave for their leave request |
| `* *` | HR manager | help a current employees take leave | keep track of the number of leaves remaining |
| `* *` | HR manager | set pictures for current employees | identify employees |
| `* *` | HR manager | change the theme of application | use the application with my preferred mode |

Expand Down Expand Up @@ -624,6 +652,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
* 1a1. ExecutivePro returns an error message.
* 1b. The remaining number of leaves inputted is invalid
* 1b1. ExecutivePro returns an error message
* 1c. The employee does not have enough leaves remaining
* 1c1. ExecutivePro returns an error message

Use case ends

Expand Down
26 changes: 13 additions & 13 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ database, and you are free to access and modify the particulars with other comma
However, this function could fail (and ExecutivePro simply does not add any employee), if:

1. There are missing particulars which are compulsory, you can find these listed in [here](#order-of-fields).
2. The particulars are in the wrong format, the program will prompt you on the correct format.
2. The particulars are in the wrong format, the program will prompt you on the correct format. Alternatively, you can find them [here](#field-formats).
3. The new employee added is a duplicate, i.e. there is someone in the database who already shares the same name and
details.

Expand Down Expand Up @@ -495,18 +495,18 @@ This table describes the requirements and order of the fields.

This table describes the requirements for the input format of the fields.

| Field | Prefix | Requirement | Example |
|----------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
| `NAME` | n/ | Only alphanumeric characters and spaces only. | `John Doe`, `Shawn Lee` |
| `PHONE` | p/ | Contain numbers only from 3 digits long to 15 digits long | `80101126`, `973629831`, `999` |
| `DEPARTMENT` | d/ | Only alphanumeric characters | `Sales`, `General Management` |
| `PAYROLL` | pr/ | Can take any value. | `1000 15` |
| `EMAIL` | e/ | Be in the format of [email protected]. "local-part" should contain only alphanumeric characters and/or certain special characters (+\_.-), and cannot start or end with any special characters. "domain" should start and end with alphanumeric characters, must be at least 2 characters long, and can contain hyphens. "ending" part must be at least 2 characters long (e.g. ".com") | `[email protected]`, `[email protected]` |
| `ADDRESS` | a/ | Can take any value. | `311, Clementi Ave 2, #02-25` |
| `LEAVE` | l/ | Must be an integer less than `21`. | `1`, `10`, `20` |
| `DATE_OF_BIRTH` | dob/ | Date in YYYY-MM-DD format. | `2022-01-10` |
| `DATE_OF_JOINING` | doj/ | Date in YYYY-MM-DD format. | `2022-12-10` |
| `TAG` | t/ | Only alphanumeric characters and spaces only. | `Software Engineer`, `Manager` |
| Field | Prefix | Requirement | Example |
|-------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
| `NAME` | n/ | Only alphanumeric characters and spaces only. | `John Doe`, `Shawn Lee` |
| `PHONE` | p/ | Contain numbers only from 3 digits long to 15 digits long | `80101126`, `973629831`, `999` |
| `DEPARTMENT` | d/ | Only alphanumeric characters | `Sales`, `General Management` |
| `PAYROLL` | pr/ | Two integers (salary and day of payment) separated by a space. Salary has to be an integer between `1` and `100000` (inclusive). Day of payment has to be an integer between `1` and `28` (inclusive). Salary and day limits are set to fit expected usage by a HR department. | `1000 15`, `10000 3` |
| `EMAIL` | e/ | Be in the format of [email protected]. "local-part" should contain only alphanumeric characters and/or certain special characters (+\_.-), and cannot start or end with any special characters. "domain" should start and end with alphanumeric characters, must be at least 2 characters long, and can contain hyphens. "ending" part must be at least 2 characters long (e.g. ".com") | `[email protected]`, `[email protected]` |
| `ADDRESS` | a/ | Can take any value. | `311, Clementi Ave 2, #02-25` |
| `LEAVE` | l/ | Must be an integer between between `0` and `365` (inclusive). | `1`, `10`, `350` |
| `DATE_OF_BIRTH` | dob/ | Date in YYYY-MM-DD format. | `2022-01-10` |
| `DATE_OF_JOINING` | doj/ | Date in YYYY-MM-DD format. | `2022-12-10` |
| `TAG` | t/ | Only alphanumeric characters and spaces only. | `Software Engineer`, `Manager` |

--------------------------------------------------------------------------------------------------------------------

Expand Down
71 changes: 71 additions & 0 deletions docs/diagrams/LeaveSequenceDiagram.puml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
@startuml
!include style.puml

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":ExecutiveProParser" as ExecutiveProParser LOGIC_COLOR
participant ":LeaveCommandParser" as LeaveCommandParser LOGIC_COLOR
participant "d:LeaveCommand" as LeaveCommand LOGIC_COLOR
participant "e:EditCommand" as EditCommand LOGIC_COLOR
participant ":CommandResult" as CommandResult LOGIC_COLOR
end box

[-> LogicManager : execute("leave 1 l/3")
activate LogicManager

LogicManager -> ExecutiveProParser : parseCommand("leave 1 l/3")
activate ExecutiveProParser

create LeaveCommandParser
ExecutiveProParser -> LeaveCommandParser
activate LeaveCommandParser

LeaveCommandParser --> ExecutiveProParser
deactivate LeaveCommandParser

ExecutiveProParser -> LeaveCommandParser : parse("leave 1 l/3")
activate LeaveCommandParser

create LeaveCommand
LeaveCommandParser -> LeaveCommand
activate LeaveCommand

LeaveCommand --> LeaveCommandParser : d
deactivate LeaveCommand

LeaveCommandParser --> ExecutiveProParser : d
deactivate LeaveCommandParser
'Hidden arrow to position the destroy marker below the end of the activation bar.
LeaveCommandParser -[hidden]-> ExecutiveProParser
destroy LeaveCommandParser

ExecutiveProParser --> LogicManager : d
deactivate ExecutiveProParser

LogicManager -> LeaveCommand : execute()
activate LeaveCommand

LeaveCommand -> EditCommand :
activate EditCommand
deactivate EditCommand

EditCommand --> LeaveCommand : e

LeaveCommand -> EditCommand : execute()
activate EditCommand
deactivate EditCommand
EditCommand --> LeaveCommand

create CommandResult
LeaveCommand -> CommandResult
activate CommandResult

CommandResult --> LeaveCommand
deactivate CommandResult

LeaveCommand --> LogicManager : result
deactivate LeaveCommand

[<--LogicManager
deactivate LogicManager
@enduml
Binary file added docs/images/LeaveSequenceDiagram.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 1a9713c

Please sign in to comment.