org.kuali.student.r2.common.class1.search

Class SearchManagerImpl

java.lang.Object

org.kuali.student.r2.common.class1.search.SearchManagerImpl

All Implemented Interfaces:

SearchManager

public class SearchManagerImpl
extends Object
implements SearchManager

Loads all search info for a service into memory

Constructor Summary

Constructors

Constructor and Description
SearchManagerImpl(String searchContextFile)
SearchManagerImpl(String searchContextFile, EntityManager em) This Constructor should only be used in tests.

Method Summary

Methods

Modifier and Type	Method and Description
SearchableCrudDaoImpl	getDao()
String	getSearchContextFile()
TypeInfo	getSearchType(String searchTypeKey, ContextInfo contextInfo) Retrieves information about a particular search type.
List<TypeInfo>	getSearchTypes(ContextInfo contextInfo) Retrieves the list of search types known by this service.
SearchResultInfo	search(SearchRequestInfo searchRequestInfo, ContextInfo contextInfo) Performs a search.
void	setCrossSearchManager(CrossSearchManager crossSearchManager)
void	setDao(SearchableCrudDaoImpl dao)
void	setSearchContext(String searchContextFile)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchManagerImpl

public SearchManagerImpl(String searchContextFile)

SearchManagerImpl

public SearchManagerImpl(String searchContextFile,
                 EntityManager em)

This Constructor should only be used in tests.

Parameters:

searchContextFile -

em -

Method Detail

getSearchType

public TypeInfo getSearchType(String searchTypeKey,
                     ContextInfo contextInfo)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException

Description copied from interface: SearchManager

Retrieves information about a particular search type.

Specified by:

getSearchType in interface SearchManager

Parameters:

searchTypeKey - identifier of the search type

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

information on the search type

Throws:

DoesNotExistException - specified searchTypeKey not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - searchTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

getSearchTypes

public List<TypeInfo> getSearchTypes(ContextInfo contextInfo)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException

Description copied from interface: SearchManager

Retrieves the list of search types known by this service.

Specified by:

getSearchTypes in interface SearchManager

Parameters:

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

list of search type information

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - contextInfo is missing or null

OperationFailedException - unable to complete request

getSearchContextFile

public String getSearchContextFile()

setSearchContext

public void setSearchContext(String searchContextFile)

search

public SearchResultInfo search(SearchRequestInfo searchRequestInfo,
                      ContextInfo contextInfo)
                        throws MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException,
                               InvalidParameterException

Description copied from interface: SearchManager

Performs a search.

Specified by:

search in interface SearchManager

Parameters:

searchRequestInfo - the search request

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the results of the search

Throws:

MissingParameterException - searchRequestInfo or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

InvalidParameterException - contextInfo is not valid

setCrossSearchManager

public void setCrossSearchManager(CrossSearchManager crossSearchManager)

getDao

public SearchableCrudDaoImpl getDao()

setDao

public void setDao(SearchableCrudDaoImpl dao)