Package co.mastermindcms.modules.services

Interface CategoryService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Category addChildCategory​(java.lang.String parentId, java.lang.String childId)
      This method does add child entity in parent entity.
      java.util.Optional<Category> createCategory​(Category category)
      This method creates a database entity.
      java.util.Optional<Category> createCategory​(java.util.LinkedHashMap<java.lang.String,​java.lang.Object> categoryAsMap)
      This method creates a database entity.
      java.util.Deque<java.util.Map<java.lang.String,​java.lang.Object>> getPaginationFilter​(java.lang.String requestJson)
      This method does calculation for a pages based on the request.
      CategoryRepository getRepository()  
      java.util.List<java.lang.String> lookupToParents​(java.lang.String categoryId, java.util.List<java.lang.String> result)
      This method does call to collect all parent ids
      CategoryDTO mapCategoryToDto​(Category category, boolean optimal)
      This method does map category entity to dto object
      java.util.List<Category> rebuildAllCategories​(java.util.ArrayList<java.lang.Object> allCategories)
      This method rebuilds a list of database entities.
      void removeCategoriesByIds​(java.util.ArrayList<java.lang.String> categoriesIds)
      This method removes a list of database entities.
      void removeCategoryFromTranslation​(java.lang.String categoryId, java.lang.String translationId)
      This method removes relationship between database entities.
      void removeCategoryWithDescendants​(java.lang.String itemId)
      This method removes database entity with child database entity.
      void removeChildCategory​(java.lang.String parentId, java.lang.String childId)
      This method does delete child entity in parent entity.
      java.util.LinkedHashSet<CategoryDTO> searchCategories​(java.lang.String requestJson)
      This method does search requests and returns data as list.
      java.util.List<Category> searchCategories​(java.lang.String query, java.lang.String from, java.lang.String to)
      This method does search requests and returns data as list.
      co.mastermindcms.modules.beans.SearchResponse searchCategories​(java.util.LinkedHashMap<java.lang.String,​java.lang.Object> requestJson)
      This method does search requests and returns data as list.
      co.mastermindcms.modules.beans.SearchResponse searchCategoriesLightweight​(java.util.LinkedHashMap<java.lang.String,​java.lang.Object> requestJson)
      Retrieves lightweight categories based on the given request JSON.
      org.springframework.data.domain.Page<Category> searchCategoriesPaged​(java.lang.String requestJson)
      This method does search requests and returns data as pages.
      Category updateCategory​(Category category)
      This method updates of database entity.
      Category updateCategory​(java.util.LinkedHashMap<java.lang.String,​java.lang.Object> categoryAsMap)
      This method updates of database entity.

    • Method Detail

      • getPaginationFilter

        java.util.Deque<java.util.Map<java.lang.String,​java.lang.Object>> getPaginationFilter​(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

      • searchCategories

        co.mastermindcms.modules.beans.SearchResponse searchCategories​(java.util.LinkedHashMap<java.lang.String,​java.lang.Object> requestJson)
        This method does search requests and returns data as list.
        Parameters:
        requestJson - search request
        Returns:
        database entities separated to pages

      • searchCategoriesLightweight

        co.mastermindcms.modules.beans.SearchResponse searchCategoriesLightweight​(java.util.LinkedHashMap<java.lang.String,​java.lang.Object> requestJson)
        Retrieves lightweight categories based on the given request JSON.
        Parameters:
        requestJson - a LinkedHashMap containing the request parameters
        Returns:
        a SearchResponse object containing the lightweight categories

      • searchCategories

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

      • searchCategoriesPaged

        org.springframework.data.domain.Page<Category> searchCategoriesPaged​(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

      • searchCategories

        java.util.List<Category> searchCategories​(java.lang.String query,
                                          java.lang.String from,
                                          java.lang.String to)
        This method does search requests and returns data as list.
        Parameters:
        query - search query
        from - field which filter and returned items
        to - field which filter and returned items
        Returns:
        database entities as list

      • createCategory

        java.util.Optional<Category> createCategory​(java.util.LinkedHashMap<java.lang.String,​java.lang.Object> categoryAsMap)
        This method creates a database entity.
        Parameters:
        categoryAsMap - map-representation of database entity
        Returns:
        optional value to externally interaction

      • createCategory

        java.util.Optional<Category> createCategory​(Category category)
        This method creates a database entity.
        Parameters:
        category - database entity
        Returns:
        optional value to externally interaction

      • addChildCategory

        Category addChildCategory​(java.lang.String parentId,
                          java.lang.String childId)
        This method does add child entity in parent entity.
        Parameters:
        parentId - identification for database entity which will be updated
        childId - identification for database entity which will be added in parent database entity
        Returns:
        database entity

      • removeChildCategory

        void removeChildCategory​(java.lang.String parentId,
                         java.lang.String childId)
        This method does delete child entity in parent entity.
        Parameters:
        parentId - identification for database entity which will be updated
        childId - identification for database entity which will be added in parent database entity

      • updateCategory

        Category updateCategory​(java.util.LinkedHashMap<java.lang.String,​java.lang.Object> categoryAsMap)
        This method updates of database entity.
        Parameters:
        categoryAsMap - map-representation of database entity
        Returns:
        updated instance of database entity

      • updateCategory

        Category updateCategory​(Category category)
        This method updates of database entity.
        Parameters:
        category - database entity which will be updated
        Returns:
        updated instance of database entity

      • removeCategoryFromTranslation

        void removeCategoryFromTranslation​(java.lang.String categoryId,
                                   java.lang.String translationId)
        This method removes relationship between database entities.
        Parameters:
        categoryId - identification for database entity which will be removed
        translationId - identification for database entity which will be updated

      • removeCategoryWithDescendants

        void removeCategoryWithDescendants​(java.lang.String itemId)
        This method removes database entity with child database entity.
        Parameters:
        itemId - identification for child database entity which will be removed and whose parent entity will be removed

      • removeCategoriesByIds

        void removeCategoriesByIds​(java.util.ArrayList<java.lang.String> categoriesIds)
        This method removes a list of database entities.
        Parameters:
        categoriesIds - the list of database entities which will be removed

      • rebuildAllCategories

        java.util.List<Category> rebuildAllCategories​(java.util.ArrayList<java.lang.Object> allCategories)
        This method rebuilds a list of database entities.
        Parameters:
        allCategories - the list of database entities which will be removed and updated
        Returns:
        list of categories

      • mapCategoryToDto

        CategoryDTO mapCategoryToDto​(Category category,
                             boolean optimal)
        This method does map category entity to dto object
        Parameters:
        category - database entity which be used to map to dto
        optimal - this pointer optimises the data transfer object
        Returns:
        data transport object

      • lookupToParents

        java.util.List<java.lang.String> lookupToParents​(java.lang.String categoryId,
                                                 java.util.List<java.lang.String> result)
        This method does call to collect all parent ids
        Parameters:
        categoryId - identification of entity object
        result - the collection which will be used to collect all parent ids
        Returns:
        the list of ids