Package com.jalios.jcms

Interface MemberQueryFilter

All Superinterfaces:

java.lang.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

Field Summary

Fields inherited from interface com.jalios.jcms.plugin.PluginComponent

REVISION

Method Summary

Modifier and Type	Method	Description
void	filterMemberQueryHandler(AllMemberQueryHandler amqh, java.util.Map<java.lang.String,java.lang.Object> context)	This method should be overriden to filter the value of the AllMemberQueryHandler
void	filterMemberQueryHandler(DBMemberQueryHandler dbmqh, java.util.Map<java.lang.String,java.lang.Object> context)	This method should be overriden to filter the value of the DBMemberQueryHandler
void	filterMemberQueryHandler(MemberQueryHandler mqh, java.util.Map<java.lang.String,java.lang.Object> context)	This method should be overriden to filter the value of the MemberQueryHandler
PageResult<Member>	filterPageResult(AllMemberQueryHandler amqh, PageResult<Member> pr, java.util.Map<java.lang.String,java.lang.Object> context)	This method should be overriden to filter the page result of a AllMemberQueryHandler..
PageResult<DBMember>	filterPageResult(DBMemberQueryHandler dbmqh, PageResult<DBMember> pr, java.util.Map<java.lang.String,java.lang.Object> context)	This method should be overriden to filter the page result of a DBMemberQueryHandler..
java.util.List<java.lang.String>	filterResultList(AllMemberQueryHandler amqh, java.util.List<java.lang.String> list, java.util.Map<java.lang.String,java.lang.Object> context)	This method should be overriden to filter the result list of a AllMemberQueryHandler.
java.util.List<java.lang.String>	filterResultList(DBMemberQueryHandler dbmqh, java.util.List<java.lang.String> list, java.util.Map<java.lang.String,java.lang.Object> context)	This method should be overriden to filter the result list of a DBMemberQueryHandler.
java.util.Set<Member>	filterResultSet(MemberQueryHandler mqh, java.util.Set<Member> set, java.util.Map<java.lang.String,java.lang.Object> context)	This method should be overriden to filter the result set.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.jalios.jcms.plugin.PluginComponent

init

Method Detail

filterMemberQueryHandler

void filterMemberQueryHandler(MemberQueryHandler mqh,
                              java.util.Map<java.lang.String,java.lang.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

java.util.Set<Member> filterResultSet(MemberQueryHandler mqh,
                                      java.util.Set<Member> set,
                                      java.util.Map<java.lang.String,java.lang.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,
                              java.util.Map<java.lang.String,java.lang.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,
                                      java.util.Map<java.lang.String,java.lang.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

java.util.List<java.lang.String> filterResultList(DBMemberQueryHandler dbmqh,
                                                  java.util.List<java.lang.String> list,
                                                  java.util.Map<java.lang.String,java.lang.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,
                              java.util.Map<java.lang.String,java.lang.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,
                                    java.util.Map<java.lang.String,java.lang.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

java.util.List<java.lang.String> filterResultList(AllMemberQueryHandler amqh,
                                                  java.util.List<java.lang.String> list,
                                                  java.util.Map<java.lang.String,java.lang.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