Front Desk Module Specs

The documented modules are:

• 2.1 Reservation done
• 2.1.1 Add Reservation done
• 2.1.2 Delete Reservation done
• 2.1.3 Modify Reservation done
• 2.2 Rooms
• 2.2.1 Search Rooms done
• 2.2.1.1 Find Guest In Room done
• 2.2.1.2 Find Availability Of Rooms done
• 2.3 In Room
• 2.3.1 Check In done
• 2.3.2 Check Out done
• 2.3.2.1 Print Invoice
• 2.4 Guest
• 2.4.1 Add Guest done
• 2.4.2 Modify Guest done
• 2.4.3 Search Guest done

---

• 2.1 Reservation
  • Called By:
    • Front Desk Menu
  • Calls:
    • Display Menu
    • Get Menu Choice
    • Add Reservation
    • Delete Reservation
    • Modify Reservation
  • Calling Sequence:
    1. Display Menu
    2. Get Menu Choice
    3. One or none of:
       • Add Reservation
       • Delete Reservation
       • Modify Reservation
  • Input:
    • Nothing
  • Output:
    • Nothing
  • Errors:
    • None
  • Description:
    • Allows the user to choose a function related to reservations. It uses the display menu and get menu choice functions to handle user interaction. If the user chooses no function, it returns to the caller.
  • Pseudocode:

    Display Reservation.form
    

• 2.1.1 Add Reservation
  • Called By:
    • Reservations
  • Calls:
    • Search Guest * guest ID
    • Add Guest * guest ID
    • Get Room Type * room type
    • Find Room Availability * room type
    • Get Arrival Date * arrival date
    • Get Duration of Stay * duration of stay
    • Get Check Out Date * check out date
    • Get Number of Occupants * number of occupants
  • Calling Sequence:
    1. Search Guest
    2. Add Guest
    3. Get Room Type
    4. Find Room Availability
    5. Get Arrival Date
    6. Get Duration Of Stay
    7. Get Check Out Date
    8. Get Number of Occupants
  • Input:
    • Nothing
  • Output:
    • In Room Relation
    • Booked By Relation
    • confirmation number
  • Errors:
    • No available rooms
  • Description:
    • Adds a reservation for the specified guest. If search guest fails, add guest is called for the new guest. Once all of the guest information is determined, an available room is found, and an in room and book by relation are added to the data stores. The confirmation number for the in room relation is display so that is can be conveyed to the customer.
  • Pseudocode:

    Display reservation.form
    If Guest = new
      Click_NewGuest
    Else 
      Get GuestID in corresponding text_box
      Click_SearchGuest
      If guest_found
        display confirmationID (auto-generated?)
        display guest_ID
        display guest_LastName
        display guest_FirstName
      else
        get guest_LastName
        get guest_FirstName
        Click_SearchGuest
        If guest_found
          continue
        else
          Add_new
        endif	
      endif  
    endif
    Get No_of_occupants 
    Get Single_Room_numbers
    Get Double_Room_numbers
    Get Delux_Room_numbers
    Click_SearchRoom
      If rooms = available
        Display Room#
      else
        Make Arrangement
      endif
    If everything = OK
      Get Arrival_Date
      Get CheckOut_Date
      Get Book_By(employID)
    endif
    If Click_ADD
      Update data store "In_Room"
    Endif
    If Click_Cancel
      Stop_Process
    Endif
    

• 2.1.2 Delete Reservation
  • Called By:
    • Reservations
  • Calls:
    • Get Confirmation Number * confirmation number
  • Calling Sequence:
    1. Get Confirmation Number
  • Input:
    • Nothing
  • Output:
    • Deletes In Room relation
    • Deletes Booked By relation
  • Errors:
    • No such reservation
    • Guest already checked-in
  • Description:
    • Asks the user for a confirmation number and deletes the associated reservation relations (ie. In Room and Booked By) if the guest has not already checked in.
  • Pseudocode:

    Get confirmation number 
    search in data store "In Room"
    If not found
      report this problem
    else
      display Guest ID
      display Last Name
      display First Name
      display No. of Occupants
      display Arrival Date
      display Check Out Date
      display Single Room needed
      display Double Room needed
      display Delux Room needed
      If Click_Delete
        confirm Delete process
        update datastore "In Room"
      endif
    endif
    

