edu.internet2.middleware.grouper
Class StemFinder

java.lang.Object
  extended by edu.internet2.middleware.grouper.StemFinder

public class StemFinder
extends java.lang.Object

Find stems within the Groups Registry.

Version:
$Id: StemFinder.java,v 1.54 2009-11-18 17:03:50 mchyzer Exp $
Author:
blair christensen.

Constructor Summary
StemFinder()
           
 
Method Summary
static Stem findByAlternateName(GrouperSession s, java.lang.String name, boolean exceptionOnNotFound, QueryOptions queryOptions)
          Find stem by its alternate name.
static Stem findByCurrentName(GrouperSession s, java.lang.String name, boolean exceptionOnNotFound, QueryOptions queryOptions)
          Find stem by its current name.
static Stem findByName(GrouperSession s, java.lang.String name)
          Deprecated. see overload
static Stem findByName(GrouperSession s, java.lang.String name, boolean exceptionOnNotFound)
          Find stem by name.
static Stem findByName(GrouperSession s, java.lang.String name, boolean exceptionOnNotFound, QueryOptions queryOptions)
          Find stem by name.
static Stem findByUuid(GrouperSession s, java.lang.String uuid)
          Deprecated. see overload
static Stem findByUuid(GrouperSession s, java.lang.String uuid, boolean exceptionIfNull)
          Get stem by uuid.
static Stem findByUuid(GrouperSession s, java.lang.String uuid, boolean exceptionIfNull, QueryOptions queryOptions)
          Get stem by uuid.
static java.util.Set<Stem> findByUuids(GrouperSession s, java.util.Collection<java.lang.String> uuids, QueryOptions queryOptions)
          Get stems by uuids.
static Stem findRootStem(GrouperSession s)
          Find root stem of the Groups Registry.
static java.util.Set internal_findAllByApproximateDisplayExtension(GrouperSession s, java.lang.String val)
           
static java.util.Set internal_findAllByApproximateDisplayName(GrouperSession s, java.lang.String val)
           
static java.util.Set internal_findAllByApproximateExtension(GrouperSession s, java.lang.String val)
           
static java.util.Set internal_findAllByApproximateName(GrouperSession s, java.lang.String val)
           
static java.util.Set internal_findAllByApproximateNameAny(GrouperSession s, java.lang.String val)
           
static java.util.Set internal_findAllByCreatedAfter(GrouperSession s, java.util.Date d)
           
static java.util.Set internal_findAllByCreatedBefore(GrouperSession s, java.util.Date d)
           
static Stem internal_findByName(java.lang.String name, boolean exceptionIfNull)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StemFinder

public StemFinder()
Method Detail

findByName

@Deprecated
public static Stem findByName(GrouperSession s,
                                         java.lang.String name)
                       throws StemNotFoundException
Deprecated. see overload

Find stem by name.
 try {
   Stem stem = StemFinder.findByName(s, name);
 }
 catch (StemNotFoundException e) {
   // Stem not found
 }
 

Parameters:
s - Search within this GrouperSession context
name - Find stem with this name.
Returns:
A Stem object
Throws:
StemNotFoundException

findByName

public static Stem findByName(GrouperSession s,
                              java.lang.String name,
                              boolean exceptionOnNotFound)
                       throws StemNotFoundException
Find stem by name.
   Stem stem = StemFinder.findByName(s, name, false);
 

Parameters:
s - Search within this GrouperSession context
name - Find stem with this name.
exceptionOnNotFound -
Returns:
A Stem object
Throws:
StemNotFoundException

findByName

public static Stem findByName(GrouperSession s,
                              java.lang.String name,
                              boolean exceptionOnNotFound,
                              QueryOptions queryOptions)
                       throws StemNotFoundException
Find stem by name.
   Stem stem = StemFinder.findByName(s, name, false);
 

Parameters:
s - Search within this GrouperSession context
name - Find stem with this name.
exceptionOnNotFound -
queryOptions -
Returns:
A Stem object
Throws:
StemNotFoundException

findByAlternateName

public static Stem findByAlternateName(GrouperSession s,
                                       java.lang.String name,
                                       boolean exceptionOnNotFound,
                                       QueryOptions queryOptions)
                                throws StemNotFoundException
Find stem by its alternate name.
   Stem stem = StemFinder.findByAlternateName(s, name, false);
 

Parameters:
s - Search within this GrouperSession context
name - Find stem with this alternate name.
exceptionOnNotFound -
queryOptions -
Returns:
A Stem object
Throws:
StemNotFoundException

findByCurrentName

public static Stem findByCurrentName(GrouperSession s,
                                     java.lang.String name,
                                     boolean exceptionOnNotFound,
                                     QueryOptions queryOptions)
                              throws StemNotFoundException
