Package edu.internet2.middleware.grouper.filter

Class StemsInStemFilter

java.lang.Object
edu.internet2.middleware.grouper.filter.BaseQueryFilter
edu.internet2.middleware.grouper.filter.StemsInStemFilter
All Implemented Interfaces:
QueryFilter
public class StemsInStemFilter extends BaseQueryFilter
Query by stem name exact, and get all stem children, or just immediate

Version:
$Id: StemsInStemFilter.java,v 1.2 2009-03-15 06:37:22 mchyzer Exp $

  • Constructor Details

    • StemsInStemFilter

      public StemsInStemFilter(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

    • StemsInStemFilter

      public StemsInStemFilter(String theStemName, Stem.Scope theScope, boolean theFailOnStemNotFound, String theSortString, Boolean theAscending, Integer thePageNumber, Integer thePageSize)
      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
      theSortString -
      theAscending -
      thePageNumber -
      thePageSize -

  • Method Details

    • getResults

      public Set<Stem> 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:

    • 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