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

Class SearchServiceDispatcherImpl

java.lang.Object

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

All Implemented Interfaces:

SearchService

public class SearchServiceDispatcherImpl
extends Object
implements SearchService

Author:

nwright

Constructor Summary

Constructors

Constructor and Description
SearchServiceDispatcherImpl()
SearchServiceDispatcherImpl(SearchService... services)

Method Summary

Methods

Modifier and Type	Method and Description
List<SearchService>	getSearchServices()
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	setSearchServices(List<SearchService> searchServices)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchServiceDispatcherImpl

public SearchServiceDispatcherImpl()

SearchServiceDispatcherImpl

public SearchServiceDispatcherImpl(SearchService... services)

Method Detail

getSearchServices

public List<SearchService> getSearchServices()

setSearchServices

public void setSearchServices(List<SearchService> searchServices)

getSearchType

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

Description copied from interface: SearchService

Retrieves information about a particular search type.

Specified by:

getSearchType in interface SearchService

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: SearchService

Retrieves the list of search types known by this service.

Specified by:

getSearchTypes in interface SearchService

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

search

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

Description copied from interface: SearchService

Performs a search.

Specified by:

search in interface SearchService

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

InvalidParameterException - contextInfo is not valid

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred