Package com.broadleafcommerce.content.service.folder

Interface ContentFolderItemService<P extends ContentFolderItem>

All Superinterfaces:
com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
All Known Implementing Classes:
DefaultContentFolderItemService
public interface ContentFolderItemService<P extends ContentFolderItem> extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
Base service API for FolderItems. Backed by a ContentFolderItemRepository.
Author:
Jon Fleschler (jfleschler)

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    existsByFolderId(String folderId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Returns whether there are any folder items with folderId as their ContentFolderItem#folder.
    List<P>
    readAllItemsForContentItemIds(Collection<String> contentItemIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Returns all folder items for the given content item IDs.
    List<P>
    readAllItemsInFolder(String folderId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Returns a list of all folder items in the folder with the given ID.
    org.springframework.data.domain.Page<P>
    readAllItemsInFolder(String folderId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageInfo, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Returns all folder items in the folder with the given ID.

    Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.CrudEntityService

    create, createAll, createAllAllowingPartialSuccess, delete, readAll, readAll, readAll, readAllByContextId, readByContextId, replace, replaceAll, replaceAllAllowingPartialSuccess, update, updateAll, updateAllAllowingPartialSuccess, updateSort

    Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService

    readAll, readAll, readAll, readAll

  • Method Details

    • existsByFolderId

      boolean existsByFolderId(String folderId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns whether there are any folder items with folderId as their ContentFolderItem#folder. Determines if there are any content items in a folder.
      Parameters:
      folderId - the context ID of the parent folder to search for
      contextInfo - the context surrounding sandboxing and mulitenant state
      Returns:
      whether there are any folders with folderId as their ContentFolder#folder

    • readAllItemsInFolder

      org.springframework.data.domain.Page<P> readAllItemsInFolder(@Nullable String folderId, @Nullable cz.jirutka.rsql.parser.ast.Node filters, @Nullable org.springframework.data.domain.Pageable pageInfo, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns all folder items in the folder with the given ID.
      Parameters:
      folderId - the context ID of the folder to search for
      filters - additional filters to apply in the query, can be null
      pageInfo - pagination information
      contextInfo - the context surrounding sandboxing and mulitenant state
      Returns:
      the children folders of the folder with the given context ID

    • readAllItemsInFolder

      List<P> readAllItemsInFolder(@Nullable String folderId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns a list of all folder items in the folder with the given ID.
      Parameters:
      folderId - the context ID of the folder to search for
      contextInfo - the context surrounding sandboxing and mulitenant state
      Returns:
      a list of all children folders of the folder with the given context ID

    • readAllItemsForContentItemIds

      List<P> readAllItemsForContentItemIds(Collection<String> contentItemIds, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns all folder items for the given content item IDs.
      Parameters:
      contentItemIds - the content item IDs to search for
      contextInfo - the context surrounding sandboxing and mulitenant state
      Returns:
      all folder items for the given content item IDs