Package com.jalios.jcms
Class BasicMemberQueryFilter
java.lang.Object
com.jalios.jcms.policy.AbstractPolicyFilter
com.jalios.jcms.BasicMemberQueryFilter
- All Implemented Interfaces:
MemberQueryFilter,PluginComponent,PolicyFilter,Comparable
public abstract class BasicMemberQueryFilter
extends AbstractPolicyFilter
implements MemberQueryFilter, PluginComponent, Comparable
A QueryFilter is notified for each member query.
- Since:
- jcms-6.1.0
- Author:
- Olivier Dedieu
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a QueryFilter with order = 0BasicMemberQueryFilter(int order) Constructs a QueryFilter with the given order -
Method Summary
Modifier and TypeMethodDescriptionvoidfilterMemberQueryHandler(AllMemberQueryHandler amqh, Map<String, Object> context) This method should be overriden to filter the value of the AllMemberQueryHandlervoidfilterMemberQueryHandler(DBMemberQueryHandler dbmqh, Map<String, Object> context) This method should be overriden to filter the value of the DBMemberQueryHandlervoidfilterMemberQueryHandler(MemberQueryHandler mqh, Map<String, Object> context) This method should be overriden to filter the value of the MemberQueryHandlerfilterPageResult(AllMemberQueryHandler amqh, PageResult<Member> pr, Map<String, Object> context) This method should be overriden to filter the page result of a AllMemberQueryHandler..filterPageResult(DBMemberQueryHandler dbmqh, PageResult<DBMember> pr, Map<String, Object> context) This method should be overriden to filter the page result of a DBMemberQueryHandler..filterResultList(AllMemberQueryHandler amqh, List<String> list, Map<String, Object> context) This method should be overriden to filter the result list of a AllMemberQueryHandler.filterResultList(DBMemberQueryHandler dbmqh, List<String> list, Map<String, Object> context) This method should be overriden to filter the result list of a DBMemberQueryHandler.filterResultSet(MemberQueryHandler mqh, Set<Member> set, Map<String, Object> context) This method should be overriden to filter the result setbooleanInitialize the component with the given plugin configurationMethods inherited from class com.jalios.jcms.policy.AbstractPolicyFilter
compareTo, equals, getOrder, setOrderMethods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.lang.Comparable
compareTo
-
Field Details
-
order
protected int order
-
-
Constructor Details
-
BasicMemberQueryFilter
public BasicMemberQueryFilter()Constructs a QueryFilter with order = 0- Since:
- jcms-6.1.0
-
BasicMemberQueryFilter
public BasicMemberQueryFilter(int order) Constructs a QueryFilter with the given order- Parameters:
order- the order- Since:
- jcms-6.1.0
-
-
Method Details
-
init
Description copied from interface:PluginComponentInitialize the component with the given plugin configuration- Specified by:
initin interfacePluginComponent- Parameters:
plugin- the calling plugin- Returns:
- true if the component has been correctly initialized.
- Since:
- jcms-5.7.2
- See Also:
-
filterMemberQueryHandler
This method should be overriden to filter the value of the MemberQueryHandler- Specified by:
filterMemberQueryHandlerin interfaceMemberQueryFilter- Parameters:
mqh- the MemberQueryHandlercontext- the context. Can be used to exchange data between custom MemberQueryFilters.- Since:
- jcms-6.1.0
-
filterResultSet
public Set<Member> filterResultSet(MemberQueryHandler mqh, Set<Member> set, Map<String, Object> context) This method should be overriden to filter the result set- Specified by:
filterResultSetin interfaceMemberQueryFilter- Parameters:
mqh- the MemberQueryHandlerset- the result setcontext- the context. Can be used to exchange data between custom MemberQueryFilters.- Returns:
- the (filtered) result set
- Since:
- jcms-6.1.0
-
filterMemberQueryHandler
This method should be overriden to filter the value of the DBMemberQueryHandler- Specified by:
filterMemberQueryHandlerin interfaceMemberQueryFilter- Parameters:
dbmqh- the DBMemberQueryHandlercontext- the context. Can be used to exchange data between custom MemberQueryFilters.- Since:
- jcms-6.1.0
-
filterPageResult
public 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..- Specified by:
filterPageResultin interfaceMemberQueryFilter- Parameters:
dbmqh- the DBMemberQueryHandlerpr- the page resultcontext- the context. Can be used to exchange data between custom MemberQueryFilters.- Returns:
- the (filtered) page result
- Since:
- jcms-6.1.0
-
filterResultList
public 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.- Specified by:
filterResultListin interfaceMemberQueryFilter- Parameters:
dbmqh- the DBMemberQueryHandlerlist- the list of member id to filtercontext- the context. Can be used to exchange data between custom MemberQueryFilters.- Returns:
- the (filtered) list
- Since:
- jcms-6.1.0
-
filterMemberQueryHandler
This method should be overriden to filter the value of the AllMemberQueryHandler- Specified by:
filterMemberQueryHandlerin interfaceMemberQueryFilter- Parameters:
amqh- the AllMemberQueryHandlercontext- the context. Can be used to exchange data between custom MemberQueryFilters.- Since:
- jcms-6.1.0
-
filterPageResult
public 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..- Specified by:
filterPageResultin interfaceMemberQueryFilter- Parameters:
amqh- the AllMemberQueryHandlerpr- the page resultcontext- the context. Can be used to exchange data between custom MemberQueryFilters.- Returns:
- the (filtered) page result
- Since:
- jcms-6.1.0
-
filterResultList
public 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.- Specified by:
filterResultListin interfaceMemberQueryFilter- Parameters:
amqh- the AllMemberQueryHandlerlist- the list of member id to filtercontext- the context. Can be used to exchange data between custom MemberQueryFilters.- Returns:
- the (filtered) list
- Since:
- jcms-6.1.0
-