Class GroupsInStemFilter
java.lang.Object
edu.internet2.middleware.grouper.filter.BaseQueryFilter
edu.internet2.middleware.grouper.filter.GroupsInStemFilter
- All Implemented Interfaces:
QueryFilter
Query by stem name exact, and get all children, or just immediate
- Version:
- $Id: GroupsInStemFilter.java,v 1.3 2009-11-17 02:52:29 mchyzer Exp $
-
Constructor Summary
ConstructorDescriptionGroupsInStemFilter
(String theStemName, Stem.Scope theScope, boolean theFailOnStemNotFound) QueryFilter
that returns stems matching the specified name value.GroupsInStemFilter
(String theStemName, Stem.Scope theScope, boolean theFailOnStemNotFound, String theSortString, Boolean theAscending, Integer thePageNumber, Integer thePageSize, Set<TypeOfGroup> typeOfGroups1) QueryFilter
that returns stems matching the specified name value.GroupsInStemFilter
(String theStemName, Stem.Scope theScope, boolean theFailOnStemNotFound, String theSortString, Boolean theAscending, Integer thePageNumber, Integer thePageSize, Set<TypeOfGroup> typeOfGroups1, Boolean enabled1) QueryFilter
that returns stems matching the specified name value. -
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.type of groupvoid
setAscending
(Boolean ascending1) true or null for ascending, false for descending.void
setEnabled
(Boolean enabled) 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.void
setTypeOfGroup
(Set<TypeOfGroup> typeOfGroups1) type of groupMethods inherited from class edu.internet2.middleware.grouper.filter.BaseQueryFilter
filterByScope, getStringForScope, removeRootStem
-
Constructor Details
-
GroupsInStemFilter
QueryFilter
that returns stems matching the specified name value.This performs a substring, lowercased query on name.
- Parameters:
theStemName
- is the name (exact) of the stem to searchtheScope
- is the type of children to return (all or immediate)theFailOnStemNotFound
- true if GrouperException should be thrown on StemNotFoundException
-
GroupsInStemFilter
public GroupsInStemFilter(String theStemName, Stem.Scope theScope, boolean theFailOnStemNotFound, String theSortString, Boolean theAscending, Integer thePageNumber, Integer thePageSize, Set<TypeOfGroup> typeOfGroups1) QueryFilter
that returns stems matching the specified name value.This performs a substring, lowercased query on name.
- Parameters:
theStemName
- is the name (exact) of the stem to searchtheScope
- is the type of children to return (all or immediate)theFailOnStemNotFound
- true if GrouperException should be thrown on StemNotFoundExceptiontheSortString
-theAscending
-thePageNumber
-thePageSize
-typeOfGroups1
-
-
GroupsInStemFilter
public GroupsInStemFilter(String theStemName, Stem.Scope theScope, boolean theFailOnStemNotFound, String theSortString, Boolean theAscending, Integer thePageNumber, Integer thePageSize, Set<TypeOfGroup> typeOfGroups1, Boolean enabled1) QueryFilter
that returns stems matching the specified name value.This performs a substring, lowercased query on name.
- Parameters:
theStemName
- is the name (exact) of the stem to searchtheScope
- is the type of children to return (all or immediate)theFailOnStemNotFound
- true if GrouperException should be thrown on StemNotFoundExceptiontheSortString
-theAscending
-thePageNumber
-thePageSize
-typeOfGroups1
-enabled1
- true if enabled only, false if disabled only, null if everything
-
-
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
- See Also:
-
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
-
getTypeOfGroups
type of group- Returns:
- type of group
-
setTypeOfGroup
type of group- Parameters:
typeOfGroups1
-
-
getEnabled
- Returns:
- true if enabled only, false if disabled only, null if everything
-
setEnabled
- Parameters:
enabled
- true if enabled only, false if disabled only, null if everything
-