• 2.1.3 Modify Reservation
  • Called By:
    • Reservations
  • Calls:
    • Get Confirmation Number * confirmation number
    • Get Arrival Date * arrival date
    • Get Duraction of Stay * duration of stay
    • Get Check Out Date * check out date
    • Get Number of Occupants * number of occupants
  • Calling Sequence:
    1. Get Confirmation Number
    2. Get Arrival Date
    3. Get Duration of Stay
    4. Get Check Out Date
    5. Get Number of Occupants
  • Input:
    • Nothing
  • Output:
    • Modified In Room relation
  • Errors:
    • No such reservation
  • Description:
    • Modify a reservation based on the confirmaiton number. The arrival date, duration of stay, check out date, and number of occupants can be changed.
  • Pseudocode:

    Get Confirmation ID
    Search in data store "In Room"
    If not found
      report this problem
    else
      display Guest ID
      display Last Name
      display First Name
      display No. of Occupants
      display Arrival Date
      display Check Out Date
      display Single Room needed
      display Double Room needed
      display Delux Room needed
      change No. of Occupants if needed
      change Arrival Date if needed
      change check out date if needed
      change rooms need
      search in Room
        If Rooms = OK
          report "Update OK"
        else
          report this problem 
        endif
      If Click_Modify
        confirm Modify
        update data store "In_Room"
      endif
    endif
    

• 2.2 Rooms
  • Called By:
    • Front Desk Menu
  • Calls:
    • Search Rooms
    • Display Menu
    • Get Menu Choice
  • Calling Sequence:
    1. Display Menu
    2. Get Menu Choice
    3. One or none of:
       • Search Rooms
  • Input:
    • Nothing
  • Output:
    • Nothing
  • Errors:
    • None
  • Description:
    • Allows the user to choose a function related to searching for a room. It uses the display menu and get menu choice functions to handle user interaction. If the user chooses no function, it returns to the caller.
  • Pseudocode:

    DisplayMenu()
    
    switch(GetMenuChoice())
    {
    	case ChoiceSearchRooms:
    		SearchRooms()
    	
    	default:
    		Return To Caller
    }
    

• 2.2.1 Seach Rooms
  • Called By:
    • Rooms
  • Calls:
    • Find Availability Of Rooms
    • Find Guest In Room
    • Display Menu
    • Get Menu Choice
  • Calling Sequence:
    1. Display Menu
    2. Get Menu Choice
    3. One or none of:
       • Find Availability Of Rooms
       • Find Guest In Room
  • Input:
    • Nothing
  • Output:
    • Nothing
  • Errors:
    • None
  • Description:
    • Displays a menu so the user can choose which of the room search functions to use. Uses display menu and get menu choice for user interaction.
  • Pseudocode:

    DisplayMenu()
    
    switch(GetMenuChoice())
    {
    	case ChoiceFindAvailability:
    		FindAvailabilityOfRooms()
    		
    	case ChoiceFindGuestInRoom:
    		FindGuestInRoom()
    		
    	default:
    		Return To Caller
    }
    

• 2.2.1.1Find Guest In Room
  • Called By:
    • Search Rooms
  • Calls:
    • Get Room Number * room number
    • Get Date * date
    • Find Guest ID(room number, date)
    • Display Guest ID
  • Calling Sequence:
    1. Get Room Number
    2. Get Date
    3. Find Guest ID
    4. Display Guest ID
  • Input:
    • Nothing
  • Output:
    • Nothing
  • Errors:
    • No guest in specified room on specified date
  • Description:
    • Determines which guest is in the specified room on a specific date. Uses get room number, get date, and display guest to handle user interaction.
  • Pseudocode:

    RoomNumber = GetRoomNumber()
    
    Date = GetDate()
    
    GuestID = FindGuestID(RoomNumber, Date)
    
    DisplayGuestID(GuestID)
    

• 2.2.1.2 Find Availability Of Rooms
  • Called By:
    • Search Rooms
  • Calls:
    • Get Room Type * room type
    • Get Date * date
    • Find Free Room(room type, date)
    • Display List
  • Calling Sequence:
    1. Get Room Type
    2. Find Free Room
    3. Display List
  • Input:
    • Nothing
  • Output:
    • Nothing
  • Errors:
    • No rooms available
  • Description:
    • Finds the list of available rooms based on type and date. Uses display list to show the list once the rooms are found.
  • Pseudocode:

    RoomType = GetRoomType()
    
    Rooms = FindFreeRooms(RoomType)
    
    DisplayList(Rooms)
    

