Package co.mastermindcms.modules.services

Interface MarketingService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String generateDashlyHash()
      This method generates the hash with algorithm HMAC SHA 256 for Dashly Analytics Platform
      java.util.List<ContactsReport> getContactsReport​(co.mastermindcms.modules.beans.SearchRequest request)
      Retrieves a list of ContactsReport objects based on the given search request.
      java.util.List<CustomerReport> getCustomersReport​(co.mastermindcms.modules.beans.SearchRequest request)
      This method is used to generate a report which contains all registered customers
      java.util.Deque<java.util.Map<java.lang.String,​java.lang.Object>> getPaginationAnalyticsData​(java.lang.String requestJson)
      This method does calculation for a pages based on the request.
      java.util.Map<java.lang.String,​java.lang.Object> getSeoMetaData​(java.lang.String seoUrl, java.lang.String repositoryName)
      This method does search request for database entity based on seo URL property
      java.util.List<SEOMetaDataReport> getSeoMetaDataReport​(co.mastermindcms.modules.beans.SearchRequest request)
      Retrieves SEO metadata report based on the specified search request.
      java.lang.String getSeoUrl​(java.lang.String id, java.lang.String repositoryName)
      This method does search request for seo URL property
      java.util.Map<java.lang.String,​java.lang.Object> getSeoUrlAsValue​(java.lang.String id, java.lang.String repositoryName)
      This method does search request for seo URL property
      java.lang.String getSeoUrlByLang​(java.lang.String id, java.lang.String lang, java.lang.String repositoryName)
      This method does search request for seo URL property
      boolean saveSearchRequest​(java.lang.String searchTerm)
      Saves the search request with the specified search term.
      java.util.LinkedHashSet<UserAuditSettings> searchUserAnalytics​(java.lang.String requestJson)
      This method does search requests and returns data as list.
      org.springframework.data.domain.Page<UserAuditSettings> searchUserAnalyticsPaged​(java.lang.String requestJson)
      This method does search requests and returns data as pages.
      void uploadSEO​(java.io.File file, java.lang.String lang, java.lang.String username)
      Uploads SEO information from a given file for a specific language and user.

    • Method Detail

      • searchUserAnalytics

        java.util.LinkedHashSet<UserAuditSettings> searchUserAnalytics​(java.lang.String requestJson)
        This method does search requests and returns data as list.
        Parameters:
        requestJson - search request
        Returns:
        data transport entities as list

      • searchUserAnalyticsPaged

        org.springframework.data.domain.Page<UserAuditSettings> searchUserAnalyticsPaged​(java.lang.String requestJson)
        This method does search requests and returns data as pages.
        Parameters:
        requestJson - JSON-object of request contains an instructions for search queries
        Returns:
        database entities separated to pages

      • getPaginationAnalyticsData

        java.util.Deque<java.util.Map<java.lang.String,​java.lang.Object>> getPaginationAnalyticsData​(java.lang.String requestJson)
        This method does calculation for a pages based on the request.
        Parameters:
        requestJson - JSON-object of request contains an instructions for search queries
        Returns:
        map-representation of data

      • getCustomersReport

        java.util.List<CustomerReport> getCustomersReport​(co.mastermindcms.modules.beans.SearchRequest request)
        This method is used to generate a report which contains all registered customers
        Parameters:
        request - the search request containing the criteria for fetching the report
        Returns:
        a list of entities for each customer

      • getContactsReport

        java.util.List<ContactsReport> getContactsReport​(co.mastermindcms.modules.beans.SearchRequest request)
        Retrieves a list of ContactsReport objects based on the given search request.
        Parameters:
        request - the search request containing the criteria for fetching the ContactReports
        Returns:
        a list of ContactsReport objects that match the search request criteria

      • getSeoMetaDataReport

        java.util.List<SEOMetaDataReport> getSeoMetaDataReport​(co.mastermindcms.modules.beans.SearchRequest request)
        Retrieves SEO metadata report based on the specified search request.
        Parameters:
        request - the search request to retrieve SEO metadata report for
        Returns:
        a CompletableFuture with a list of SEOMetaDataReport objects representing the SEO metadata report

      • generateDashlyHash

        java.lang.String generateDashlyHash()
        This method generates the hash with algorithm HMAC SHA 256 for Dashly Analytics Platform
        Returns:
        hash calculated by the HMAC SHA 256

      • getSeoMetaData

        java.util.Map<java.lang.String,​java.lang.Object> getSeoMetaData​(java.lang.String seoUrl,
                                                                      java.lang.String repositoryName)
        This method does search request for database entity based on seo URL property
        Parameters:
        seoUrl - this is SEO-url, human-readable value
        repositoryName - repository name from where will be returned data
        Returns:
        map-representation of data

      • getSeoUrl

        java.lang.String getSeoUrl​(java.lang.String id,
                           java.lang.String repositoryName)
        This method does search request for seo URL property
        Parameters:
        id - this is entity id
        repositoryName - repository name from where will be returned data
        Returns:
        SEO-url value as a string

      • getSeoUrlAsValue

        java.util.Map<java.lang.String,​java.lang.Object> getSeoUrlAsValue​(java.lang.String id,
                                                                        java.lang.String repositoryName)
        This method does search request for seo URL property
        Parameters:
        id - this is entity id
        repositoryName - repository name from where will be returned data
        Returns:
        map-representation of data

      • getSeoUrlByLang

        java.lang.String getSeoUrlByLang​(java.lang.String id,
                                 java.lang.String lang,
                                 java.lang.String repositoryName)
        This method does search request for seo URL property
        Parameters:
        id - this is entity id
        lang - iso code for language
        repositoryName - repository name from where will be returned data
        Returns:
        SEO-url value as a string

      • saveSearchRequest

        boolean saveSearchRequest​(java.lang.String searchTerm)
        Saves the search request with the specified search term.
        Parameters:
        searchTerm - the search term to be saved
        Returns:
        true if the search request is successfully saved, false otherwise

      • uploadSEO

        void uploadSEO​(java.io.File file,
               java.lang.String lang,
               java.lang.String username)
        Uploads SEO information from a given file for a specific language and user.
        Parameters:
        file - the file containing the SEO information to be uploaded
        lang - the language for which the SEO information is intended
        username - the username of the user responsible for the upload