Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V1.4 update documentation #144

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
05dfe5b
Modified SampleDataUtil.java
Nov 8, 2018
3e4845b
Update src/main/java/seedu/address/model/util/SampleDataUtil.java
Nov 8, 2018
6c2f4fa
Update docs/UserGuide.adoc
Nov 8, 2018
98261df
Removed irrevelant tags
Nov 8, 2018
5d343c1
Merge branch 'master' into v1.4-Update-Documentation
Nov 10, 2018
95bb071
Updated developer guide
Nov 10, 2018
fba965d
Merge branch 'master' into v1.4-Update-Documentation
Nov 11, 2018
5b3bb37
Merge branch 'master' into v1.4-Update-Documentation
Nov 11, 2018
1aab677
Update docs/DeveloperGuide.adoc
Nov 11, 2018
e8bce30
Update docs/DeveloperGuide.adoc
Nov 11, 2018
cafe260
Update docs/DeveloperGuide.adoc
Nov 11, 2018
812e2be
Update Documentation
Nov 11, 2018
6f9b14e
Merge branch 'master' into v1.4-Update-Documentation
Nov 11, 2018
1836982
Update docs/DeveloperGuide.adoc
Nov 11, 2018
8c3cfaf
Updated jylee-git.adoc and DeveloperGuide.adoc
Nov 11, 2018
b362fd4
Update DeveloperGuide.adoc and jylee-git.adoc
Nov 11, 2018
59ce8d7
Update DeveloperGuide.adoc and jylee-git.adoc
Nov 11, 2018
15ca84d
Added more sample persons data
Nov 11, 2018
161c60e
Appempt to fix formatting issues
Nov 11, 2018
6d50a99
Updated contribution list
Nov 11, 2018
e9ee5d8
Updated screenshots in lieu of UI changes
Nov 11, 2018
27af1ac
Update contributions
Nov 11, 2018
4427bf5
Fixed mistake in SessionComponentClassDiagram
Nov 11, 2018
41c4201
Merge branch 'master' into v1.4-Update-Documentation
Nov 12, 2018
cb20641
Update docs/team/jylee-git.adoc
Nov 12, 2018
b6cddfe
Fixed discrepancies in UserGuide.adoc and updated DeveloperGuide.adoc
Nov 12, 2018
782c160
Corrected discrepancies in userGuide.adoc and DeveloperGuide.adoc
Nov 12, 2018
ea5b150
Update docs/DeveloperGuide.adoc
Nov 12, 2018
53cd54b
Standardized extension cases in DeveloperGuide.adoc
Nov 12, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
285 changes: 251 additions & 34 deletions docs/DeveloperGuide.adoc

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions docs/UserGuide.adoc
Expand Up @@ -38,23 +38,23 @@ This user guide will give you step by step instruction on how you can use the fe
+
image::Ui.png[width="790"]
+
. If the app does not contain any sample data (refer to <<List of user accounts at first launch or upon reset, Table 1>>), something went wrong during the download process. Delete the folder `BankAB` and repeat step 1 to 4.
. If the app does not contain any sample data (refer to <<List of sample user accounts at first launch or upon reset, Table 1>>), something went wrong during the download process. Delete the folder `BankAB` and repeat step 1 to 4.
. The following table contains a sample list of persons with the respective account details when the application
runs for the first time or when ResetCommand was executed in the previous runtime:

.List of user accounts at first launch or upon reset
.List of sample user accounts at first launch or upon reset
[[defaultcontacts]]
|===
|*Name* |*NRIC* |*Password* |*Priority Level*
|Highest Admin Account
|S1230000E
|Password
|I.T. Unit (Highest Priority Level)

|Alex Yeoh
|S1234567E
|Password
|ADMINISTRATOR
|ADMINISTRATOR (Highest Priority level)

|Leonard Tan
|S1230000E
|Password
|I.T. UNIT

|Bernice Yu
|T1234567E
Expand Down Expand Up @@ -227,16 +227,16 @@ Example: `setplvl 1 plvl/0`
====
- A successful change of priority level should show the following message:

image::setPlvl_success_screenShot.png[]
image::setPlvl_success_screenShot.png[width=800]

- Users of insufficient priority level (below administrator priority level) will get the following
error message when attempting to execute this command:

image::setPlvl_failed_screenShot.png[]
image::setPlvl_failed_screenShot.png[width=800]

