edu.internet2.middleware.grouper.filter
Class GroupNameFilter

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

public class GroupNameFilter
extends BaseQueryFilter

Query by group name.

Version:
$Id: GroupNameFilter.java,v 1.4 2009-03-27 19:32:41 shilen Exp $
Author:
blair christensen.

Constructor Summary
GroupNameFilter(java.lang.String name, Stem ns)
          QueryFilter that returns groups matching the specified name.
 
Method Summary
 java.util.Set 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

GroupNameFilter

public GroupNameFilter(java.lang.String name,
                       Stem ns)
QueryFilter that returns groups matching the specified name.

This performs a substring, lowercased query against name, alternateName, displayName, extension and displayExtension.

NOTE: This query will perform a full table scan.

Parameters:
name - Find groups matching this name.
ns - Restrict results to within this stem.
Method Detail

getResults

public java.util.Set 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