Skip to content

Latest commit

 

History

History
306 lines (167 loc) · 6.83 KB

UserGuide.adoc

File metadata and controls

306 lines (167 loc) · 6.83 KB
Raw

Police Database - User Guide

By: Team F10-3 Since: `Aug 2018'

1. Introduction

The police database is for police officers(PO) and headquarter personnel(HQP). Both groups will have varying access and authorization levels to this database. POs would be able to read from the database after screening someone while on patrol and choose his course of action base on the status/threat level of subject. HQP would have the added functions of adding and removing people from the database. Refer to quick start to get started

2. Quick Start

  1. Ensure that you have Java Version 9 installed on your device.

  2. Download the latest version of EX-SI-53 here.

  3. Copy the file to the folder you want to use as the home folder for your Address Book.

  4. Double-click the file to start the app. The user interface should appear in a few seconds.

    Ui

  5. Type the command in the command box and press Enter to execute it.

  6. To display the full list of commands and a summary of their functions in the application, type ‘help’ and press “Enter”.

  7. Refer to Section 3, “Features” for details of each command.

3. Features

Command Format

  • Words in UPPER_CASE are the parameters to be supplied by the user e.g. in add n/NAME, NAME is a parameter which can be used as add n/John Doe

  • Items in the WANTEDFOR parameter must be given if STATUS is "wanted"

  • * Items in square brackets are optional e.g `n/NAME [p/POSTALCODE] [s/STATUS]' can be used as 'n/John Doe p/510246 s/xc' or 'n/John Doe s/xc'

  • Items with …​ after them can be used multiple times including zero times e.g. o/OFFENSE…​ can be used as   (i.e. 0 times), o/theft, o/riot o/drugs etc

3.1. Viewing help : help

Format: 'help'

  • Lists all the features in a user friendly format for users and how to use them

HelpCommand

3.2. Adding a person: add

Adds a criminal to the database - only by HQP.

Format: 'add NAME n/NRIC d/DATEOFBIRTH p/POSTALCODE s/STATUS w/WANTEDFOR o/PASTOFFENSES'

Examples:

  • add John Doe n/f1234567p d/1996 p/510246 s/xc w/none o/theft o/drugs"

  • Displays a message stating the new person being added

AddCommand
ℹ️

  • If a person’s STATUS is "wanted", the WANTEDFOR parameter has to be filled

  • No two persons can have the same NRICs, the other parameters such as NAME, POSTALCODE, etc, can be the same
💡
 A person can have more than 0 past offenses

3.3. Editing a person : edit

Edit a specified parameter of an existing person in the address book - only by HQP

Format: 'edit NRIC n/[NAME] p/[POSTAL_CODE] s/[STATUS] w/WANTED_FOR o/PAST_OFFENCES'

  • Edits the person with the specified NRIC.

  • At least one of the optional fields must be provided.

  • Existing values will be updated to the input values.

Examples:

  • edit g1952866Q p/510246

  • Edits the postal code of the person with the specified NRIC to be 510246

3.4. Display a list of all persons : list

Shows a list of every person in the records

Format: 'list'

Examples:

  • list

  • displays list of all persons

ListCommand

3.5. Find a person by NRIC : find

Finds a person in the records by the specified NRIC

Format: 'find NRIC'

Examples:

  • find s1234567a

  • Returns person with 's1234567a'

ℹ️

  • A timestamp and current ID is stored whenever this command is used

3.6. Get screening history of a person: check

Displays all the times a person was screened in the form of timestamps (using 'find' command) - Only by HQP

Format: 'check s1234567a'

  • Returns an indexed list of timestamps for specified person, as well as corresponding PO ID nuber

Examples:

  • check s1234567a

  • Shows an indexed list of timestamps for when person with s1234567a was screened by any POs

CheckCommand

3.7. Deleting a person : delete

Deletes the specified person from the database- only by HQP.

Format: 'delete NRIC'

  • Deletes the person with the specifies NRIC.

Examples:

  • delete G1952866Q

  • Deletes the person with the specified NRIC from the records.

3.8. Clear records : clear

Clears the records of persons- only by HQP

Format: 'clear'

Example:

  • clear

  • Records will now be empty

3.9. Requesting for assistance : request

Generates GPS coordinates of current location and sends it to HQ. Depending on type of assistance requested, either an ambulance or another patrol resource will be dispatched to said location

Format: 'request'

Examples:

  • request

  • Returns a set of GPS coordinates to HQ

3.10. Dispatch a PO : dispatch

Dispatches a specified PO

Format: 'dispatch PO(ID)'

Examples:

  • dispatch PO2

  • PO2 will receive a dispatch message

3.11. Lock System : lock

Locks the system and unlocks with password input

Format: 'lock'

Examples:

  • lock

  • Any user must enter their respective password to unlock

3.12. Update Password : update password

Updates password of user - only HQP can change the user’s password

Format: 'update password'

Examples:

  • update password

  • Please select a password to change

  • User then has to enter old and new alphanumeric password

3.13. Check notifications: inbox

For HQPs: Check inbox to see a list of dispatch requests made by POs, and are sorted based on severity first, and then time stamp. For POs: Check inbox to see who is responding to request for backup/ambulance/fire truck or to see if have any dispatch orders

Format: 'inbox'

Examples (as a HQP):

  • 'inbox'

  • Shows a list of dispatch requests (sorted by severity then timestamp) made by POs on the ground:

Examples (as a PO): * 'inbox' * Shows any dispatch messages by HQ or response for backup if any

3.14. Exit program : shutdown

Shutdown the system

Format: 'shutdown'

Examples: * shutdown * Police Records shuts down

4. Commands List

  • Help : 'help'

  • Add : 'add n/NAME n/NRIC d/DATE_OF_BIRTH p/POSTAL_CODE s/STATUS w/WANTED_FOR o/PAST OFFENCES…​'

E.g. add John Doe n/s1234567a d/1996 p/510246 s/xc w/none o/theft o/drugs E.g. add Bob n/g1234567a d/1996 p/111111 s/clear w/none

  • Edit : 'edit NRIC n/[NAME] p/[POSTAL_CODE] s/[STATUS] w/WANTED_FOR o/PAST_OFFENCES'

E.g. edit g1952866q p/510246

  • List : 'list'

  • Find : 'find NRIC'

E.g. find s1234567a

  • Check : 'check NRIC'

E.g. check s1234567a

  • Delete : 'delete NRIC'

E.g. delete g1952866q

  • Clear : 'clear'

  • Request for assistance : 'RA' (Ambulance) or 'RF' (Fire Brigade) or 'RB' (Backup)

  • Dispatch : 'dispatch PO(ID)'

E.g. dispatch PO2

  • Lock : 'lock'

  • Update Password : 'update password'

  • Check notifications : 'inbox'

  • Exit : 'shutdown'