• 2.3 In Room
  • Called by:
    • Front Desk Menu
  • Calls:
    • Check In
    • Check Out
  • Calling Sequence:
    1. Check In
    2. Check Out
  • Input:
    • none
  • Output:
    • none
  • Errors:
    • none
  • Description:
    • A menu to select whether you want to check a guest into the hotel, or check them out.
• 2.3.1 Check In
  • Called by:
    • Front Desk
  • Calls:
    • get reservation
    • get guest info
    • update guest
    • update room status
  • Calling Sequence:
    1. get reservation
    2. get guest info
    3. update room status
  • Inputs:
    • confirmation ID
    • guest ID
    • guest last name
    • guest first name
    • address
    • city
    • province/state
    • country
    • credit card #
    • credit card exp
    • type of photo ID
    • discount name
    • discount number
    • discount rate
    • phone number
  • Outputs:
    • none
  • Errors:
    • Confirmation ID not exist
  • Description:
    • Checks the guest into the hotel. If they have a reservation, then it calls Guest to get the guest info. Get guest info is called to get all the information if not present on the system, or if there is no reservation.
  • Pseudocode:

    Get confirmation ID
    if reservation exists
      display Guest ID
      display Last Name
      display First Name
      display No. of Occupants
      display Arrival Date
      display Check Out Date
      display Single Room needed
      display Double Room needed
      display Delux Room needed
      update guest info
      If click_OK
        confirm check-in
        update room info in datastore "In Room"
      endif
    endif
    

• 2.3.2 Check Out
  • Calls:
    • Get Guest Info
    • Get Invoice
    • Print Invoice
    • Update room status
    • Update cleaning schedule
    • Check out guest status
  • Calling Sequence:
    1. Get guest info
    2. Get Invoice
    3. Print Invoice
    4. Add available room status
    5. Add to cleaning schedule
    6. Check out guest status
  • Inputs:
    • guest ID
    • guest last name
    • guest first name
    • payment method
    • employeeID
  • Outputs:
    • none
  • Errors:
    • guest not found
  • Description:
    • The guest checks out, and the system generates an invoice, by calling Print Invoice. Then the room status of the guest's room(s) are changed to available, and the cleaning schedule is updated to include the room(s). The guest's status is also updated to indicate they've checked out.
  • Pseudocode:

    get GuestID
    get Last name
    get First Name
    Search for guest rooms
    If guest_found
      Display charges
      get payment method
      generate invoice
      print invoice
      update room status
    endif
    

• 2.3.2.1 Print Invoice
  • Called by:
    • Check Out
  • Calls:
    • get invoice
  • Calling Sequence:
    1. get invoice
  • Inputs:
    • conformation number
  • Outputs:
    • none
  • Errors:
    • guest not found
  • Description:
    • The guest's invoice is obtained through get invoice, and the invoice is printed out to the screen and/or the printer if necessary.
  • Pseudocode:

    get invoice
    display invoice.invoice number
    display invoice.date
    display invoice.time
    display invoice.payment method
    display invoice.total bill
    display invoice.food order
    display invoice.movie order
    display invoice.telephone bill
    display invoice.misc. charges
    display invoice.hotel tax
    display invoice.GST
    

• 2.4 Guest
  • Called by:
    • Front Desk Menu
  • Calls:
    • Add *Guest Information
    • Delete *Guest Information
    • Modify *Guest Information
    • Search *Guest information
  • Calling Sequence:
    • Any sequence.
  • Input:
    • Click option
  • Output:
    • None
  • Errors:
    • None
  • Description:
    • Shows the menu functions for handling guest information.
• 2.4.1 Add Guest
  • Called by:
    • Guest
  • Calls:
    • Read Guest Data *Guest Information
    • Check Guest Information *Guest Information
    • Save Guest Information *Guest Information
  • Calling Sequence:
    1. Read Guest Data *Guest Information
    2. Check Guest Information *Guest Information
    3. Save Guest Information *Guest Information
  • Input:
    • guest first name
    • guest last name
    • address
    • city
    • province/state
    • postal code/zip code
    • country
    • credit card type
    • credit card number
    • credit card name
    • type photo ID
    • discount name
    • discount percentage
  • Output:
    • guest ID
  • Errors:
    • All the data should have the right format, or the input would have to be repeated.
  • Description:
    • This function inputs the new guest information, into the Guest Data Base. It includes all the relevant data to the system. It calls one function to read all the data, then calls other function to verify the data. If all the information is correct then it saves it into the database. It returns the guest ID.
  • Pseudocode:

    if input(s) from staff are syntactically incorrect then
       Report this problem
    else 	
       input_ok = true
       Attempt to read a Guest Record with given Guest Name from data store
          "Guest"
       if this attempt fails
           Add the New Guest data into the data store "Guest"
           Update the data store "Guest"
           Get the New Guest I.D. from the data store "Guest"
       else 
           Report that New Guest already exists in data store "Guest"
           Return Guest I.D.
       end if
    end if