- Users (with sufficient priority level), that attempts to change their own priority level will not be allowed to do so:

image::setOwnPlvl_failed_screenShot.png[]
image::setOwnPlvl_failed_screenShot.png[width=800]
====
//end::jylee-git_login[]

Expand Down Expand Up @@ -779,7 +779,7 @@ There is no need to save manually.
| NRIC Number
| ic/NRIC
| NRIC should start with an upper-case character [S, T, F, G], followed by a seven-digit number, and ending with a upper-case
alphabet.
alphabet. NRIC for every single individuals must be unique.
| ic/S9203948E

| Password
Expand Down Expand Up @@ -824,8 +824,8 @@ Department names should start with a name, and ends with 'Management'.
| Priority Level
| plvl/PRIORITY_LEVEL
| Priority Level should be a number respective to the following classification: +
[0] I.T. Unit (HIGHEST) +
[1] Administrator +
[0] Administrator (HIGHEST) +
[1] I.T. Unit +
[2] Manager +
[3] Basic (LOWEST)
| plvl/2
Expand Down
1 change: 1 addition & 0 deletions docs/diagrams/SessionComponentClassDiagram.xml
@@ -0,0 +1 @@
<mxfile userAgent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/8.8.0 Chrome/61.0.3163.100 Electron/2.0.2 Safari/537.36" version="9.4.1" editor="www.draw.io" type="device"><diagram id="8f4d1c71-719e-6a0c-39b4-9f5959ab3f69" name="Page-1">5Vltb6M4EP41+XLSVrwEaD42abK70nVVXVa6vY8GDFh17Mi4Tbq//myweTGQ0JamPV36oXhsj/HMM8+Mzcxd7Y5fGdhndzSGeOZY8XHm3s4cx/a8QPyTkmclsf1FKUkZipWsFmzRb6iElpI+ohjmrYGcUszRvi2MKCEw4i0ZYIwe2sMSitur7kEKO4JtBHBX+jeKeaakc8uqO75BlGZq6WtPdYQgekgZfSRqvZnjJsWv7N4BrUuNzzMQ00ND5K5n7opRysun3XEFsTSuNls5bzPQW703g4SPmeC45YwngB+hfuXixfizNkaxHSgn2DN3ecgQh9s9iGTvQfhfyDK+w6o7QRivKKasmOtuNpvl2hLynDP6ABs94dz3rLnoSRmIkXhd3UcogVKMQS69KCd3d6U2+gQZh8eGSO3yK6Q7yNmzGHKsfFdOUZB0tMcOtX/9QMmyhmtdPREoTKWV7tqu4kGZdsDMXSuvnNnNEhEOWSJtKZpLsU8fi2WXIRNPKS92riRasIV5jijRcrFw2BnbmG24cthRSQL9KOpzVBwsQmsqLwRtL1QB1fCCbfd4wZvACX1Q98FOAljZstnKEUkx5IWpS3HaGjRo8n6H3QEiOIP9R/3mum2/udcj/baYwG/eeYqCJL6RtC9aIabRg9h1DPKsIi3Rv0FygYJOREulHNtpsxc8Iv5LjxLP/8jnK6+YI976V6VONOq+QQPn9JFFsIU+DlgKeYsVYNxKRl0nNI3sK4MyiAFHT+181Wdlpe6eCq5pONRqO9QzWa58dTWrmUAMRXP/jKJywx1FhdOrPY7Cgd/BwQ+Gok8XK55txIp9QY4LOja6Z4gyxJ//hE+ySvv0VGOa76IpYtEx3w3G95DllOTfBKHciXLnlMEo4VvVY30aAy4uaEDb7ljQurqyO0ZrEDbdQ2KwcJufc0EhXI+OEdhREv/MENFdeuxcC5pUL7hVe4QyntGUEoDXtXQJMEqFqlsMExkP0s5IHARulDiknNNdIzXYw6nBmi41BCNTw1Hb2HYXwSSZYX5twMd9ZWbw52cUDWSGWpEeSJMkh2/NHna3/PsYWNoXgGXwXrhcvBSXgRV40+DSG6C1F+NyiB8/CJfz/xdjOu8FTf+l0PR8ZxpkGoda99XINE9ZH4zM6w4yy1LoZAn0ESWPb14rXLLk0Vd5Lzyf1kdS24jltwYgp/v3rVcW3eDTWBkbfV/sSUKvU2OYDh0degaCPNsbFXqvCCunWyL/0QEMgzn6DcLqJNHAx1j6xSCEeFndR7eCsriRVucVlQv6Q1GDW120qzea1aAfHaMTedwsIidhOh2xDZd8T0Qb0zSFsRwoOE9oseTVtGP9+Ou7bAASVyLjlC2Ip1gghIVbKYPx1UzazDx+r3EOS9WEmpoLyUnFlJeKDfDkGdjLR0I5PH9jnzeKgX4qMRCXC1WIpD9l3+0Xv4f0PfnXR/p+8VPIa8jL30TJwCgU3b4LhHlPMpjirtLpVnOnkkEkP3KgyCzmhvl54FbTrkxnEHCvLTt3kCevHL0TefONwWweNR2DdMeyt+0YiqxxhdN5qhDN+mNcObz+5Omu/wU=</diagram></mxfile>
Binary file added docs/images/SessionComponentClassDiagram.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/login_success_screenShot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/setPlvl_success_screenShot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 16 additions & 4 deletions docs/team/jylee-git.adoc
Expand Up @@ -45,6 +45,7 @@ require user authentication.
* *Other contributions*:

