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 $

Constructor Summary

Constructors

Constructor and Description
GroupNameFilter(String name, Stem ns) QueryFilter that returns groups matching the specified name.
GroupNameFilter(String name, Stem ns, String theSortString, Boolean theAscending, Integer thePageNumber, Integer thePageSize, Set<TypeOfGroup> typeOfGroups1) QueryFilter that returns groups matching the specified name.
GroupNameFilter(String name, Stem ns, String theSortString, Boolean theAscending, Integer thePageNumber, Integer thePageSize, Set<TypeOfGroup> typeOfGroups1, Boolean enabled1) QueryFilter that returns groups matching the specified name.

Method Summary

Modifier and Type	Method and Description
Boolean	getAscending() true or null for ascending, false for descending.
Boolean	getEnabled()
Integer	getPageNumber() page number 1 indexed if paging
Integer	getPageSize() page size if paging
Set	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	setEnabled(Boolean enabled)
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

Methods inherited from class edu.internet2.middleware.grouper.filter.BaseQueryFilter

filterByScope, getStringForScope, removeRootStem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupNameFilter

public GroupNameFilter(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(String name,
                       Stem ns,
                       String theSortString,
                       Boolean theAscending,
                       Integer thePageNumber,
                       Integer thePageSize,
                       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 -

GroupNameFilter

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

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 -

enabled1 - true if enabled only, false if disabled only, null if everything

Method Detail

getTypeOfGroups

public Set<TypeOfGroup> getTypeOfGroups()

type of group

Returns:

type of group

setTypeOfGroup

public void setTypeOfGroup(Set<TypeOfGroup> typeOfGroups1)

type of group

Parameters:

typeOfGroups1 -

getResults

public 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 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 Integer getPageNumber()

page number 1 indexed if paging

Returns:

the pageNumber

getPageSize

public Integer getPageSize()

page size if paging

Returns:

the pageSize

getSortString

public String getSortString()

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

Returns:

the sortString

setAscending

public void setAscending(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(Integer pageNumber1)

page number 1 indexed if paging

Parameters:

pageNumber1 - the pageNumber to set

setPageSize

public void setPageSize(Integer pageSize1)

page size if paging

Parameters:

pageSize1 - the pageSize to set

setSortString

public void setSortString(String sortString1)

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

Parameters:

sortString1 - the sortString to set

getEnabled

public Boolean getEnabled()

Returns:

true if enabled only, false if disabled only, null if everything

setEnabled

public void setEnabled(Boolean enabled)

Parameters:

enabled - true if enabled only, false if disabled only, null if everything