Class StemNameAnyFilter
java.lang.Object
edu.internet2.middleware.grouper.filter.BaseQueryFilter
edu.internet2.middleware.grouper.filter.StemNameAnyFilter
- All Implemented Interfaces:
QueryFilter
Query by stem name.
- Version:
- $Id: StemNameAnyFilter.java,v 1.3 2008-11-05 16:18:46 shilen Exp $
-
Constructor Summary
ConstructorDescriptionStemNameAnyFilter
(String name, Stem ns) QueryFilter
that returns stems matching the specified name.StemNameAnyFilter
(String name, Stem ns, String theSortString, Boolean theAscending, Integer thePageNumber, Integer thePageSize) QueryFilter
that returns stems matching the specified name. -
Method Summary
Modifier and TypeMethodDescriptiontrue or null for ascending, false for descending.page number 1 indexed if pagingpage size if pagingGet filter results.must be an hql query field, e.g.void
setAscending
(Boolean ascending1) true or null for ascending, false for descending.void
setPageNumber
(Integer pageNumber1) page number 1 indexed if pagingvoid
setPageSize
(Integer pageSize1) page size if pagingvoid
setSortString
(String sortString1) must be an hql query field, e.g.Methods inherited from class edu.internet2.middleware.grouper.filter.BaseQueryFilter
filterByScope, getStringForScope, removeRootStem
-
Constructor Details
-
StemNameAnyFilter
QueryFilter
that returns stems matching the specified name.This performs a substring, lowercased query against name, displayName, extension and displayExtension.
- Parameters:
name
- Find stems matching this name.ns
- Restrict results to within this stem.
-
StemNameAnyFilter
public StemNameAnyFilter(String name, Stem ns, String theSortString, Boolean theAscending, Integer thePageNumber, Integer thePageSize) QueryFilter
that returns stems matching the specified name.This performs a substring, lowercased query against name, displayName, extension and displayExtension.
- Parameters:
name
- Find stems matching this name.ns
- Restrict results to within this stem.theSortString
-theAscending
-thePageNumber
-thePageSize
-
-
-
Method Details
-
getResults
Description copied from class:BaseQueryFilter
Get filter results.- Specified by:
getResults
in interfaceQueryFilter
- Overrides:
getResults
in classBaseQueryFilter
- Parameters:
s
- Get groups within this session context.- Returns:
- Objects that match filter constraints.
- Throws:
QueryException
-
getAscending
true or null for ascending, false for descending. If you pass true or false, must pass a sort string- Returns:
- the ascending
-
getPageNumber
page number 1 indexed if paging- Returns:
- the pageNumber
-
getPageSize
page size if paging- Returns:
- the pageSize
-
getSortString
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension- Returns:
- the sortString
-
setAscending
true or null for ascending, false for descending. If you pass true or false, must pass a sort string- Parameters:
ascending1
- the ascending to set
-
setPageNumber
page number 1 indexed if paging- Parameters:
pageNumber1
- the pageNumber to set
-
setPageSize
page size if paging- Parameters:
pageSize1
- the pageSize to set
-
setSortString
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension- Parameters:
sortString1
- the sortString to set
-