org.kuali.student.common.search.service
Interface SearchService

All Known Subinterfaces:

AtpService, EnumerationManagementService, LearningObjectiveService, LrcService, LuService, OrganizationService, ProgramService, ProposalService, StatementService, SubjectCodeService

All Known Implementing Classes:

AtpServiceImpl, EnumerationManagementServiceImpl, LearningObjectiveServiceImpl, LrcServiceImpl, LuServiceImpl, MockSubjectCodeServiceImpl, OrganizationServiceImpl, PersonSearchServiceImpl, ProgramServiceImpl, ProposalServiceImpl, StatementServiceImpl, SubjectCodeServiceImpl

public interface SearchService

Method Summary

SearchCriteriaTypeInfo	getSearchCriteriaType(String searchCriteriaTypeKey) Retrieves information about a particular search criteria type.
List<SearchCriteriaTypeInfo>	getSearchCriteriaTypes() Retrieves the list of search criteria types known by this service.
SearchResultTypeInfo	getSearchResultType(String searchResultTypeKey) Retrieves information about a particular search result type.
List<SearchResultTypeInfo>	getSearchResultTypes() Retrieves the list of search result types known by this service.
SearchTypeInfo	getSearchType(String searchTypeKey) Retrieves information about a particular search type.
List<SearchTypeInfo>	getSearchTypes() Retrieves the list of search types known by this service.
List<SearchTypeInfo>	getSearchTypesByCriteria(String searchCriteriaTypeKey) Retrieves the list of search types which use criteria in the specified format.
List<SearchTypeInfo>	getSearchTypesByResult(String searchResultTypeKey) Retrieves the list of search types which return results in the specified format.
SearchResult	search(SearchRequest searchRequest)

Method Detail

getSearchTypes

@RequestWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchTypes",
                targetNamespace="http://student.kuali.org/wsdl/search")
@ResponseWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchTypesResponse",
                 targetNamespace="http://student.kuali.org/wsdl/search")
List<SearchTypeInfo> getSearchTypes()
                                    throws OperationFailedException

Retrieves the list of search types known by this service.

Parameters:

None - No Parameters

Returns:

list of search type information

Throws:

OperationFailedException - unable to complete request

getSearchType

@RequestWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchType",
                targetNamespace="http://student.kuali.org/wsdl/search")
@ResponseWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchTypeResponse",
                 targetNamespace="http://student.kuali.org/wsdl/search")
SearchTypeInfo getSearchType(String searchTypeKey)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException

Retrieves information about a particular search type.

Parameters:

searchTypeKey - identifier of the search type

Returns:

information on the search type

Throws:

DoesNotExistException - specified searchTypeKey not found

InvalidParameterException - invalid searchTypeKey

MissingParameterException - searchTypeKey not specified

OperationFailedException - unable to complete request

getSearchTypesByResult

@RequestWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchTypesByResult",
                targetNamespace="http://student.kuali.org/wsdl/search")
@ResponseWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchTypesByResultResponse",
                 targetNamespace="http://student.kuali.org/wsdl/search")
List<SearchTypeInfo> getSearchTypesByResult(String searchResultTypeKey)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException

Retrieves the list of search types which return results in the specified format.

Parameters:

searchResultTypeKey - identifier of the search result type

Returns:

list of search type information

Throws:

DoesNotExistException - specified searchResultTypeKey not found

InvalidParameterException - invalid searchResultTypeKey

MissingParameterException - searchResultTypeKey not specified

OperationFailedException - unable to complete request

getSearchTypesByCriteria

@RequestWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchTypesByCriteria",
                targetNamespace="http://student.kuali.org/wsdl/search")
@ResponseWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchTypesByCriteriaResponse",
                 targetNamespace="http://student.kuali.org/wsdl/search")
List<SearchTypeInfo> getSearchTypesByCriteria(String searchCriteriaTypeKey)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException

Retrieves the list of search types which use criteria in the specified format.

Parameters:

searchCriteriaTypeKey - identifier of the search criteria

Returns:

list of search type information

Throws:

DoesNotExistException - specified searchCriteriaTypeKey not found

InvalidParameterException - invalid searchCriteriaTypeKey

MissingParameterException - searchCriteriaTypeKey not specified

OperationFailedException - unable to complete request

getSearchResultTypes

@RequestWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchResultTypes",
                targetNamespace="http://student.kuali.org/wsdl/search")
@ResponseWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchResultTypesResponse",
                 targetNamespace="http://student.kuali.org/wsdl/search")
List<SearchResultTypeInfo> getSearchResultTypes()
                                                throws OperationFailedException

Retrieves the list of search result types known by this service. Search result types describe the return structure for a search.

Parameters:

None - No Parameters

Returns:

list of search result type information

Throws:

OperationFailedException - unable to complete request

getSearchResultType

@RequestWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchResultType",
                targetNamespace="http://student.kuali.org/wsdl/search")
@ResponseWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchResultTypeResponse",
                 targetNamespace="http://student.kuali.org/wsdl/search")
SearchResultTypeInfo getSearchResultType(String searchResultTypeKey)
                                         throws DoesNotExistException,
                                                InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException

Retrieves information about a particular search result type. Search result types describe the return structure for a search.

Parameters:

searchResultTypeKey - identifier of the search result type

Returns:

information on the search result type

Throws:

DoesNotExistException - specified searchResultTypeKey not found

InvalidParameterException - invalid searchResultTypeKey

MissingParameterException - searchResultTypeKey not specified

OperationFailedException - unable to complete request

getSearchCriteriaTypes

@RequestWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchCriteriaTypes",
                targetNamespace="http://student.kuali.org/wsdl/search")
@ResponseWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchCriteriaTypesResponse",
                 targetNamespace="http://student.kuali.org/wsdl/search")
List<SearchCriteriaTypeInfo> getSearchCriteriaTypes()
                                                    throws OperationFailedException

Retrieves the list of search criteria types known by this service.

Parameters:

None - No parameters

Returns:

list of search criteria type information

Throws:

OperationFailedException - unable to complete request

getSearchCriteriaType

@RequestWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchCriteriaType",
                targetNamespace="http://student.kuali.org/wsdl/search")
@ResponseWrapper(className="org.kuali.student.common.search.service.jaxws.GetSearchCriteriaTypeResponse",
                 targetNamespace="http://student.kuali.org/wsdl/search")
SearchCriteriaTypeInfo getSearchCriteriaType(String searchCriteriaTypeKey)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException

Retrieves information about a particular search criteria type.

Parameters:

searchCriteriaTypeKey - identifier of the search criteria type

Returns:

information on the search criteria type

Throws:

DoesNotExistException - specified searchCriteriaTypeKey not found

InvalidParameterException - invalid searchCriteriaTypeKey

MissingParameterException - searchCriteriaTypeKey not specified

OperationFailedException - unable to complete request

search

@RequestWrapper(className="org.kuali.student.common.search.service.jaxws.Search",
                targetNamespace="http://student.kuali.org/wsdl/search")
@ResponseWrapper(className="org.kuali.student.common.search.service.jaxws.SearchResponse",
                 targetNamespace="http://student.kuali.org/wsdl/search")
SearchResult search(SearchRequest searchRequest)
                    throws MissingParameterException

Throws:

MissingParameterException