[v1.5][T11-B2] PrisonBook

docs/DeveloperGuide.adoc

@@ -10,9 +10,9 @@ ifdef::env-github[]
 :tip-caption: :bulb:
 :note-caption: :information_source:
 endif::[]
-:repoURL: https://github.com/se-edu/addressbook-level4/tree/master
+:repoURL: https://github.com/CS2103JAN2018-T11-B2/main/
 
-By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
+By: `CS2103-T11-B2`      Since: `Jan 2018`      Licence: `MIT`
 
 == Setting up
 
@@ -798,51 +798,158 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 [width="59%",cols="22%,<23%,<25%,<30%",options="header",]
 |=======================================================================
 |Priority |As a ... |I want to ... |So that I can...
-|`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App
+|`* * *` |administrator |group police officers together |form teams to carry out various tasks: patrol rotations, perimeter control, cell guards
 
-|`* * *` |user |add a new person |
+|`* * *` |police officer |have a track record of each prisoner’s past offences
+                          Type 1 – Injuring officer
+                          Type 2 – Infighting with other inmates
+                          Type 3 – Vandalism
+ |use the appropriate level of precaution when dealing with unruly individuals
 
-|`* * *` |user |delete a person |remove entries that I no longer need
+|`* * *` |police officer |keep track of each prisoner’s holding cells |ensure that there are two prisoners per cell and that certain bad prisoner combinations are avoided
 
-|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
+|`* * *` |administrator |assign ranks to each police officer |enforce access rights to view/edit prisoner and officer data
 
-|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
+|`* * *` |police officer |check the length of imprisonment of prisoners I am in charge of |know when they are leaving
+
+|`* * *` |police officer |add prisoners to prison cells |the prisoners have a prison cell to stay in
+
+|`* * *` |police officer |check number of prison cells available |decide whether to take more prisoners in
+
+|`* * *` |police officer |delete a prisoner |add more prisoners to prison
+
+|`* * *` |police officer |check when I am on duty |see when I have to come to work
+
+|`* * *` |police officer |check who are in my team |coordinate with my team
+
+|`* * *` |administrator |add police officers |give access to new police officers
+
+|`* *` |police officer |assign prisoners to different recess blocks |separate those that start fights or cause trouble when together
+
+|`* *` |administrator |shuffle patrol guards around teams every day |each team is made up of different members every day, prisoners will acquaint themselves with specific guards
+
+|`* *` |administrator |divide cells into sections (A, B, C, D) and name each cell numerically (A1, A2, etc…) |refer to each cell easily when assigning prisoners to them
+
+|`* *` |police officer |check whether there are visitor appointments |inform prisoners and bring them to see their visitors
+
+|`* *` |police officer |edit details of prisoners |update information of prisoners
+
+|`* *` |police officer |transfer people to other prisons |have more empty cells for more prisoners
+
+|`*` |prisoner |know my release date |look forward to the day I can see my family/friends again
+
+|`*` |police officer |see my assigned prisoners’ social networks: friends, enemies, family, etc… |use this as reference when dealing with inmates
+
+|`*` |police officer |assign prisoners to solitary confinement |punish those that have continuously committed serious offences
+
+|`*` |cook |check dietary requirements of all people in prison |cook sufficient food
+
+|`*` |counselor |check what prisoners' crimes |understand my patients better
 
-|`*` |user with many persons in the address book |sort persons by name |locate a person easily
 |=======================================================================
 
 _{More to be added}_
 
 [appendix]
 == Use Cases
 
-(For all use cases below, the *System* is the `AddressBook` and the *Actor* is the `user`, unless specified otherwise)
+(For all use cases below, the *System* is the `AddressBook` (AB) unless specified otherwise)
+
+[discrete]
+=== Use case: Add a prisoner
+Actor: police officer (PO)
+
+*MSS*
+
+1.  PO requests to add prisoner
+2.  AB adds prisoner
+3.  PO requests to list cells that are empty/not filled
+4.  AB shows a list of empty/not filled cells
+5.  PO requests to view a specific cell’s prisoner’s details
+6.  AB shows details of prisoner in cell
+7.  PO requests to add a prisoner to a specific cell
+8.  AB adds prisoner to cell
++
+Use case ends.
+
+*Extensions*
+
+[none]
+* 2a. There are no cells available for new prisoner.
++
+[none]
+** 2a1. AB shows an error message.
++
+Use case ends.
+
+* 5a. The given index is invalid, outside range.
++
+[none]
+** 5a1. AddressBook shows an error message.
++
+Use case resumes at step 4.
+
+* 5b. The given index of cell has no prisoners.
++
+[none]
+** 5b1. AddressBook shows an error message.
++
+Use case resumes at step 4.
+
+* 7a. The given index is invalid.
++
+[none]
+** 7a1. AddressBook shows an error message.
++
+Use case resumes at step 6.
 
 [discrete]
-=== Use case: Delete person
+=== Use case: Assign prisoner to a cell
+Actor: police officer (PO)
 
 *MSS*
 
-1.  User requests to list persons
-2.  AddressBook shows a list of persons
-3.  User requests to delete a specific person in the list
-4.  AddressBook deletes the person
+1.  PO selects a prisoner
+2.  PO requests a list of available cells with room available
+3.  AB shows a list of available cells
+4.  PO requests to add prisoner to vacant cell
+5.  AB updates prisoner status and cell status
 +
 Use case ends.
 
 *Extensions*
 
 [none]
-* 2a. The list is empty.
+* 2a. The cell list is empty.
 +
 Use case ends.
 
-* 3a. The given index is invalid.
+* 3a. Prisoner is already assigned to a cell.
 +
 [none]
-** 3a1. AddressBook shows an error message.
+** 3a1. AB removes cell tag from prisoner status and removes prisoner from cell status
 +
 Use case resumes at step 2.
+[discrete]
+=== Use case: Get the list of prisoners in a certain cell
+Actor: police officer (PO)
+
+*MSS*
+
+1.  PO requests a list of cells
+2.  AB shows the list of cells
+3.  PO requests to view the list of prisoners assigned to a specific cell
+4.  AB shows a list of of prisoners assigned to the cell
++
+Use case ends.
+
+*Extensions*
+
+[none]
+* 3a. PO does not have access rights to view the details of the requested cell
++
+Use case ends.
+
 
 _{More to be added}_
 
@@ -852,6 +959,10 @@ _{More to be added}_
 .  Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `1.8.0_60` or higher installed.
 .  Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
 .  A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
+.  Should work for 32-bit and 64-bit environments
+.  System should respond within 2 seconds
+.  Should have different levels of access for users of different ranks.
+.  Should have a backup copy at all times in case a user accidentally deletes any information.
 
 _{More to be added}_
 
@@ -864,6 +975,9 @@ Windows, Linux, Unix, OS-X
 [[private-contact-detail]] Private contact detail::
 A contact detail that is not meant to be shared with others
 
+[[prisoner]] Prisoner::
+A person has been imprisoned for a crime.
+
 [appendix]
 == Product Survey