edu.internet2.middleware.grouper.entity
Class EntityFinder

java.lang.Object
  edu.internet2.middleware.grouper.entity.EntityFinder

public class EntityFinder
extends java.lang.Object

class to find entities. TODO add in finder by attribute subject id TODO add former names

Author:

mchyzer

Constructor Summary

EntityFinder()

Method Summary

EntityFinder	addAncestorFolderId(java.lang.String theFolderId) add an ancestor folder id to search in
EntityFinder	addAncestorFolderName(java.lang.String theFolderName) add an ancestor folder name to search in
EntityFinder	addId(java.lang.String theId) add an entity id to search for
EntityFinder	addName(java.lang.String theName) add an entity name to search for
EntityFinder	addParentFolderId(java.lang.String parentFolderId) add a parent folder id to search for.
EntityFinder	addParentFolderName(java.lang.String parentFolderName) add a parent folder name to search in, note this is the immediate parent folder name, not an ancentor
EntityFinder	assignQueryOptions(QueryOptions queryOptions1) assign query options for sorting and paging
EntityFinder	assignTerms(java.lang.String theTerms) add a search term, any substring which will be split by spaces
java.util.Set<Entity>	findEntities() find a list of entities
java.util.List<java.lang.Object[]>	findEntitiesAndSubjectIdentifier() find a list of entities, and the String subjectIdentifier
Entity	findEntity(boolean exceptionIfNotFound) find an entity
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EntityFinder

public EntityFinder()

Method Detail

assignTerms

public EntityFinder assignTerms(java.lang.String theTerms)

add a search term, any substring which will be split by spaces

Parameters:

theTerms -

Returns:

this for chaining

addId

public EntityFinder addId(java.lang.String theId)

add an entity id to search for

Parameters:

theId -

Returns:

this for chaining

addName

public EntityFinder addName(java.lang.String theName)

add an entity name to search for

Parameters:

theName -

Returns:

this for chaining

addParentFolderId

public EntityFinder addParentFolderId(java.lang.String parentFolderId)

add a parent folder id to search for. note, this is the immediate parent folder id, not ancestor

Parameters:

parentFolderId -

Returns:

this for chaining

addParentFolderName

public EntityFinder addParentFolderName(java.lang.String parentFolderName)

add a parent folder name to search in, note this is the immediate parent folder name, not an ancentor

Parameters:

parentFolderName -

Returns:

this for chaining

findEntity

public Entity findEntity(boolean exceptionIfNotFound)

find an entity

Parameters:

exceptionIfNotFound - true if exception should be thrown if entity not found

Returns:

the entity or null or exception

addAncestorFolderName

public EntityFinder addAncestorFolderName(java.lang.String theFolderName)

add an ancestor folder name to search in

Parameters:

theFolderName -

Returns:

the folder name

addAncestorFolderId

public EntityFinder addAncestorFolderId(java.lang.String theFolderId)

add an ancestor folder id to search in

Parameters:

theFolderId -

Returns:

this for chaining

findEntities

public java.util.Set<Entity> findEntities()

find a list of entities

Returns:

the set of entities never null

findEntitiesAndSubjectIdentifier

public java.util.List<java.lang.Object[]> findEntitiesAndSubjectIdentifier()

find a list of entities, and the String subjectIdentifier

Returns:

the list of entities never null, if there is a subjectIdentifier for the entity, that will be next in the array, else null

assignQueryOptions

public EntityFinder assignQueryOptions(QueryOptions queryOptions1)

assign query options for sorting and paging

Parameters:

queryOptions1 -

Returns:

this for paging

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()