edu.internet2.middleware.grouper.filter
Class GroupsInStemFilter

java.lang.Object
  extended by edu.internet2.middleware.grouper.filter.BaseQueryFilter
      extended by edu.internet2.middleware.grouper.filter.GroupsInStemFilter
All Implemented Interfaces:
QueryFilter

public class GroupsInStemFilter
extends BaseQueryFilter

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 $
Author:
mchyzer

Constructor Summary
GroupsInStemFilter(String theStemName, Stem.Scope theScope, boolean theFailOnStemNotFound)
          QueryFilter that returns stems matching the specified name value.
 
Method Summary
 Set<Group> getResults(GrouperSession s)
          Get filter results.
 
Methods inherited from class edu.internet2.middleware.grouper.filter.BaseQueryFilter
filterByScope
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupsInStemFilter

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.

Parameters:
theStemName - is the name (exact) of the stem to search
theScope - is the type of children to return (all or immediate)
theFailOnStemNotFound - true if GrouperException should be thrown on StemNotFoundException
Method Detail

getResults

public Set<Group> getResults(GrouperSession s)
                      throws QueryException
Description copied from class: BaseQueryFilter
Get filter results.

Specified by:
getResults in interface QueryFilter
Overrides:
getResults in class BaseQueryFilter
Parameters:
s - Get groups within this session context.
Returns:
Objects that match filter constraints.
Throws:
QueryException
See Also:
BaseQueryFilter.getResults(edu.internet2.middleware.grouper.GrouperSession)