** Project management:
*** Set up the organization and project repo on Github
*** Managed vetting through and approving individual pull requests
*** Deployed website for our project: https://cs2113-t16-3.netlify.com/[Website]

Expand All @@ -56,6 +57,13 @@ require user authentication.
*** Re-arranged summary of commands in the user guide to make them more organized: https://github.com/CS2113-AY1819S1-T16-3/main/pull/89[#89]
*** Added appendices A and B in the user guide that summarizes the prefixes and corresponding data types, and also various priority levels and its corresponding privileges:
https://github.com/CS2113-AY1819S1-T16-3/main/pull/60[#60], https://github.com/CS2113-AY1819S1-T16-3/main/pull/89[#89]
*** Updated documentations as the project progresses:
https://github.com/CS2113-AY1819S1-T16-3/main/pull/60[#60],
https://github.com/CS2113-AY1819S1-T16-3/main/pull/68[#68],
https://github.com/CS2113-AY1819S1-T16-3/main/pull/89[#89],
https://github.com/CS2113-AY1819S1-T16-3/main/pull/96[#96],
https://github.com/CS2113-AY1819S1-T16-3/main/pull/136[#136],
https://github.com/CS2113-AY1819S1-T16-3/main/pull/144[#144]

** Community:
*** PRs reviewed (with non-trivial review comments):
Expand All @@ -74,10 +82,6 @@ https://github.com/CS2113-AY1819S1-T16-3/main/pull/60[#60], https://github.com/C
//include whatever you did here
include::../UserGuide.adoc[tag=jylee-git_login]

include::../UserGuide.adoc[tag=Command_Summary]

include::../UserGuide.adoc[tag=jylee-git_appendixA]

include::../UserGuide.adoc[tag=jylee-git_appendixB]


Expand All @@ -89,3 +93,11 @@ include::../UserGuide.adoc[tag=jylee-git_appendixB]

//include whatever you did here
include::../DeveloperGuide.adoc[tag=jylee-git_SessionDesign]

include::../DeveloperGuide.adoc[tag=jylee-git_dg_plvlDesign]

include::../DeveloperGuide.adoc[tag=jylee-git_dg_login]

include::../DeveloperGuide.adoc[tag=jylee-git_dg_setplvl]

include::../DeveloperGuide.adoc[tag=jylee-git_dg_reset]
3 changes: 2 additions & 1 deletion src/main/java/seedu/address/logic/commands/AddCommand.java
Expand Up @@ -53,7 +53,8 @@ public class AddCommand extends Command {
+ PREFIX_TAG + "owesMoney";

public static final String MESSAGE_SUCCESS = "New person added: %1$s";
public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the address book";
public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the address book. Check the"
+ " NRIC parameter again. NRIC for all persons must be unique.";

private final Person toAdd;

Expand Down
21 changes: 15 additions & 6 deletions src/main/java/seedu/address/model/util/SampleDataUtil.java
Expand Up @@ -63,12 +63,11 @@ public static Person[] getSamplePersons() {
getSchedule("1100", "1600", "Level 4")),

new Person(new Name("Charlotte Oliveiro"), new Nric("F1234567E"), new Password("Password"),
new Phone("93210283"), new Email("charlotte@abbank-sg.com"), new Department("Middle Management"),
new Phone("93210283"), new Email("charlotte@abbank-sg.com"), new Department("Junior Management"),
new PriorityLevel(PriorityLevelEnum.BASIC.getPriorityLevelCode()),
new Address("Blk 11 Ang Mo Kio Street 74, #11-04"), new Mode("out"),
new WorkingRate("10"), new CheckedInTime(""),
getTagSet(),
getSchedule("1000", "1700", "Counter 1")),
getTagSet(), null),

