Merge pull request #105 from junhaotan/master

Add notification popup window when product quantity drops below threshold

Author: junhaotan

docs/DeveloperGuide.adoc

@@ -235,6 +235,42 @@ image::CommitActivityDiagram.png[]
 ** Cons: Requires dealing with commands that have already been undone: We must remember to skip these commands. Violates Single Responsibility Principle and Separation of Concerns as `HistoryManager` now needs to do two different things.
 // end::undoredo[]
 
+// tag::managecustomer[]
+=== Add delete/edit/clear/list/find customer feature
+The manage product mechanism is facilitated by `InventorySystemParser`.
+First, the InventorySystemParser class parses the user command.
+This results in a Command object which is executed by the LogicManager.
+The command execution modifies Model's customer list depending on the command.
+The result of the command execution is encapsulated as a CommandResult object which is passed back to the Ui.
+
+The following commands are available to be parsed by InventorySystemParser:
+
+* `AddCustomerCommand` -- Adds a customer into the customer list in the inventory system.
+* `ListCustomerCommand` -- Lists all customers in the customer list.
+* `ClearCustomerCommand` -- Clears all customers in the customer list.
+* `DeleteCustomerCommand` -- Deletes a customer from the customer list in the inventory system.
+* `EditCustomerCommand` -- Edits a customer details (name, phone, email, address, tags)
+* `FindCustomerCommand` -- Finds customer with name containing given keyword(s)
+
+The commands all inherit from superclass `Command`. Only add, delete, edit and find commands require a command parser to parse the arguments entered by the user.
+
+The following sequence diagram shows how the add operation works:
+
+image::AddCustomerSequenceDiagram.png[]
+
+The following sequence diagram shows how the list operation works:
+
+image::ListCustomerSequenceDiagram.png[]
+
+The following sequence diagram shows how the edit operation works:
+
+image::EditCustomerSequenceDiagram.png[]
+
+The following activity diagram summarizes what happens when a user executes a command that changes the product list in the model:
+
+image::ProductActivityDiagram.png[]
+
+// end::managecustomer[]
 
 // tag::manageproduct[]
 === [Proposed] Add/ delete/ edit/ clear/ list/ find product feature

docs/images/AddCustomerSequenceDiagram.png

@@ -15,4 +15,5 @@ public class Messages {
     public static final String MESSAGE_TRANSACTIONS_LISTED_OVERVIEW = "%1$d transactions listed!";
     public static final String MESSAGE_INVALID_TRANSACTION_DISPLAYED_INDEX =
             "The transaction index provided is invalid";
+    public static final String MESSAGE_INVALID_THRESHOLD_AMOUNT = "Threshold amount must be more than 0!";
 }

docs/images/EditCustomerSequenceDiagram.png

@@ -1,16 +1,22 @@
 package seedu.address.logic.commands.product;
 
+import static seedu.address.logic.commands.product.EditProductCommand.EditProductDescriptor;
+import static seedu.address.logic.commands.product.EditProductCommand.createEditedProduct;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_PRODUCT;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_THRESHOLD;
 import static seedu.address.model.Model.PREDICATE_SHOW_ALL_PRODUCTS;
 
+import java.util.List;
+
+import seedu.address.commons.core.Messages;
 import seedu.address.commons.core.index.Index;
 import seedu.address.logic.commands.Command;
 import seedu.address.logic.commands.CommandResult;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
 import seedu.address.model.product.Product;
 import seedu.address.model.util.QuantityThreshold;
