Package com.broadleafcommerce.content.service

Interface StarredItemService<P extends StarredItem>

All Superinterfaces:
com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
All Known Implementing Classes:
DefaultStarredItemService
public interface StarredItemService<P extends StarredItem> extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
This service is responsible for handling all CRUD operations on StarredItems.
Author:
Susana Cruz (susanaccruz)

  • Method Summary

    Modifier and Type
    Method
    Description
    List<P>
    createAll(@NonNull String userId, @NonNull List<String> contentItemIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Create StarredItems based on the supplied user id and content item ids.
    List<P>
    readAllByUserId(@NonNull String userId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Read all StarredItems, optionally filtered by name.
    List<P>
    readAllByUserIdAndContentItemIds(@NonNull String userId, @NonNull List<String> contentItemIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Read all StarredItems, optionally filtered by user id and content item ids.

    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

    • readAllByUserId

      List<P> readAllByUserId(@NonNull @NonNull String userId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Read all StarredItems, optionally filtered by name.
      Parameters:
      userId - the user ID to filter by
      context - context information surrounding sandboxing and multitenant state
      Returns:
      all StarredItems, optionally filtered by name

    • readAllByUserIdAndContentItemIds

      List<P> readAllByUserIdAndContentItemIds(@NonNull @NonNull String userId, @NonNull @NonNull List<String> contentItemIds, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Read all StarredItems, optionally filtered by user id and content item ids.
      Parameters:
      userId - the user ID to filter by
      contentItemIds - the content item IDs to filter by
      context - context information surrounding sandboxing and multitenant state
      Returns:
      all StarredItems, optionally filtered by user id and content item ids

    • createAll

      List<P> createAll(@NonNull @NonNull String userId, @NonNull @NonNull List<String> contentItemIds, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Create StarredItems based on the supplied user id and content item ids.
      Parameters:
      userId - the user ID to create the starred items with
      contentItemIds - the content item IDs to create the starred items with
      context - context information surrounding sandboxing and multitenant state
      Returns:
      all newly created StarredItems