Skip to content

UserGuide.md

Latest commit

 

History

History
189 lines (134 loc) · 5.2 KB

UserGuide.md

File metadata and controls

189 lines (134 loc) · 5.2 KB

User Guide for Busyness Manager

First-Time Setup:

  • Define business information
    • Input:
      • Business ID: A whole number
      • Business name: A set of words
      • Business password: A sequence of letters
      • Business type: FNB or RETAIL (case-sensitive)

Features:

  • Login

    • Requires business ID and password.
    • Subsequent features can be accessed after logging in.

  • Viewing Help: help

    • Provides possible command instructions and expected formatting.

  • Adding a Product: add

    • Adds a product to the products-for-sale list.

  • Deleting a Product: delete

    • Removes a product from the products-for-sale list.

  • Changing Info of Products: update

    • Updates data of a specified product in the products-for-sale list.
    • Data to be updated must be specified during command input.

  • Printing List of Products: print

    • Prints the entire list of products for sale (according to product ID).

  • Incrementing Sold Product Value, Decrementing Inventory Value: sold

    • Changes the quantity of available inventory and the quantity sold.

  • Clear the Quantity Sold: clear

    • Changes the quantity sold of a specified product to 0.

  • Compute Total Amount of Sale Transactions: revenue

    • Adds up all the products sold, multiplied by their respective prices.
    • Given a product ID, provides the revenue of a specified product.

  • Search for a Product: search

    • Given a product name, searches for the corresponding product.
    • Given a product ID, searches for the corresponding product.

Command Summary:

IMPORTANT: Add a slash (/) in front of any tag.

Adding a Product

add /name P_NAME /qty P_QTY /price P_PRICE

  • Creates a new product object & attaches different attributes to it (with an auto-generated ID).
  • Tags:
    • /name → Name of the product to create.
    • /qty → Quantity of the product to create that is available for sale.
    • /price → Price of the product to create.

Example:

  • Input -> add /name MILK /qty 50 /price 2.50
  • Output ->Product added: ID_0001: MILK | Qty: 50 | Sold: 0 | Price: $2.50

Deleting a Product

delete /id P_ID

  • Deletes a specified product with the given ID.
  • Tags:
    • /id → ID of the product to delete (just the non-zero part will suffice).

Example:

  • Input -> delete /id 1
  • Output -> Product removed: ID_0001: MILK | Qty: 50 | Sold: 0 | Price: $2.50

Updating a Product

update /id P_ID /name NEW_NAME /qty NEW_QTY /price NEW_PRICE

  • Changes one or more attributes of a specified product.
  • Tags:
    • /id → ID of the product to modify (just the non-zero part will suffice).
    • /name → New name of the product to modify.
    • /qty → New quantity of the product to modify.
    • /price → New price of the product to modify.

Example:

  • Input -> update /id 1 /name FRESH_MILK /qty 45 /price 3
  • Output -> Product updated: ID_0001: FRESH_MILK | Qty: 45 | Sold: 0 | Price: $3.00

Printing Product List

print

  • Prints the current list of products.
  • Attributes displayed:
    • Product ID
    • Product name
    • Quantity of product not sold
    • Quantity of product sold
    • Product price

Example:

  • Input -> print
  • Output -> Product list: (next line) ID_0001: FRESH_MILK | Qty: 45 | Sold: 0 | Price: $3.00

Format of Product List: ID_NUMBER: PRODUCT_NAME | QTY | QTY_SOLD | PRICE

Recording a Sale

sold /id P_ID /qty QTY_SOLD

  • Changes the sales record and updates the inventory list.
  • Tags:
    • /id → ID of the product that was sold (just the non-zero part will suffice).
    • /qty → Quantity of the product that was sold.

Example:

  • Input -> sold /id 1 /qty 5
  • Output -> Sales recorded: Product ID: ID_0001, Quantity Sold: 5

Clearing Sold Quantity

clear /id P_ID

  • Sets the quantity sold to zero for the specified product.
  • Tags:
    • /id → ID of the product to clear (just the non-zero part will suffice).

Example:

  • Input -> clear /id 1
  • Output -> Sales cleared: Product ID: ID_0001

Computing Revenue

revenue OR revenue /id P_ID

  • Computes the total amount of revenue.
  • Optional /id tag (to check revenue for a specific product).

Example (Overall Revenue):

  • Input -> revenue
  • Output -> Revenue of FRESH_MILK: 15.00 (next line) Total Revenue: 15.00

Example (Specific Product Revenue):

  • Input -> revenue /id 1
  • Output -> Revenue of FRESH_MILK: 15.00

Searching for a Product

search /name P_NAME

  • Returns the ID of the product that matches the given name.
  • Tags:
    • /name → Name of product to search for.

Example:

  • Input -> search /name FRESH_MILK
  • Output -> Product ID of FRESH_MILK: ID_0001

Searching for a Product by ID

search /id P_ID

  • Returns the name of the product that matches the given ID.
  • Tags:
    • /id → ID of the product to search for (just the non-zero part will suffice).

Example:

  • Input -> search /id 1
  • Output -> Product name of ID_0001: FRESH_MILK