• 2.4.2 Modify Guest
  • Called by:
    • Guest
  • Calls:
    • Search Guest (guest ID, last name, room number)
    • Display Information *Guest Information
    • Check new Information *Guest Information
    • Save Changes *Guest Information
  • Calling Sequence :
    1. Search Guest (guest ID, last name, room number)
    2. Display Information *Guest Information
    3. Check new Information *Guest Information
    4. Save Changes *Guest Information
  • Input:
    • New Guest Information
  • Output:
    • Confirmation of changes made.
  • Errors:
    • Guest not found in the Guest Data Base.
  • Description:
    • The function will allow the user to change/modify some information of the guest data base. It calls a function that search the guest information, then it calls a function to display all the information that matched the search the user the choose the guest data for making the changes. After that, it calls a function that checks the new input. If the input is correct then calls a function that saves the new data into the data base. If the guest is not found, there is no changes. At the end of the function it displays the confirmation of the changes made.
  • Pseudocode:
    

    
    if input(s) from staff are syntactically incorrect then
       Report this problem
    else 	
       input_ok = true
       If staff input is room number then
    	Attempt to read an invoice with given room number from data store 
    	"Guest"
       end if
       If staff input is Guest ID then
    	Attempt to read an invoice with given Guest I.D. from data store 
    	"Guest"
       end if
       If staff input is Guest Name then
    	Attempt to read an invoice with given Guest Name from data store 
    	"Guest"
       end if
       if this attempt fails
          Report there is no Guest with given Guest Data
       else  
             if input_ok then
                if staff input included Guest's Name then
                   Replace the Guest's Name with the one given in 
                      input
                end if
                if staff input included address then
                   Replace the Guest's address with the one given in 
                      input
                end if
                if staff input included city then
                   Replace the Guest's city with the one given in 
                      input
                end if
                if staff input included province/state then
                   Replace the guest's province/state with the one given in input
                end if
                if staff input included postal code/zip code then
                   Replace the guest's postal code/zip code with the 
    	       one given in input
                end if
                if staff input included country then
                   Replace the guest's country with the one given in input
                end if
                if staff input included credit card type then
                   Replace the guest's credit card type with the one given in input
                end if
                if staff input included credit card number then
                   Replace the guest's credit card number with the 
    	       one given in input
                end if
                if staff input included credit card name then
                   Replace the guest's credit card name with the one given in input
                end if
                if staff input included type photo I.D. then
                   Replace the guest's type photo I.D. with the one given in input
                end if
                if staff input included discount name then
                   Replace the guest's discount name with the one given in input
                end if
                if staff input included discount percentage then
                   Replace the guest's discount percentage with the 
    	       one given in input
                end if
             end if
          end if
          Report successful
       end if
    end if 
    
    

• 2.4.3 Search Guest
  • Called by :
    • Guest
  • Calls:
    • Search Guest (guest ID, last name, room number)
    • Display Information *Guest Information
  • Calling Sequence:
    1. Search Guest (guest ID, last name, room number)
    2. Display Information
  • Input:
    • Guest ID and/or last name and/or room number
  • Output:
    • none
  • Errors:
    • Guest not found in Guest Data Base
  • Description:
    • This function allow the user to view all the relevant guest information of the guest in the guest data base. It calls a function that sear the guest information. Then it shows all the matches found with the search by calling the display function. If there is no guest match, then it show an error message.
  • Pseudocode:
    

    
    if input(s) from staff are syntactically incorrect then
       Report this problem
    else 	
       input_ok = true
       If staff input is room number then
    	Attempt to read an invoice with given room number from data store 
    	"Guest"
       end if
       If staff input is Guest ID then
    	Attempt to read an invoice with given Guest I.D. from data store 
    	"Guest"
       end if
       If staff input is Guest Name then
    	Attempt to read an invoice with given Guest Name from data store 
    	"Guest"
       end if
       if this attempt fails
          Report there is no Guest with given Guest's Data
       else 
          Report the resulting "Guest" to the staff
          Report successful
       end if
    end if