Find stem by its current name.
   Stem stem = StemFinder.findByCurrentName(s, name, false);
 

Parameters:
s - Search within this GrouperSession context
name - Find stem with this name.
exceptionOnNotFound -
queryOptions -
Returns:
A Stem object
Throws:
StemNotFoundException

findRootStem

public static Stem findRootStem(GrouperSession s)
                         throws StemNotFoundException
Find root stem of the Groups Registry.
 // Find the root stem.
 Stem rootStem = StemFinder.findRootStem(s);
 

Parameters:
s - Search within this GrouperSession context
Returns:
A Stem object
Throws:
GrouperException
StemNotFoundException

findByUuid

@Deprecated
public static Stem findByUuid(GrouperSession s,
                                         java.lang.String uuid)
                       throws StemNotFoundException
Deprecated. see overload

Get stem by uuid.
 // Get the specified stem by uuid.
 try {
   Stem stem = StemFinder.findByUuid(s, uuid);
 }
 catch (StemNotFoundException e) {
   // Stem not found
 }
 

Parameters:
s - Search within this GrouperSession context
uuid - Get stem with this UUID.
Returns:
A Stem object
Throws:
StemNotFoundException

findByUuid

public static Stem findByUuid(GrouperSession s,
                              java.lang.String uuid,
                              boolean exceptionIfNull)
                       throws StemNotFoundException
Get stem by uuid.
 // Get the specified stem by uuid.
 try {
   Stem stem = StemFinder.findByUuid(s, uuid);
 }
 catch (StemNotFoundException e) {
   // Stem not found
 }
 

Parameters:
s - Search within this GrouperSession context
uuid - Get stem with this UUID.
exceptionIfNull -
Returns:
A Stem object
Throws:
StemNotFoundException

findByUuid

public static Stem findByUuid(GrouperSession s,
                              java.lang.String uuid,
                              boolean exceptionIfNull,
                              QueryOptions queryOptions)
                       throws StemNotFoundException
Get stem by uuid.
 // Get the specified stem by uuid.
 try {
   Stem stem = StemFinder.findByUuid(s, uuid);
 }
 catch (StemNotFoundException e) {
   // Stem not found
 }
 

Parameters:
s - Search within this GrouperSession context
uuid - Get stem with this UUID.
exceptionIfNull -
queryOptions -
Returns:
A Stem object
Throws:
StemNotFoundException

findByUuids

public static java.util.Set<Stem> findByUuids(GrouperSession s,
                                              java.util.Collection<java.lang.String> uuids,
                                              QueryOptions queryOptions)
                                       throws StemNotFoundException
Get stems by uuids.
 // Get the specified stems by uuids.
 try {
   Set stems = StemFinder.findByUuids(s, uuids, null);
 }
 catch (StemNotFoundException e) {
   // Stem not found
 }
 

Parameters:
s - Search within this GrouperSession context
uuid - Get stem with this UUID.
exceptionIfNull -
queryOptions -
Returns:
A Stem object
Throws:
StemNotFoundException

internal_findAllByApproximateDisplayExtension

public static java.util.Set internal_findAllByApproximateDisplayExtension(GrouperSession s,
                                                                          java.lang.String val)
                                                                   throws QueryException
Throws:
QueryException

internal_findAllByApproximateDisplayName

public static java.util.Set internal_findAllByApproximateDisplayName(GrouperSession s,
                                                                     java.lang.String val)
                                                              throws QueryException
Throws:
QueryException

internal_findAllByApproximateExtension

public static java.util.Set internal_findAllByApproximateExtension(GrouperSession s,
                                                                   java.lang.String val)
                                                            throws QueryException
Throws:
QueryException

internal_findAllByApproximateName

public static java.util.Set internal_findAllByApproximateName(GrouperSession s,
                                                              java.lang.String val)
                                                       throws QueryException
Throws:
QueryException

internal_findAllByApproximateNameAny

public static java.util.Set internal_findAllByApproximateNameAny(GrouperSession s,
                                                                 java.lang.String val)
                                                          throws QueryException
Throws:
QueryException

internal_findAllByCreatedAfter

public static java.util.Set internal_findAllByCreatedAfter(GrouperSession s,
                                                           java.util.Date d)
                                                    throws QueryException
Throws:
QueryException

internal_findAllByCreatedBefore

public static java.util.Set internal_findAllByCreatedBefore(GrouperSession s,
                                                            java.util.Date d)
                                                     throws QueryException
Throws:
QueryException

internal_findByName

public static Stem internal_findByName(java.lang.String name,
                                       boolean exceptionIfNull)
                                throws StemNotFoundException
Parameters:
name -
exceptionIfNull -
Returns:
Throws:
StemNotFoundException