new Person(new Name("David Li"), new Nric("S5473621G"), new Password("NeuEr2018"), new Phone("91031282"),
new Email("lidavid@abbank-sg.com"), new Department("Junior Management"),
Expand Down Expand Up @@ -119,7 +118,7 @@ public static Person[] getSamplePersons() {
new Password("Password"),
new Phone("88540863"),
new Email("cker@abbank-sg.com"),
new Department("Junior Management"),
new Department("Middle Management"),
new PriorityLevel(PriorityLevelEnum.BASIC.getPriorityLevelCode()),
new Address("Yishun, Singapore"), new Mode("out"), new WorkingRate("5"), new CheckedInTime(""),
getTagSet(), null),
Expand All @@ -130,7 +129,7 @@ public static Person[] getSamplePersons() {
new Password("Password"),
new Phone("94280736"),
new Email("dpek@abbank-sg.com"),
new Department("Junior Management"),
new Department("Middle Management"),
new PriorityLevel(PriorityLevelEnum.BASIC.getPriorityLevelCode()), new Address("Yishun, Singapore"),
new Mode("out"), new WorkingRate("5"), new CheckedInTime(""), getTagSet(), null),

Expand Down Expand Up @@ -183,7 +182,17 @@ public static Person[] getSamplePersons() {
new Email("batkinson@abbank-sg.com"),
new Department("Junior Management"),
new PriorityLevel(PriorityLevelEnum.BASIC.getPriorityLevelCode()), new Address("Yishun, Singapore"),
new Mode("out"), new WorkingRate("5"), new CheckedInTime(""), getTagSet(), null)
new Mode("out"), new WorkingRate("5"), new CheckedInTime(""), getTagSet(), null),

new Person(
new Name("Stacy Mak"),
new Nric("S0002334T"),
new Password("Password"),
new Phone("64665240"),
new Email("stacym@abbank-sg.com"),
new Department("Middle Management"),
new PriorityLevel(PriorityLevelEnum.MANAGER.getPriorityLevelCode()), new Address("NUS, Singapore"),
new Mode("out"), new WorkingRate("50"), new CheckedInTime(""), getTagSet(), null)
};
}

Expand Down
22 changes: 22 additions & 0 deletions src/main/java/seedu/address/session/Session.java
@@ -1,6 +1,7 @@
package seedu.address.session;

import seedu.address.logic.commands.exceptions.CommandException;
import seedu.address.model.Model;
import seedu.address.model.person.Nric;
import seedu.address.model.person.Person;
import seedu.address.model.person.password.Password;
Expand Down Expand Up @@ -51,4 +52,25 @@ public interface Session {
* Returns true if the logged in Priority Level matches any of the stated plvlEnums in the input parameter(s).
*/
boolean containsAnyOfThesePriorityLevels(PriorityLevelEnum... plvlEnums);

//================================= UPDATE/DELETE KEY IN HASHMAP ==============================================
/**
* Update a single key with the new values
*/
void updatePersonsHashMap(Person toAmend);
/**
* Adds a new key into the hash map
*/
void addIntoPersonsHashMap(Person toAdd);
/**
* Clears the hashmap and re-synchronizes the list of persons into the hashmap.
* O(N) time complexity
*/
void resyncPersonsHashMap(Model model);

//================================= SESSION MODIFIED EVENT CALLER ============================================
/**
* Raises a new sessionChangedEvent, for the purpose of updating the logged in details in the status footer.
*/
void raiseSessionModifiedEvent() throws CommandException;
}
1 change: 1 addition & 0 deletions src/main/java/seedu/address/session/SessionManager.java
Expand Up @@ -173,6 +173,7 @@ public boolean containsAnyOfThesePriorityLevels(PriorityLevelEnum... plvlEnums)
/**
* Update a single key with the new values
*/
@Override
public void updatePersonsHashMap(Person toAmend) {
requireNonNull(toAmend);
allPersonsHashMap.replace(toAmend.getNric(), toAmend);
Expand Down