Interface AncillaryProductService

All Known Implementing Classes:
DefaultAncillaryProductService

public interface AncillaryProductService
  • Method Details

    • getAncillaryProducts

      ServiceData getAncillaryProducts(int pageNumber, Map<String,Object> searchFilterMap)
      This method returns the Ancillary Products by calling pros service.
      Parameters:
      pageNumber - the page number
      searchFilterMap - the map of filters to apply to the request
      Returns:
      the list of Ancillary Products
    • getNonATPCOAncillaryProducts

      ServiceData getNonATPCOAncillaryProducts(int pageNumber)
      This method returns the NonATPCO Ancillary Products by calling pros service.
      Parameters:
      pageNumber - the page number
      Returns:
      the list of Ancillary Products
    • getAncillaryProduct

      AncillaryProduct getAncillaryProduct(String serviceId)
      This method returns the Ancillary Product by calling pros service.
      Parameters:
      serviceId - the serviceId
      Returns:
      the list of Ancillary Products
    • createAncillaryProducts

      boolean createAncillaryProducts(AncillaryProduct ancillaryProduct) throws org.springframework.web.client.HttpServerErrorException, org.springframework.web.client.HttpClientErrorException, org.springframework.web.client.ResourceAccessException
      This method will create ancillary product in pros
      Parameters:
      ancillaryProduct - the ancillaryProduct
      Returns:
      the boolean, return true if ancillary product is created in pros else return false
      Throws:
      org.springframework.web.client.HttpServerErrorException - the exception when http response is not 200 e.g. status 5xx
      org.springframework.web.client.HttpClientErrorException - the exception when http response is not 200 e.g. status 4xx
      org.springframework.web.client.ResourceAccessException - the resource is not accessible exception
    • updateAncillaryProduct

      boolean updateAncillaryProduct(AncillaryProduct ancillaryProduct, String serviceId) throws org.springframework.web.client.HttpServerErrorException, org.springframework.web.client.HttpClientErrorException, org.springframework.web.client.ResourceAccessException
      This method will update ancillary product in pros
      Parameters:
      ancillaryProduct - the ancillaryProduct
      serviceId - the serviceId
      Returns:
      the boolean, return true if ancillary product is updated in pros else return false
      Throws:
      org.springframework.web.client.HttpServerErrorException - the exception when http response is not 200 e.g. status 5xx
      org.springframework.web.client.HttpClientErrorException - the exception when http response is not 200 e.g. status 4xx
      org.springframework.web.client.ResourceAccessException - the resource is not accessible exception
    • removeAncillaryProduct

      boolean removeAncillaryProduct(AncillaryProduct ancillaryProduct)
      This method removes the ancillary product from the pros and will change sap ancillary product status from approved to unapproved
      Parameters:
      ancillaryProduct - the ancillaryProduct
      Returns:
      the boolean, return true if ancillary product is removed in pros else return false
    • getServiceKeys

      List<ServiceKey> getServiceKeys(String serviceType, List<String> carriers)
      This method returns the service keys by calling pros service.
      Parameters:
      serviceType - the service type
      carriers - the carriers
      Returns:
      the list of ServiceKey
    • getServiceKeys

      List<String> getServiceKeys(Category category)
      This method returns the sub codes for a given category.
      Parameters:
      category - The category for the sub codes
      Returns:
      list of service sub codes
    • getATPCOServices

      ServiceData getATPCOServices(String carrierCode, Integer pageNumber, Integer pageSize)
      This method returns the ATPCO services from the Merchandising Data service.
      Parameters:
      carrierCode - the carrier to filter the request basing on them
      pageNumber - the number of page to send for the pagination configuration
      pageSize - the number of the entries in a single page
      Returns:
      the list of ATPCO services