public class GroupsInStemFilter extends BaseQueryFilter
Constructor and Description |
---|
GroupsInStemFilter(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. |
Modifier and Type | Method and Description |
---|---|
Boolean |
getAscending()
true or null for ascending, false for descending.
|
Integer |
getPageNumber()
page number 1 indexed if paging
|
Integer |
getPageSize()
page size if paging
|
Set<Group> |
getResults(GrouperSession s)
Get filter results.
|
String |
getSortString()
must be an hql query field, e.g.
|
Set<TypeOfGroup> |
getTypeOfGroups()
type of group
|
void |
setAscending(Boolean ascending1)
true or null for ascending, false for descending.
|
void |
setPageNumber(Integer pageNumber1)
page number 1 indexed if paging
|
void |
setPageSize(Integer pageSize1)
page size if paging
|
void |
setSortString(String sortString1)
must be an hql query field, e.g.
|
void |
setTypeOfGroup(Set<TypeOfGroup> typeOfGroups1)
type of group
|
filterByScope, getStringForScope, removeRootStem
public GroupsInStemFilter(String theStemName, Stem.Scope theScope, boolean theFailOnStemNotFound)
QueryFilter
that returns stems matching the specified
name value.
This performs a substring, lowercased query on name.
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 StemNotFoundExceptionpublic 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.
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
- public Set<Group> getResults(GrouperSession s) throws QueryException
BaseQueryFilter
getResults
in interface QueryFilter
getResults
in class BaseQueryFilter
s
- Get groups within this session context.QueryException
BaseQueryFilter.getResults(edu.internet2.middleware.grouper.GrouperSession)
public Boolean getAscending()
public Integer getPageNumber()
public Integer getPageSize()
public String getSortString()
public void setAscending(Boolean ascending1)
ascending1
- the ascending to setpublic void setPageNumber(Integer pageNumber1)
pageNumber1
- the pageNumber to setpublic void setPageSize(Integer pageSize1)
pageSize1
- the pageSize to setpublic void setSortString(String sortString1)
sortString1
- the sortString to setpublic Set<TypeOfGroup> getTypeOfGroups()
public void setTypeOfGroup(Set<TypeOfGroup> typeOfGroups1)
typeOfGroups1
- Copyright © 2016 Internet2. All rights reserved.