edu.internet2.middleware.grouper.filter
Class GroupNameFilter

java.lang.Object
  edu.internet2.middleware.grouper.filter.BaseQueryFilter
      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.

GroupNameFilter(java.lang.String name, Stem ns, java.lang.String theSortString, java.lang.Boolean theAscending, java.lang.Integer thePageNumber, java.lang.Integer thePageSize, java.util.Set<TypeOfGroup> typeOfGroups1)
QueryFilter that returns groups matching the specified name.

Method Summary

java.lang.Boolean	getAscending() true or null for ascending, false for descending.
java.lang.Integer	getPageNumber() page number 1 indexed if paging
java.lang.Integer	getPageSize() page size if paging
java.util.Set	getResults(GrouperSession s) Get filter results.
java.lang.String	getSortString() must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
java.util.Set<TypeOfGroup>	getTypeOfGroups() type of group
void	setAscending(java.lang.Boolean ascending1) true or null for ascending, false for descending.
void	setPageNumber(java.lang.Integer pageNumber1) page number 1 indexed if paging
void	setPageSize(java.lang.Integer pageSize1) page size if paging
void	setSortString(java.lang.String sortString1) must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
void	setTypeOfGroup(java.util.Set<TypeOfGroup> typeOfGroups1) type of group

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.

GroupNameFilter

public GroupNameFilter(java.lang.String name,
                       Stem ns,
                       java.lang.String theSortString,
                       java.lang.Boolean theAscending,
                       java.lang.Integer thePageNumber,
                       java.lang.Integer thePageSize,
                       java.util.Set<TypeOfGroup> typeOfGroups1)

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.

theSortString -

theAscending -

thePageNumber -

thePageSize -

typeOfGroups1 -

Method Detail

getTypeOfGroups

public java.util.Set<TypeOfGroup> getTypeOfGroups()

type of group

Returns:

type of group

setTypeOfGroup

public void setTypeOfGroup(java.util.Set<TypeOfGroup> typeOfGroups1)

type of group

Parameters:

typeOfGroups1 -

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

getAscending

public java.lang.Boolean getAscending()

true or null for ascending, false for descending. If you pass true or false, must pass a sort string

Returns:

the ascending

getPageNumber

public java.lang.Integer getPageNumber()

page number 1 indexed if paging

Returns:

the pageNumber

getPageSize

public java.lang.Integer getPageSize()

page size if paging

Returns:

the pageSize

getSortString

public java.lang.String getSortString()

must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension

Returns:

the sortString

setAscending

public void setAscending(java.lang.Boolean ascending1)

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

public void setPageNumber(java.lang.Integer pageNumber1)

page number 1 indexed if paging

Parameters:

pageNumber1 - the pageNumber to set

setPageSize

public void setPageSize(java.lang.Integer pageSize1)

page size if paging

Parameters:

pageSize1 - the pageSize to set

setSortString

public void setSortString(java.lang.String sortString1)

must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension

Parameters:

sortString1 - the sortString to set