Package de.hybris.platform.search.restriction.impl

Class DefaultSearchRestrictionService

java.lang.Object
de.hybris.platform.search.restriction.impl.DefaultSearchRestrictionService
All Implemented Interfaces:
SearchRestrictionService
public class DefaultSearchRestrictionService extends Object implements SearchRestrictionService
Default implementation of SearchRestrictionService interface.

  • Field Details

  • Constructor Details

    • DefaultSearchRestrictionService

      public DefaultSearchRestrictionService()

  • Method Details

    • addSessionSearchRestrictions

      public void addSessionSearchRestrictions(Collection<SessionSearchRestriction> restrictions)
      Adds session search restrictions to current session context. If currently there are some session search restrictions, passed as parameter collection of restrictions will be added to current one.

      Example usage:

       final ComposedTypeModel restrictedType = typeService.getComposedTypeForClass(LanguageModel.class);
 final SessionSearchRestriction restriction = new SessionSearchRestriction("someUniqueCode", "{active} IS TRUE", restrictedType);
 final Collection<SessionSearchRestriction> restrictions = new ArrayList<SessionSearchRestriction>();
 restrictions.add(restriction);

 searchRestrictionService.addSessionSearchRestrictions(restrictions);
      Specified by:
      addSessionSearchRestrictions in interface SearchRestrictionService
      Parameters:
      restrictions - the restrictions collection to add to session.

    • addSessionSearchRestrictions

      public void addSessionSearchRestrictions(SessionSearchRestriction... restrictions)
      Adds session search restrictions to current session context. If currently there are some session search restrictions, passed as parameter restriction(s) will be added to current one.

      Example usage:

       final ComposedTypeModel restrictedType = typeService.getComposedTypeForClass(LanguageModel.class);
 final SessionSearchRestriction restriction1 = new SessionSearchRestriction("someUniqueCode1", "{active} IS TRUE", restrictedType);
 final SessionSearchRestriction restriction2 = new SessionSearchRestriction("someUniqueCode2", "{foo}={bar}", restrictedType);

 searchRestrictionService.addSessionSearchRestrictions(restriction1, restriction2);
      Specified by:
      addSessionSearchRestrictions in interface SearchRestrictionService
      Parameters:
      restrictions - the restrictions to add

    • clearSessionSearchRestrictions

      public void clearSessionSearchRestrictions()
      Clear session search restrictions in current session context.
      Specified by:
      clearSessionSearchRestrictions in interface SearchRestrictionService

    • disableSearchRestrictions

      public void disableSearchRestrictions()
      Disable search restrictions in current session context.
      Specified by:
      disableSearchRestrictions in interface SearchRestrictionService

    • enableSearchRestrictions

      public void enableSearchRestrictions()
      Enable search restrictions in current session context.
      Specified by:
      enableSearchRestrictions in interface SearchRestrictionService

    • getActiveSearchRestrictions

      public Collection<SearchRestrictionModel> getActiveSearchRestrictions(PrincipalModel principal, boolean includePrincipalGroups, Collection<ComposedTypeModel> types)
      Gets only active search restrictions for given ComposedTypeModel.
      Specified by:
      getActiveSearchRestrictions in interface SearchRestrictionService
      Parameters:
      principal - the principal for which restrictions will be searched
      includePrincipalGroups - determines whether include principal groups in search
      types - Collection of ComposedTypeModel objects for which restriction will be obtained.
      Returns:
      the active search restrictions collection.

    • getInactiveSearchRestrictions

      public Collection<SearchRestrictionModel> getInactiveSearchRestrictions(PrincipalModel principal, boolean includePrincipalGroups, Collection<ComposedTypeModel> types)
      Gets only inactive search restrictions for given ComposedTypeModel.
      Specified by:
      getInactiveSearchRestrictions in interface SearchRestrictionService
      Parameters:
      principal - the principal for which restrictions will be searched
      includePrincipalGroups - determines whether include principal groups in search
      types - Collection of ComposedTypeModel objects for which restriction will be obtained.
      Returns:
      the active search restrictions collection.

    • getSearchRestrictions

      public Collection<SearchRestrictionModel> getSearchRestrictions(PrincipalModel principal, boolean includePrincipalGroups, Collection<ComposedTypeModel> types)
      Gets all (active and inactive) search restrictions for given ComposedTypeModel.
      Specified by:
      getSearchRestrictions in interface SearchRestrictionService
      Parameters:
      principal - the principal for which restrictions will be searched
      includePrincipalGroups - determines whether include principal groups in search
      types - Collection of ComposedTypeModel objects for which restriction will be obtained.
      Returns:
      the all search restrictions.

    • getSearchRestrictionsForType

      public Collection<SearchRestrictionModel> getSearchRestrictionsForType(ComposedTypeModel type)
      Description copied from interface: SearchRestrictionService
      Gets all search restrictions for type.
      Specified by:
      getSearchRestrictionsForType in interface SearchRestrictionService
      Parameters:
      type - the type
      Returns:
      the search restrictions for type

    • getSessionSearchRestrictions

      public Collection<SessionSearchRestriction> getSessionSearchRestrictions()
      Gets the session search restrictions from current session context.
      Specified by:
      getSessionSearchRestrictions in interface SearchRestrictionService
      Returns:
      the session search restrictions collection.

    • getSessionSearchRestrictions

      public Collection<SessionSearchRestriction> getSessionSearchRestrictions(ComposedTypeModel type)
      Gets the session search restrictions from current session context for particular ComposedTypeModel object.
      Specified by:
      getSessionSearchRestrictions in interface SearchRestrictionService
      Parameters:
      type - the type for which which restriction will be obtained.
      Returns:
      the session search restrictions collection.

    • hasRestrictions

      public boolean hasRestrictions(PrincipalModel principal, boolean includePrincipalGroups, ComposedTypeModel type)
      Checks whether type has search restrictions (session and persisted).
      Specified by:
      hasRestrictions in interface SearchRestrictionService
      Parameters:
      principal - the principal for which restrictions will be searched
      includePrincipalGroups - determines whether include principal groups in search
      type - the type for which check will be triggered.
      Returns:
      true if has restrictions, false otherwise.

    • isSearchRestrictionsEnabled

      public boolean isSearchRestrictionsEnabled()
      Checks if search restrictions feature in current session context is enabled.
      Specified by:
      isSearchRestrictionsEnabled in interface SearchRestrictionService
      Returns:
      true is search restrictions are enabled

    • removeSessionSearchRestrictions

      public void removeSessionSearchRestrictions(Collection<SessionSearchRestriction> restrictions)
      Remove session search restrictions from current session context.
      Specified by:
      removeSessionSearchRestrictions in interface SearchRestrictionService
      Parameters:
      restrictions - the restrictions collection to remove from session.

    • removalAllSessionSearchRestrictions

      public void removalAllSessionSearchRestrictions()
      Removes all session-scoped search restrictions from the current session.
      Specified by:
      removalAllSessionSearchRestrictions in interface SearchRestrictionService

    • setConverter

      public void setConverter(SessionSearchRestrictionConverter converter)

    • setSearchRestrictionDao

      public void setSearchRestrictionDao(SearchRestrictionDao searchRestrictionDao)

    • setSessionService

      public void setSessionService(SessionService sessionService)