HRmanager Developer Guide

---

Acknowledgements

{ list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well }

---

Setting up, getting started

Refer to the guide Setting up and getting started.

---

Design

Architecture

The Architecture Diagram given above explains the high-level design of the App.

Given below is a quick overview of main components and how they interact with each other.

Main components of the architecture

Main (consisting of classes Main and MainApp) is in charge of the app launch and shut down.

• At app launch, it initializes the other components in the correct sequence, and connects them up with each other.
• At shut down, it shuts down the other components and invokes cleanup methods where necessary.

The bulk of the app's work is done by the following four components:

• UI: The UI of the App.
• Logic: The command executor.
• Model: Holds the data of the App in memory.
• Storage: Reads data from, and writes data to, the hard disk.

Commons represents a collection of classes used by multiple other components.

How the architecture components interact with each other

The Sequence Diagram below shows how the components interact with each other for the scenario where the user issues the command delete 1. (Note: The delete command also supports multiple indexes, e.g., delete 1 3 5, which follows the same interaction pattern.)

Each of the four main components (also shown in the diagram above),

• defines its API in an interface with the same name as the Component.
• implements its functionality using a concrete {Component Name}Manager class (which follows the corresponding API interface mentioned in the previous point.

For example, the Logic component defines its API in the Logic.java interface and implements its functionality using the LogicManager.java class which follows the Logic interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.

The sections below give more details of each component.

UI component

The API of this component is specified in Ui.java

The UI consists of a MainWindow that is made up of parts e.g.CommandBox, ResultDisplay, PersonListPanel, StatusBarFooter etc. All these, including the MainWindow, inherit from the abstract UiPart class which captures the commonalities between classes that represent parts of the visible GUI.

The UI component uses the JavaFx UI framework. The layout of these UI parts are defined in matching .fxml files that are in the src/main/resources/view folder. For example, the layout of the MainWindow is specified in MainWindow.fxml

The UI component,

• executes user commands using the Logic component.
• listens for changes to Model data so that the UI can be updated with the modified data.
• keeps a reference to the Logic component, because the UI relies on the Logic to execute commands.
• depends on some classes in the Model component, as it displays Person object residing in the Model.

Logic component

API : Logic.java

Here's a (partial) class diagram of the Logic component:

The sequence diagram below illustrates the interactions within the Logic component, taking execute("delete 1") API call as an example. Note that the delete command supports multiple indexes (e.g., delete 1 3 5), which follows the same parsing and execution pattern shown below, iterating through each index to delete multiple employees.

How the Logic component works:

1. When Logic is called upon to execute a command, it is passed to an AddressBookParser object which in turn creates a parser that matches the command (e.g., DeleteCommandParser) and uses it to parse the command.
2. This results in a Command object (more precisely, an object of one of its subclasses e.g., DeleteCommand) which is executed by the LogicManager. The command can communicate with the Model when it is executed (e.g. to delete an employee).
3. If the command implements ConfirmableCommand (such as edit, delete, clear, or exit), LogicManager does not execute it immediately. Instead, it temporarily saves the command as a pending confirmation and prompts the user for a y/n input.
4. Upon confirming (y), the command can communicate with the Model when it is executed (e.g. to delete an employee).
5. Note that although this is shown as a single step in the diagram above (for simplicity), in the code it can take several interactions (between the command object and the Model) to achieve.
6. The result of the command execution or confirmation prompt is encapsulated as a CommandResult object which is returned back from Logic.

Here are the other classes in Logic (omitted from the class diagram above) that are used for parsing a user command:

How the parsing works:

• When called upon to parse a user command, the AddressBookParser class creates an XYZCommandParser (XYZ is a placeholder for the specific command name e.g., AddCommandParser) which uses the other classes shown above to parse the user command and create a XYZCommand object (e.g., AddCommand) which the AddressBookParser returns back as a Command object.
• All XYZCommandParser classes (e.g., AddCommandParser, DeleteCommandParser, ...) inherit from the Parser interface so that they can be treated similarly where possible e.g, during testing.

Model component

API : Model.java

The Model component,

• stores HRmanager's employee records, i.e. all Person objects (which are contained in a UniquePersonList object).
• each Person stores Name, Phone, Email, Role, Department, and optional Tag values.
• stores the currently selected Person objects (e.g., results of a search query) as a separate filtered list which is exposed to outsiders as an unmodifiable ObservableList<Person> that can be observed. The UI can be bound to this list so that it updates automatically when the data changes.
• stores a UserPref object that represents the user’s preferences. This is exposed to the outside as a ReadOnlyUserPref objects.
• does not depend on any of the other three components (as the Model represents data entities of the domain, they should make sense on their own without depending on other components)

Storage component

API : Storage.java

The Storage component,

• can save both HRmanager data and user preference data in JSON format, and read them back into corresponding objects.
• inherits from both AddressBookStorage and UserPrefStorage, which means it can be treated as either one (if only the functionality of only one is needed).
• depends on some classes in the Model component (because the Storage component's job is to save/retrieve objects that belong to the Model)

Common classes

Classes used by multiple components are in the seedu.address.commons package.

---

Implementation

This section describes some noteworthy details on how certain features are implemented.

[Proposed] Undo/redo feature

Proposed Implementation

The proposed undo/redo mechanism is facilitated by VersionedAddressBook. It extends AddressBook with an undo/redo history, stored internally as an addressBookStateList and currentStatePointer. Additionally, it implements the following operations:

• VersionedAddressBook#commit() — Saves the current HRmanager state in its history.
• VersionedAddressBook#undo() — Restores the previous HRmanager state from its history.
• VersionedAddressBook#redo() — Restores a previously undone HRmanager state from its history.

These operations are exposed in the Model interface as Model#commitAddressBook(), Model#undoAddressBook() and Model#redoAddressBook() respectively.

Given below is an example usage scenario and how the undo/redo mechanism behaves at each step.

Step 1. The user launches the application for the first time. The VersionedAddressBook will be initialized with the initial HRmanager state, and the currentStatePointer pointing to that single HRmanager state.

Step 2. The user executes delete 5 command to delete the 5th employee in the HRmanager. The delete command calls Model#commitAddressBook(), causing the modified state of the HRmanager after the delete 5 command executes to be saved in the addressBookStateList, and the currentStatePointer is shifted to the newly inserted HRmanager state.

Step 3. The user executes add n/David …​ to add a new employee. The add command also calls Model#commitAddressBook(), causing another modified HRmanager state to be saved into the addressBookStateList.

Step 4. The user now decides that adding an employee was a mistake, and decides to undo that action by executing the undo command. The undo command will call Model#undoAddressBook(), which will shift the currentStatePointer once to the left, pointing it to the previous HRmanager state, and restores the HRmanager to that state.

The following sequence diagram shows how an undo operation goes through the Logic component:

Similarly, how an undo operation goes through the Model component is shown below:

The redo command does the opposite — it calls Model#redoAddressBook(), which shifts the currentStatePointer once to the right, pointing to the previously undone state, and restores the HRmanager to that state.

Step 5. The user then decides to execute the command list. Commands that do not modify the HRmanager, such as list, will usually not call Model#commitAddressBook(), Model#undoAddressBook() or Model#redoAddressBook(). Thus, the addressBookStateList remains unchanged.

Step 6. The user executes clear, which calls Model#commitAddressBook(). Since the currentStatePointer is not pointing at the end of the addressBookStateList, all HRmanager states after the currentStatePointer will be purged. Reason: It no longer makes sense to redo the add n/David …​ command. This is the behavior that most modern desktop applications follow.

The following activity diagram summarizes what happens when a user executes a new command:

Design considerations:

Aspect: How undo & redo executes:

• Alternative 1 (current choice): Saves the entire HRmanager.

  • Pros: Easy to implement.
  • Cons: May have performance issues in terms of memory usage.

• Alternative 2: Individual command knows how to undo/redo by itself.

  • Pros: Will use less memory (e.g. for delete, just save an employee being deleted).
  • Cons: We must ensure that the implementation of each individual command are correct.

{more aspects and alternatives to be added}

[Proposed] Data archiving

{Explain here how the data archiving feature will be implemented}

Search feature

The search command is implemented by SearchCommand, SearchCommandParser, and PersonMatchesKeywordPredicate.

The flow is as follows:

1. The user enters search KEYWORD [MORE_KEYWORDS]....
2. AddressBookParser routes the input to SearchCommandParser.
3. SearchCommandParser trims the arguments, rejects blank input, rejects searches with more than 5 keywords, rejects any keyword longer than 20 characters, and rejects non-alphanumeric keywords.
4. If parsing succeeds, SearchCommand is created with a PersonMatchesKeywordPredicate.
5. SearchCommand#execute updates the model's filtered employee list and returns feedback in the form X employees listed!.

The sequence diagram below illustrates the interactions within the Logic and Model components when a user executes a search command (e.g. search ali hr).

Matching behavior:

• search is case-insensitive
• all employee fields are searched (name, phone, email, role, department, tags)
• each keyword is treated as a partial substring match rather than a full-word match
• multiple keywords are combined using AND semantics

This means a command such as search ali hr returns employees whose fields contain both ali and hr, regardless of case (for instance, an employee named "Alice" in the "HR" department).

Statistics Panel

The statistics panel provides real-time workforce metrics displayed permanently on the right side of the application. This feature follows the Separation of Concerns (SoC) principle by separating data calculation from UI display.

Design Overview

The statistics feature consists of three main components:

1. Statistics (Model layer): A pure data container that calculates statistics from a list of employees. It has no UI dependencies and is easily testable.
2. StatisticsService (Service layer): Orchestrates the retrieval of statistics by accessing the filtered employee list from Logic and creating a Statistics object.
3. StatsPanel (UI layer): A JavaFX component that displays statistics and listens for changes to the employee list to auto-refresh.

Implementation Details

Statistics Class:

• Takes a List<Person> as input
• Calculates total employees, unique tags, most common tag, and tag distribution
• Uses helper methods findMostCommonTag() and createTagDistribution() for clean separation
• All fields are final and assigned in the constructor

StatisticsService Class:

• Acts as a bridge between Logic and Statistics
• Provides getCurrentStatistics() which converts ObservableList<Person> to List<Person>
• Uses logging to track statistics calculation events

StatsPanel Class:

• Extends UiPart<Region> with FXML layout
• Listens to logic.getFilteredPersonList() for changes
• Updates UI labels when the employee list changes
• Only handles UI updates - no calculation logic

Sequence Diagram

The sequence diagram below shows how the statistics panel updates when an employee is added:

1. User executes add command
2. LogicManager executes the command and updates the model
3. ObservableList change triggers the listener in StatsPanel
4. StatsPanel calls refresh() → statisticsService.getCurrentStatistics()
5. StatisticsService creates a new Statistics object from the employee list
6. StatsPanel updates its labels with the new statistics

Design Considerations

Aspect: Where to place statistics calculation logic

• Alternative 1 (current): Separate Statistics class for calculation

  • Pros: Easy to test, follows SRP, reusable
  • Cons: Additional class to maintain

• Alternative 2: Calculate statistics directly in StatsPanel

  • Pros: Fewer classes
  • Cons: UI layer contains business logic, harder to test

Aspect: Auto-refresh mechanism

• Current choice: Listener on ObservableList<Person>

  • Pros: Updates automatically on any change, no command needed
  • Cons: More complex setup

• Alternative: User must type stats command

  • Pros: Simpler to implement
  • Cons: Requires manual refresh, less convenient

Testing Strategy

• StatisticsTest: Unit tests for calculation logic with various employee lists
• StatisticsServiceTest: Tests service layer with temporary storage
• StatisticsServiceIntegrationTest: Integration tests with actual commands

---

Documentation, logging, testing, configuration, dev-ops

• Documentation guide
• Testing guide
• Logging guide
• Configuration guide
• DevOps guide

---

Appendix: Requirements

Product scope

Target user profile: Human Resource Manager

• has a need to manage a significant number of employee and applicant records
• prefer desktop apps over other types
• can type fast
• prefers typing to mouse interactions
• is reasonably comfortable using CLI apps

Value proposition:

• manage employee records faster than a typical mouse/GUI driven app
• provides fast access to employee details, with sorting options for further clarity
• view job applicants details at a glance and decide whether to proceed with interviews and hiring

User stories

Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (unlikely to have) - *

{More to be added}

Use cases

(For all use cases below, the System is the HRmanager and the Actor is the user, unless specified otherwise)

Use case 1 (UC1): Add employee

MSS

1. User requests to add an employee by adding employee details (name, phone, email, role, department, optional tags).

2. System adds an employee to the records.

3. System displays confirmation message.

   Use case ends.

Extensions

• 1a. System detects an error (e.g. format/syntax/duplicates error) in the entered data.

  • 1a1. System displays an error message with the correct format.
  • 1a2. User enters new data. Steps 1a1-1a2 are repeated until the data entered are correct.

  Use case resumes from step 2.

Use case 2 (UC2): Delete employee

MSS

1. User requests to remove one or more employees by specifying their index numbers in the displayed list.

2. System validates the provided index numbers.

3. System removes the corresponding employee records from the system.

4. System displays a confirmation message indicating the number of employees deleted.

   Use case ends.

Extensions

• 1a. System detects an error (e.g. format/syntax error) in the entered data.

  • 1a1. System displays an error message with the correct format.
  • 1a2. User enters new data in the correct format. Steps 1a1-1a2 are repeated until the data entered are correct.

  Use case resumes from step 2.

• 2a. One or more indexes are invalid (e.g., index exceeds list size).

  • 2a1. System displays an error message indicating the invalid index.

  Use case ends.

Use case 3 (UC3): View employees

MSS

1. User requests to view the list of employees.

2. System retrieves the employee records and displays employee list.

   Use case ends.

Extensions

• 2a. There are no employees stored in the system.

  • 2a1. System displays an empty employee list.

  Use case ends

Use case 4 (UC4): Search for an employee

MSS

1. User enters the search command with one or more keywords.

2. System validates the search input.

3. System processes the search query against the existing employee records.

4. System displays a list of all employees that match the search. Matching is case-insensitive, supports partial substring matching across all fields, and returns employees whose fields contain all of the supplied keywords.

   Use case ends.

Extensions

• 1a. The user executes search with blank input.

  • 1a1. System displays an invalid command format message together with the proper search usage.

  Use case resumes at step 1.

• 1b. The user provides more than 5 keywords, at least one keyword longer than 20 characters, or non-alphanumeric keywords.

  • 1b1. System displays an invalid command format message together with the proper search usage.

  Use case resumes at step 1.

• 3a. No employees match the provided search query.

  • 3a1. System displays 0 employees listed!.

  Use case ends.

Use case 5 (UC5): Tag an employee

MSS

1. User searches for employee. (UC4)

2. System shows list of employees.

3. User requests to tag a specific employee in the list.

4. System requests for the tag name.

5. User provides tag name.

6. System adds the tag to an employee and updates the list

   Use case ends.

Extensions

• 2a. The list is empty.

  • 2a1. System informs user that there are no employees to tag.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. System shows an error message.

  Use case resumes at step 1.

• 5a. The tag name provided is already associated with this employee.

  • 5a1. System shows an error message indicating the tag is a duplicate.

  Use case resumes at step 2.

• 5b. The tag name provided is invalid (e.g., blank, exceeds 30 characters, or contains non-alphanumeric characters).

  • 5b1. System shows an error message: "Tags should only consist of alphanumeric characters, hyphens and spaces, and be between 1 and 30 characters long. The tag should not start or end with a space or hyphen, and it should not contain consecutive spaces or hyphens."

  Use case resumes at step 4.

• a. At any time, the User chooses to cancel the tagging operation.

  • a1. System cancels the tagging.

  Use case ends.

Use case 6 (UC6): Edit an employee's details

MSS

1. User requests to edit employee details.
2. System retrieves the employee based on user's provided index.
3. User enters the details to be updated (any of name, phone, email, role, department, tags).
4. System updates the employee's details accordingly, and displays the updated employee information.

Extensions

• 1a. The user enters the command in the incorrect format.

  • 1a1. System shows an error message.

  Use case resumes at step 1.

• 2a. The user entered an invalid index.

  • 2a1. System shows an error message.

  Use case resumes at step 1.

• 3a. User's given details are invalid.

  • 3a1. System shows an error message.

  Use case resumes at step 3.

• 3b. User enters empty details.

  • 3b1. System shows an error message.

  Use case resumes at step 3.

Use case 7 (UC7): Cycle through previous executed commands

MSS

1. User requests to edit an employee's phone number.

2. System edits the employee's phone number in the records.

3. System displays confirmation message.

4. User suddenly recalls that they have forgotten to also edit the employee's email address.

5. User presses the up arrow (PgUp) key in the CLI.

6. System prefills the CLI with the command used in step 1.

7. User deletes the phone field and types the email details, then enters the command. (The command "edit" and the relevant employee index is already prepared)

8. System edits the employee's email address in the records.

   Use case ends.

Extensions

• 1a. There are no previous successfully executed commands.

  • 1a1. System does not do anything in response to up arrow (PgUp) key.

  Use case ends.

• 2a. There are up to 5 previous successfully executed commands.

  • 2a1. User presses up arrow (PgUp) key until their desired previous executed command appears. If there is already an input in the CLI, it is saved.
  • 2a2. User either modifies or does not modify their desired previous command, and enters it, or, user presses down arrow (PgDn) key to get back to the more recent/original command.

  Use case ends.

• 2a1. User enters more than 5 commands.

  • 2a1. The oldest command is discarded and can no longer be cycled through.

  Use case ends.

Use case 8 (UC8): Exporting current employee data

MSS

1. User requests to export current employee data into destination of choice.

2. System resolves path and checks validity.

3. System converts app data into csv format.

4. System saves csv file into target destination.

   Use case ends.

Extensions

• 2a. User input filepath is invalid.

  • 2a1. System displays an error message.

    Use case resumes at Step 1.

• 2b. File already exists at target destination.

  • 2b1. System displays an error message.

    Use case resumes at step 1.

Non-Functional Requirements

1. Should work on any mainstream OS as long as it has Java 17 or above installed.
2. The system should respond to user commands within 1 second under normal usage conditions.
3. The system should be able to store and manage at least 100 employee records while maintaining command response times within 1 second.
4. The system should be usable entirely through a Command Line Interface (CLI) without requiring graphical interaction such as mouse input.
5. The system should be usable by HR managers who are not highly technical, meaning commands should be simple and documentation should clearly explain how to use them.
6. The system should follow standard Java coding conventions and modular design principles to ensure maintainability.
7. The system should ensure that employee data stored in the system remains consistent and is not corrupted during normal usage.
8. The system should ensure that employee information stored locally is not transmitted over the network without user intent.
9. The system should remain stable when invalid commands or inputs are entered and should not crash during normal usage.
10. The system should be packaged as a single executable JAR file so that users can run the application without additional installation steps beyond having Java installed.

Glossary

• Mainstream OS: Windows, Linux, Unix, MacOS
• HR Manager: The primary user of the system who manages employee records using the application.
• Employee Record: A collection of information stored in the system about an employee, such as name, email, phone number, role, and department.
• Command Line Interface (CLI): A text-based interface where users interact with the application by typing commands.
• Department: The organizational unit an employee belongs to (e.g., Engineering, Finance, Human Resources).
• Tag: A label that can be attached to an employee record for categorization purposes. Tags must be alphanumeric and 1-30 characters in length. Examples include "HR", "Manager", "FullTime", "Intern".

---

Appendix: Instructions for manual testing

Given below are instructions to test the app manually.

Launch and shutdown

1. Initial launch

   1. Download the jar file and copy into an empty folder

   2. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.

2. Saving window preferences

   1. Resize the window to an optimum size. Move the window to a different location. Close the window.

   2. Re-launch the app by double-clicking the jar file.
      Expected: The most recent window size and location is retained.

3. { more test cases …​ }

Adding an employee

1. Adding an employee, along with their details.

   1. Prerequisites: List all employees using the list command. There are no existing employees in the list.

   2. Test case: add n/Bob Choo p/22222222 e/bob@example.com r/Head of Office d/Operations t/friend (Valid entry)
      Expected: The employee is added. The success message is shown, along with the added details.

   3. Test case: add n/Amy Choo p/22222222 e/amy@example.com r/Head of Office d/Operations t/friend (Preamble is a space)
      Expected: The employee is added. The success message is shown, along with the added details.

   4. Test case: add k n/Amy Choo p/22222222 e/amy@example.com r/Head of Office d/Operations t/friend (Preamble is not a space)
      Expected: The employee is not added. Error message for invalid command format,along with an example of the correct format, shown.

   5. Test case: add n/Bob Choo p/11111111 e/bob@meme.com r/Head of Operations d/Operations t/friend (Same exact name with existing entry, despite different details)
      Expected: The employee is not added. Duplicate error message is shown, indicating an employee with same name already exists.

   6. Test case: add n/Lance Choo p/33333333 e/lance@example.com r/Head of HR d/Human Resources t/friend t/friend t/husband (Multiple tags)
      Expected: The employee is added. The success message is shown, along with the added details. Note that duplicate tags are accepted as one tag.

   7. Test case: add n/Amy Cho n/Bob Choo p/11111111 e/bob@meme.com r/Head of Operations d/Operations t/friend (Two names))
      Expected: The employee is not added. Error messages for duplicated prefix shown.

   8. Other incorrect commands with duplicated attributes for the same employee: add <other details> p/11111111 p/22222222, add <other details> e/amy@example.com e/bob@example.com, or similar
      Expected: The employee is not added. Error messages for duplicated prefix shown.

   9. Test case: add n/James& p/11111111 e/bob@meme.com r/Head of Operations d/Operations t/friend (Invalid name)
      Expected: The employee is not added. The correct format for a valid name is shown.

   10. Other incorrect commands with invalid data: add <other details> p/abc (Non-numeric phone number) or similar
       Expected: The employee is not added. The correct format for the attribute for which the argument is invalid is shown.

   11. Test case: add n/Pikachu p/11111111 e/bob@meme.com r/Head of Operations d/Operations (No optional Tag)
       Expected: The employee is added. The success message is shown, along with the added details.

   12. Test case: add n/Peppa Pig e/peppa@example.com r/Head of Media d/Media (No phone number) or similar absence of necessary attributes
       Expected: The employee is not added. Error message is shown, along with the correct format and required parameters.

   13. Other incorrect delete commands to try: add, add johndoe p/3333 (no prefix), and other commands which deviate from the command format
       Expected: Similar to previous.

Deleting an employee

1. Deleting one or more employees while all employees are being shown

   1. Prerequisites: List all employee using the list command. Multiple employees in the list.

   2. Test case: delete 1
      Expected: First employee is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated.

   3. Test case: delete 0
      Expected: No employee is deleted. Error details shown in the status message. Status bar remains the same.

   4. Test case: delete 1 3 5
      Expected: 1st, 3rd, and 5th employee are deleted from the list. Status message shows "Deleted employee(s): 3 employee(s)". Timestamp in the status bar is updated.

   5. Test case: delete 1 1 2
      Expected: Only 2 unique employees are deleted (duplicate index filtered out). Status message shows "Deleted employee(s): 2 employee(s)". Only the 1st and 2nd persons are removed.

   6. Test case: delete 2 1 3
      Expected: 1st, 2nd, and 3rd employees are deleted (regardless of order provided). Status message shows "Deleted employee(s): 3 employee(s)". Deletion performed from highest to lowest index to prevent index shifting errors.

   7. Test case: delete 1 2 999
      Expected: No employee is deleted. Error details shown for invalid index 999. Status bar remains the same.

   8. Other incorrect delete commands to try: delete, delete x, ... (where x is larger than the list size)
      Expected: Similar error handling to above.

2. Deleting a employee from a filtered list (search results)

   1. Prerequisites: Execute search KEYWORD to filter the list (where KEYWORD returns one or more matching results based on searchable fields). Multiple search results shown.

   2. Test case: delete 1
      Expected: The 1st employee in the filtered search results is deleted. Confirmation message shown. Filtered list updates automatically.

   3. Test case: search KEYWORD (where KEYWORD returns 2 or more matching results) followed by delete 1 2
      Expected: The 1st and 2nd employees in the filtered results are deleted. Confirmation shows "Deleted employee(s): 2 employee(s)". Filtered list updates.

   4. Test case: search KEYWORD (where KEYWORD returns no matches) followed by delete 1
      Expected: Error message shown for invalid index since filtered list is empty.

Tagging an employee

1. Tagging an employee with valid tags

   1. Prerequisites: List all employees using the list command. Multiple employees in the list.

   2. Test case: tag 1 t/HR
      Expected: First employees is tagged with "HR". Success message shown in the status message.

   3. Test case: tag 1 t/HR t/Manager
      Expected: First employee is tagged with both "HR" and "Manager". Success message shown.

   4. Test case: tag 2 t/ (empty tag)
      Expected: No tag is added. Error details shown: "Tags should only consist of alphanumeric characters, hyphens and spaces, and be between 1 and 30 characters long. The tag should not start or end with a space or hyphen, and it should not contain consecutive spaces or hyphens."

   5. Test case: tag 2 t/HR_Department (contains underscore)
      Expected: No tag is added. Error details shown due to non-alphanumeric character.

   6. Test case: tag 2 t/[a string of 31 characters]
      Expected: No tag is added. Error details shown due to exceeding 30-character limit.

   7. Test case: tag 2 t/HR (when employee already has "HR" tag)
      Expected: No duplicate tag is added. Error details shown indicating duplicate tag.

   8. Other incorrect tag commands to try: tag, tag x t/HR (where x is larger than list size), tag 1 (no tag specified)
      Expected: Similar error messages shown.

Searching for employees

1. Searching for employees using a keyword

   1. Prerequisites: List all employees using the list command. Multiple employees in the list with various names, phones, emails, roles, departments, and tags.

   2. Test case: search John
      Expected: All employees whose fields contain "John" (case-insensitive) are listed. Status message shows the number of employees listed.

   3. Test case: search 91234567
      Expected: All employees whose fields contain "91234567" are listed. Status message shows the number of employees listed.

   4. Test case: search example
      Expected: All employees whose fields contain "example" are listed. Status message shows the number of employees listed.

   5. Test case: search HR
      Expected: All employees whose fields contain "HR" are listed. Status message shows the number of employees listed.

   6. Test case: search (no keyword)
      Expected: No search is performed. Error details shown in the status message indicating invalid command format and displays the correct usage format.

   7. Test case: search (blank keyword with spaces)
      Expected: No search is performed. Error details shown in the status message indicating invalid command format and displays the correct usage format.

   8. Test case: search John_123 (contains underscore)
      Expected: No search is performed. Error details shown due to non-alphanumeric characters in keyword.

   9. Test case: search [a string of 21 characters]
      Expected: No search is performed. Error details shown due to exceeding 20-character limit.

   10. Test case: search keyword1 keyword2 keyword3 keyword4 keyword5 keyword6 (more than 5 keywords)
       Expected: No search is performed. Error details shown indicating invalid command format because maximum keywords is exceeded.

   11. Test case: search keywordThatDoesNotMatchAnyEmployee
       Expected: Empty list shown. Status message indicates "0 employees listed!".

   12. Other incorrect search commands to try: search @lphabet, search 123!@#
       Expected: Similar error messages shown due to non-alphanumeric characters.

Editing an employee

1. Editing an employee's details

   1. Prerequisites: List all employees using the list command. Employee to edit exists in the list.

   2. Test case: edit 1 n/Bob Choo p/22222222 e/bob@example.com r/Head of Office d/Marketing t/friend (Valid entry)
      Expected: After user enters "y" to a y/n confirmation prompt, The employee is edited. The success message is shown, along with the updated details.

   3. Test case: edit 1 n/Amy Choo p/22222222 e/amy@example.com r/Head of Office d/Marketing t/friend (Preamble is a space)
      Expected: After user enters "y" to a y/n confirmation prompt, The employee is edited. The success message is shown, along with the updated details.

   4. Test case: edit 1 k n/Amy Choo p/22222222 e/amy@example.com r/Head of Office d/Marketing t/friend (Preamble is not a space)
      Expected: The employee is not edited. An error message is shown, indicating invalid command format.

   5. Test case: edit 1 p/!#$!*)**%{ (Invalid field)
      Expected: The employee is not edited. An error message is shown, indicating invalid field value.

   6. Test case: edit 1 t/friend t/husband (Multiple tags)
      Expected: After user enters "y" to a y/n confirmation prompt, The employee is edited. The success message is shown, along with the updated details.

   7. Test case: edit 1 n/Amy Cho n/Bob Choo p/11111111 e/bob@meme.com r/Head of Operations d/Marketing t/friend (Duplicate fields)
      Expected: The employee is not edited. Error messages for duplicated prefix shown.

   8. Test case: edit 0 n/Amy Cho (Invalid index)
      Expected: The employee is not edited. An error message is shown, indicating invalid command format.

   9. Test case: edit n/James& p/11111111 e/bob@meme.com (Invalid name)
      Expected: The employee is not edited. The correct format for a valid name is shown.

   10. Other incorrect commands with invalid data: edit 1 <other details> e/a (Invalid email) or similar
       Expected: The employee is not edited. An error message is shown, indicating invalid field value.

   11. Other incorrect delete commands to try: add, add johndoe p/3333 (no prefix), and other commands which deviate from the command format
       Expected: Similar to previous.

Exporting employee list

1. Editing an employee's details

   1. Prerequisites: Existing list is non-empty, target destination is non-empty

   2. Test case: export C:\Users\username\Downloads\test.csv (Valid entry, assuming tester doesn't have existing test.csv in Downloads folder) Expected: A file test.csv is created in the User's Downloads folder, containing the current employee data in csv format.

   3. Test case: export asasearoj (Invalid path) Expected: No csv file is created. An error message is shown, indicating invalid file path.

   4. Test case: export C:\Users\username\Downloads\existingfile.csv (Invalid entry, existing file in destination) Expected: No csv file is created. An error message is shown, indicating existing file.

Saving data

1. Dealing with missing/corrupted data files

   1. {explain how to simulate a missing/corrupted file, and the expected behavior}

2. { more test cases …​ }