Interface MemberQueryFilter

All Superinterfaces:
Comparable, PluginComponent, PolicyFilter
All Known Implementing Classes:
BasicMemberQueryFilter

public interface MemberQueryFilter extends PolicyFilter
A MemberQueryFilter is notified for each member query.
Since:
jcms-6.1.0
  • Method Details

    • filterMemberQueryHandler

      void filterMemberQueryHandler(MemberQueryHandler mqh, Map<String,Object> context)
      This method should be overriden to filter the value of the MemberQueryHandler
      Parameters:
      mqh - the MemberQueryHandler
      context - the context. Can be used to exchange data between custom MemberQueryFilters.
      Since:
      jcms-6.1.0
    • filterResultSet

      Set<Member> filterResultSet(MemberQueryHandler mqh, Set<Member> set, Map<String,Object> context)
      This method should be overriden to filter the result set.
      Parameters:
      mqh - the MemberQueryHandler
      set - the result set
      context - the context. Can be used to exchange data between custom MemberQueryFilters.
      Returns:
      the (filtered) result set
      Since:
      jcms-6.1.0
    • filterMemberQueryHandler

      void filterMemberQueryHandler(DBMemberQueryHandler dbmqh, Map<String,Object> context)
      This method should be overriden to filter the value of the DBMemberQueryHandler
      Parameters:
      dbmqh - the DBMemberQueryHandler
      context - the context. Can be used to exchange data between custom MemberQueryFilters.
      Since:
      jcms-6.1.0
    • filterPageResult

      PageResult<DBMember> filterPageResult(DBMemberQueryHandler dbmqh, PageResult<DBMember> pr, Map<String,Object> context)
      This method should be overriden to filter the page result of a DBMemberQueryHandler..
      Parameters:
      dbmqh - the DBMemberQueryHandler
      pr - the page result
      context - the context. Can be used to exchange data between custom MemberQueryFilters.
      Returns:
      the (filtered) page result
      Since:
      jcms-6.1.0
    • filterResultList

      List<String> filterResultList(DBMemberQueryHandler dbmqh, List<String> list, Map<String,Object> context)
      This method should be overriden to filter the result list of a DBMemberQueryHandler.
      Parameters:
      dbmqh - the DBMemberQueryHandler
      list - the list of member id to filter
      context - the context. Can be used to exchange data between custom MemberQueryFilters.
      Returns:
      the (filtered) list
      Since:
      jcms-6.1.0
    • filterMemberQueryHandler

      void filterMemberQueryHandler(AllMemberQueryHandler amqh, Map<String,Object> context)
      This method should be overriden to filter the value of the AllMemberQueryHandler
      Parameters:
      amqh - the AllMemberQueryHandler
      context - the context. Can be used to exchange data between custom MemberQueryFilters.
      Since:
      jcms-6.1.0
    • filterPageResult

      PageResult<Member> filterPageResult(AllMemberQueryHandler amqh, PageResult<Member> pr, Map<String,Object> context)
      This method should be overriden to filter the page result of a AllMemberQueryHandler..
      Parameters:
      amqh - the AllMemberQueryHandler
      pr - the page result
      context - the context. Can be used to exchange data between custom MemberQueryFilters.
      Returns:
      the (filtered) page result
      Since:
      jcms-6.1.0
    • filterResultList

      List<String> filterResultList(AllMemberQueryHandler amqh, List<String> list, Map<String,Object> context)
      This method should be overriden to filter the result list of a AllMemberQueryHandler.
      Parameters:
      amqh - the AllMemberQueryHandler
      list - the list of member id to filter
      context - the context. Can be used to exchange data between custom MemberQueryFilters.
      Returns:
      the (filtered) list
      Since:
      jcms-6.1.0