edu.internet2.middleware.grouper.filter

Class StemNameAnyFilter

java.lang.Object

edu.internet2.middleware.grouper.filter.BaseQueryFilter

edu.internet2.middleware.grouper.filter.StemNameAnyFilter

All Implemented Interfaces:

QueryFilter

public class StemNameAnyFilter
extends BaseQueryFilter

Query by stem name.

Version:

$Id: StemNameAnyFilter.java,v 1.3 2008-11-05 16:18:46 shilen Exp $

Constructor Summary

Constructors

Constructor and Description
StemNameAnyFilter(String name, Stem ns) QueryFilter that returns stems matching the specified name.
StemNameAnyFilter(String name, Stem ns, String theSortString, Boolean theAscending, Integer thePageNumber, Integer thePageSize) QueryFilter that returns stems matching the specified name.

Method Summary

Methods

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	getResults(GrouperSession s) Get filter results.
String	getSortString() must be an hql query field, e.g.
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.

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

StemNameAnyFilter

public StemNameAnyFilter(String name,
                 Stem ns)

QueryFilter that returns stems matching the specified name.

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

Parameters:

name - Find stems matching this name.

ns - Restrict results to within this stem.

StemNameAnyFilter

public StemNameAnyFilter(String name,
                 Stem ns,
                 String theSortString,
                 Boolean theAscending,
                 Integer thePageNumber,
                 Integer thePageSize)

QueryFilter that returns stems matching the specified name.

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

Parameters:

name - Find stems matching this name.

ns - Restrict results to within this stem.

theSortString -

theAscending -

thePageNumber -

thePageSize -

Method Detail

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