Amos Cheong - Project Portfolio

Here are the steps on using the insert Command:

Step 1 : Type in the keyword insert

Step 2 : Add in the prefixes TRANSACTION_ID CUSTOMER_NAME ADDRESS PHONE_NUMBER EMAIL DELIVERY_DATE_AND_TIME WAREHOUSE_LOCATION CASH_ON_DELIVERY of the delivery orders

Step 3 (Optional) : Add in the Customer comment and type of item using the prefixes [COMMENT_BY_CUSTOMER] [TYPE_OF_ITEM]

Step 4 : Press Enter on your keyboard to see the magic!

Here is the syntax of the insert Command :
insert tid/TRANSACTION_ID n/CUSTOMER_NAME a/ADDRESS p/PHONE_NUMBER e/EMAIL dts/DELIVERY_DATE_AND_TIME w/WAREHOUSE_LOCATION cod/CASH_ON_DELIVERY [COMMENT_BY_CUSTOMER] [TYPE_OF_ITEM]

These are the possible combinations of the insert command:

Here are the steps to execute the list command:

Step 1 : Type in the keyword list.

Step 2 : If you want to simply see all your delivery and return orders. Otherwise, please proceed to Step 3. Else, skip to Step 4

Step 3 : Provide the following [KEYWORD] : done (Show all your completed orders) or undone (Show all your uncompleted orders)

Step 4 : Press Enter on your keyboard and see the magic!

The syntax of a valid list command is as shown: list [KEYWORD]

These are the possible combinations of the list command:

In this section, you will learn how to use the show Command.

Here is how you can show the statistics of your orders:

Step 1 : Type show

Step 2 : If you want to see your statistics for all the orders, simply type all and skip to Step 5

Step 3 : Type today to show the statistics for today or simply type in a date in a date format of yyyy-mm-dd

Step 4 (Optional) : Type another date in yyyy-mm-dd format to see the statistics within the date range. This date must be after or equal to the date provided previously

Step 5 : Press Enter on your keyboard to see the magic!

In this section, you will learn about the correct syntax for a valid show command and all the different combinations of the command.

All the syntax for a valid show command is shown below:

These are the possible combinations of the show command:

The insert feature allows the user to insert an incoming delivery order into the list using the command line.

The order consists of : Transaction ID, Name, Phone, Address, Email, Delivery Timestamp, Warehouse location, CashOnDelivery

The order also consists of two optional fields that can be added:

The overview of the InsertCommand Activity Diagram is shown below:

After the user calls the insert command, the code will check if the command has all the compulsory prefixes present. The code will throw a ParseException when there are missing prefixes. After that is checked, it will check if the new order added is a duplicate (The Order is already inserted into the application). It will throw a CommandException when the user tries to insert a duplicate order. Otherwise, it will insert the order and prints a success message to the user.

The following diagrams shows the overview of the InsertCommand Class Diagram:

The above class diagram shows the structure of the InsertCommand and its associated classes and interfaces. Some methods and fields are not included because they are not extensively utilised in InsertCommand; such as public static fields and getter/setter methods.

The above class diagram shows the structure of the InsertCommandParser and its associated classes and interfaces. It describes all the class dependencies of the InsertCommandParser class. Some methods and fields are not included because they are not extensively utilised in InsertCommand; such as public static fields and getter/setter methods. As shown in the diagram above, the InsertParser make use of methods from classes such as using the getValue method from the ArgumentMultimap class.

Here is the sequence diagram for the Insert Command as shown below:

The arguments of the insert command will be parsed using the parse method of the InsertCommandParser class.
The InsertCommandParser will tokenize the arguments parsed in using the tokenize method of ArgumentTokenizer class which returns the tokenized arguments. Using the tokenized arguments, the Parser will check if the arguments parsed in matches with the tokenized arguments using the arePrefixesPresent method.

There are two scenarios :

LogicManager will call the execute() method of this InsertCommand object. In the execute() method, it will use the Model class to call hasOrder method to check for duplicates, if it is a duplicate, the order will throw a CommandException which indicates that there is a duplicate order in the OrderBook already. Else, it will successfully inserts the new order using addOrder method. Finally, it return a new CommandResult object, containing a String that indicates a successful insertion.

List feature allows the user to see all the orders from both Delivery Orders and Return Orders.

The user can enter list to display all the orders. Besides that, the user can also input done to display all delivered orders and undone to display all orders that are not delivered.

The above activity diagram shows the logic and the path execution when the list command is executed. There are only three correct syntax available for ListCommand:

The code will check if the input is one of the three mentioned above. If the input is not one of the three, it will cause the code the throw an error message to the user.

The structure of the List Feature is as shown below:

The above class diagram shows the structure of the ListCommand and all its associated classes and interfaces. The ListCommand has dependencies on the Model class as it uses the two methods from it :

There are other variables and strings not shown in this Class Diagrams as they are either static methods or variables.

The sequence diagram for the list command is shown below:

The user first calls the command list.

The LogicManager will call the parseCommand method of DelinoParser, which then passes the second argument into the ListCommand object. This object will then be ultimately returned to the LogicManager. Next, the LogicManager will call the execute(model) method using the ListCommand object. In this method, it wil use the Model object to call the methods : updateFilteredOrderList and updateFilteredReturnOrderList. Since in this case, the argument is empty, the predicate that is parsed to the two methods will always result to true, which means to list everything from the order book and return book. When completed, the execute(model) will return a CommandResult object to the LogicManager, indicating that the command execution is a success.

The show feature allows the user to see the statistical information of all the orders for both Delivery Orders and Return Orders.

There are a few ways in which the user can input to the command box to execute the show command:

The above activity diagram shows the logic and the path execution when the show command is executed.

The main logic of the ShowCommand is to check if the number of arguments in the input besides show is one or two. If it is neither, the code will throw an exception. If there is only one argument, the code will check if the word provided is either all or today or simply just a DATE the value of DATE will be validated to check if it is a valid date. It throws an error if it is invalid. When its correct, the code will execute the input accordingly. If the number is two arguments, it will check if the dates provided are valid or invalid date. It throws an error for the latter. The code will then ensure that the START_DATE is before the END_DATE. Once the input passes all the validations in the ShowCommand code, the command will then be executed and it prints a success message to the user.

The structure of the show feature is as shown below:

The above diagram shows all the methods and variables that the ShowCommand class is using when the command is executed. All the static methods and variables are not mentioned in this diagram. Furthermore, there are some methods and variables omitted from this diagram as it is irrelevant to the ShowCommand class.

The sequence diagram for the show command is shown below:

The user first calls the command "show all".

The LogicManager will call the parseCommand method of DelinoParser, which then passes the second argument into the ShowCommand object. Within the object, it will call the parseData method to make sense of the dates given. After that, it returns the object to the LogicManager. Next, the LogicManager will call the execute(model) method using the ShowCommand object. When completed, the execute(model) will return a CommandResult object to the LogicManager, indicating that the command execution is a success. In this case where the input is "show all", it will have a message that indicates that the command is showing all information.