+import seedu.address.ui.NotificationWindow;
 
 /**
  * Sets the product low limit threshold for notifications.
@@ -31,6 +37,7 @@ public class LowLimitCommand extends Command {
     public static final String MESSAGE_SUCCESS = "New threshold set: %1$s";
 
     private final Index productIndex;
+    private final EditProductDescriptor editProductDescriptor = new EditProductDescriptor();
     private QuantityThreshold threshold;
 
     public LowLimitCommand(Index productIndex, QuantityThreshold threshold) {
@@ -40,10 +47,29 @@ public LowLimitCommand(Index productIndex, QuantityThreshold threshold) {
 
     @Override
     public CommandResult execute(Model model) throws CommandException {
-        Product product = model.getFilteredProductList().get(productIndex.getZeroBased());
-        product.setThreshold(threshold.toString());
+        List<Product> lastShownList = model.getFilteredProductList();
+
+        if (productIndex.getZeroBased() >= lastShownList.size()) {
+            throw new CommandException(Messages.MESSAGE_INVALID_PRODUCT_DISPLAYED_INDEX);
+        }
+
+        Product productToEdit = lastShownList.get(productIndex.getZeroBased());
+        int thresholdValue = Integer.parseInt(threshold.value);
+        if (thresholdValue > 0) {
+            editProductDescriptor.setThreshold(threshold);
+        } else {
+            throw new CommandException(Messages.MESSAGE_INVALID_THRESHOLD_AMOUNT);
+        }
+
+        Product editedProduct = createEditedProduct(productToEdit, editProductDescriptor);
+        model.setProduct(productToEdit, editedProduct);
         model.updateFilteredProductList(PREDICATE_SHOW_ALL_PRODUCTS);
 
-        return new CommandResult(String.format(MESSAGE_SUCCESS, product));
+        if (editedProduct.getQuantity().value < thresholdValue) {
+            NotificationWindow window = new NotificationWindow();
+            window.show(editedProduct.getDescription(), editedProduct.getQuantity());
+        }
+
+        return new CommandResult(String.format(MESSAGE_SUCCESS, editedProduct));
     }
 }

docs/images/ListCustomerSequenceDiagram.png

@@ -23,6 +23,7 @@
 import seedu.address.model.transaction.Transaction;
 import seedu.address.model.transaction.TransactionFactory;
 import seedu.address.model.util.Quantity;
+import seedu.address.ui.NotificationWindow;
 
 /**
  * Adds a transaction to the system.
@@ -64,8 +65,13 @@ public CommandResult execute(Model model) throws CommandException {
         List<Product> lastShownList = model.getFilteredProductList();
 
         Index productIndex = transactionFactory.getProductIndex();
+        Index customerIndex = transactionFactory.getCustomerIndex();
 
         if (productIndex.getZeroBased() >= lastShownList.size()) {
+            throw new CommandException(Messages.MESSAGE_INVALID_PRODUCT_DISPLAYED_INDEX);
+        }
+
+        if (customerIndex.getZeroBased() >= lastShownList.size()) {
             throw new CommandException(Messages.MESSAGE_INVALID_PERSON_DISPLAYED_INDEX);
         }
 
@@ -86,9 +92,17 @@ public CommandResult execute(Model model) throws CommandException {
             throw new CommandException(MESSAGE_DUPLICATE_TRANSACTION);
         }
 
+        int thresholdValue = Integer.parseInt(editedProduct.getThreshold().value);
+
+        if (editedProduct.getQuantity().value < thresholdValue) {
+            NotificationWindow window = new NotificationWindow();
+            window.show(editedProduct.getDescription(), editedProduct.getQuantity());
+        }
+
         model.setProduct(productToEdit, editedProduct);
         model.updateFilteredProductList(PREDICATE_SHOW_ALL_PRODUCTS);
 
+
         Transaction toAdd = transactionFactory.createTransaction(model);
 
         if (model.hasTransaction(toAdd)) {

src/main/java/seedu/address/commons/core/Messages.java

@@ -8,7 +8,6 @@
 import seedu.address.model.util.Description;
 import seedu.address.model.util.Quantity;
 import seedu.address.model.util.QuantityThreshold;
-import seedu.address.ui.NotificationWindow;
 
 /**
  * Represents a Product in the product list.
@@ -79,12 +78,6 @@ public QuantityThreshold getThreshold() {
 
     public void setThreshold(String quantityThreshold) {
         this.threshold = new QuantityThreshold(quantityThreshold);
-        int numQuantity = quantity.value;
-        int thresholdValue = Integer.parseInt(quantityThreshold);
-        if (numQuantity <= thresholdValue) {
-            NotificationWindow window = new NotificationWindow();
-            window.show(description, quantity);
-        }
     }
 
     /**

src/main/java/seedu/address/logic/commands/product/LowLimitCommand.java

@@ -47,6 +47,10 @@ public Index getProductIndex() {
         return productIndex;
     }
 
+    public Index getCustomerIndex() {
+        return customerIndex;
+    }
+
     public Quantity getQuantity() {
         return quantity;
     }