Interface SearchExportService

  • All Superinterfaces:
    JobService

    public interface SearchExportService
    extends JobService
    Export search results from a search request.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String exportASync​(com.flower.docs.domain.component.Category category, com.flower.docs.domain.search.SearchRequest request, java.util.Locale locale)
      Get CSV file from a search request in asynchronous mode
      java.io.InputStream exportSync​(com.flower.docs.domain.component.Category category, com.flower.docs.domain.search.SearchRequest request, java.util.Locale locale)
      Get CSV file from a search request in synchronous mode
      com.flower.docs.domain.search.SearchResponse search​(com.flower.docs.domain.component.Category category, com.flower.docs.domain.search.SearchRequest request)
      Get search response
    • Method Detail

      • search

        com.flower.docs.domain.search.SearchResponse search​(com.flower.docs.domain.component.Category category,
                                                            com.flower.docs.domain.search.SearchRequest request)
                                                     throws com.flower.docs.domain.exception.FunctionalException,
                                                            com.flower.docs.domain.exception.TechnicalException
        Get search response
        Parameters:
        category - The component's category
        request - The search request
        Throws:
        com.flower.docs.domain.exception.FunctionalException - If a functional error occurred
        com.flower.docs.domain.exception.TechnicalException - If a technical error occurred
      • exportSync

        java.io.InputStream exportSync​(com.flower.docs.domain.component.Category category,
                                       com.flower.docs.domain.search.SearchRequest request,
                                       java.util.Locale locale)
                                throws com.flower.docs.domain.exception.TechnicalException,
                                       com.flower.docs.domain.exception.FunctionalException,
                                       java.io.IOException
        Get CSV file from a search request in synchronous mode
        Parameters:
        category - The component's category
        request - The search request
        locale - The localization configuration
        Throws:
        com.flower.docs.domain.exception.FunctionalException - If a functional error occurred
        com.flower.docs.domain.exception.TechnicalException - If a technical error occurred
        java.io.IOException
      • exportASync

        java.lang.String exportASync​(com.flower.docs.domain.component.Category category,
                                     com.flower.docs.domain.search.SearchRequest request,
                                     java.util.Locale locale)
                              throws com.flower.docs.domain.exception.TechnicalException,
                                     com.flower.docs.domain.exception.FunctionalException,
                                     java.io.IOException
        Get CSV file from a search request in asynchronous mode
        Parameters:
        category - The component's category
        request - The search request
        locale - The localization configuration that the would be used to determine the date format in the CSV file
        Throws:
        com.flower.docs.domain.exception.FunctionalException - If a functional error occurred
        com.flower.docs.domain.exception.TechnicalException - If a technical error occurred
        java.io.IOException