Interface TravellerService

All Known Subinterfaces:
ShoppingTravellerService
All Known Implementing Classes:
DefaultShoppingTravellerService, DefaultTravellerService

public interface TravellerService
Traveller Service interface provides Traveller specific services
  • Method Details

    • createTraveller

      TravellerModel createTraveller(String travellerType, String passengerType, String travellerCode, int passengerNumber, String travellerUidPrefix)
      Create traveller traveller model.
      Parameters:
      travellerType - the traveller type
      passengerType - the passenger type
      travellerCode - the traveller code
      passengerNumber - the passenger number
      travellerUidPrefix - the traveller uid prefix
      Returns:
      traveller model
    • createTraveller

      TravellerModel createTraveller(String travellerType, String passengerType, String travellerCode, int passengerNumber, String travellerUidPrefix, String orderOrCartCode)
      Create traveller traveller model.
      Parameters:
      travellerType - the traveller type
      passengerType - the passenger type
      travellerCode - the traveller code
      passengerNumber - the passenger number
      travellerUidPrefix - the traveller uid prefix
      orderOrCartCode - the order or cart code that needs to be set in the versionID
      Returns:
      traveller model
    • getExistingTraveller

      TravellerModel getExistingTraveller(String uid) throws de.hybris.platform.servicelayer.exceptions.ModelNotFoundException
      Returns the Traveller in the system identified by the given uid
      Parameters:
      uid - The traveller Uid
      Returns:
      TravellerModel existing traveller
      Throws:
      de.hybris.platform.servicelayer.exceptions.ModelNotFoundException - the model not found exception
    • getExistingTraveller

      TravellerModel getExistingTraveller(String uid, String versionID) throws de.hybris.platform.servicelayer.exceptions.ModelNotFoundException
      Returns the Traveller in the system identified by the given uid and versionID
      Parameters:
      uid - The traveller Uid
      versionID - The traveller versionID
      Returns:
      TravellerModel existing traveller
      Throws:
      de.hybris.platform.servicelayer.exceptions.ModelNotFoundException - the model not found exception
    • getTravellerFromCurrentCart

      TravellerModel getTravellerFromCurrentCart(String travellerCode)
      Returns the Traveller identified by the code in the current Session Cart if present, null otherwise
      Parameters:
      travellerCode - The code that identifies a Traveller in the Cart
      Returns:
      TravellerModel or null
    • getTravellerFromCurrentCartByUID

      @Deprecated(since="2003", forRemoval=true) TravellerModel getTravellerFromCurrentCartByUID(String travellerUID, CartModel cartModel)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since 2003
      Returns the Traveller identified by the code in the current Session Cart if present, null otherwise
      Parameters:
      travellerUID - The code that identifies a Traveller in the Cart
      cartModel -
      Returns:
      TravellerModel or null
    • getTravellersPerLeg

      Map<Integer,List<TravellerModel>> getTravellersPerLeg(AbstractOrderModel abstractOrderModel)
      Retrieves a list of travellers for each leg of the journey based on abstract order entries
      Parameters:
      abstractOrderModel - - given cart/order model
      Returns:
      list of travellers for each leg of the journey
    • getTravellers

      List<TravellerModel> getTravellers(List<AbstractOrderEntryModel> abstractOrderEntryModels)
      Method takes a list of AbstractOrderEntryModel and turns a unique list of traveller models
      Parameters:
      abstractOrderEntryModels - the abstract order entry models
      Returns:
      travellers
    • findSavedTravellersUsingFirstNameText

      List<TravellerModel> findSavedTravellersUsingFirstNameText(String nameText, String passengerType, CustomerModel customer)
      Retrieves a list of saved travelers against a current customer using a text inputed as part of first name field
      Parameters:
      nameText -
      passengerType -
      customer -
      Returns:
    • findSavedTravellersUsingLastNameText

      List<TravellerModel> findSavedTravellersUsingLastNameText(String nameText, String passengerType, CustomerModel customer)
      Retrieves a list of saved travelers against a current customer using a text inputed as part of last name field
      Parameters:
      nameText -
      passengerType -
      customer -
      Returns:
    • getCartTravellerForUid

      TravellerModel getCartTravellerForUid(String uid, CartModel cart)
      Returns the traveller by the uid for given cart.
      Parameters:
      uid - the uid of the traveller to retrieve
      cart - the current cart
      Returns:
      the traveller
    • getTravellersFromOrder

      List<TravellerModel> getTravellersFromOrder(OrderModel order)
      Returns the travellers from order.
      Parameters:
      order - the order
      Returns:
      the list of travellers