SearchService

Name Search
Version
Included Services  
Java Package org.kuali.student.r2.core.search.service

Copyright 2010 The Kuali Foundation Licensed under the
Educational Community License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may
obtain a copy of the License at

http://www.osedu.org/licenses/ECL-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an "AS IS"
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the specific language governing
permissions and limitations under the License.

Operations
Main Message Structures

Method getSearchTypes
Description Retrieves the list of search types known by this service.
Parameters ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfoList list of search type information
Errors InvalidParameterException contextInfo is not valid
MissingParameterException contextInfo
is missing or null
OperationFailedException unable to complete request

Back to Operations

Method getSearchType
Description Retrieves information about a particular search type.
Parameters String searchTypeKey identifier of the search type
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfo information on the search type
Errors DoesNotExistException specified searchTypeKey not found
InvalidParameterException contextInfo is not valid
MissingParameterException searchTypeKey or contextInfo
is missing or null
OperationFailedException unable to complete request

Back to Operations

Method getSearchTypesByResult
Description Retrieves the list of search types which return results in the
specified format.
Parameters String searchResultTypeKey identifier of the search result type
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfoList list of search type information
Errors DoesNotExistException specified searchResultTypeKey not found
InvalidParameterException contextInfo is not valid
MissingParameterException searchResultTypeKey or contextInfo
is missing or null
OperationFailedException unable to complete request

Back to Operations

Method getSearchTypesByCriteria
Description Retrieves the list of search types which use criteria in the
specified format.
Parameters String searchCriteriaTypeKey identifier of the search criteria
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfoList list of search type information
Errors DoesNotExistException specified searchCriteriaTypeKey not found
InvalidParameterException contextInfo is not valid
MissingParameterException searchCriteriaTypeKey or
contextInfo is missing or null
OperationFailedException unable to complete request

Back to Operations

Method getSearchResultTypes
Description Retrieves the list of search result types known by this
service. Search result types describe the return structure for
a search.
Parameters ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfoList ???
Errors InvalidParameterException contextInfo is not valid
MissingParameterException contextInfo is missing or null
OperationFailedException unable to complete request

Back to Operations

Method getSearchCriteriaTypes
Description Retrieves the list of search criteria types known by this
service.
Parameters ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfoList list of search criteria type information
Errors InvalidParameterException contextInfo is not valid
MissingParameterException contextInfo is missing or null
OperationFailedException unable to complete request

Back to Operations

Method search
Description Performs a search.
Parameters SearchRequestInfo searchRequestInfo the search request
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return SearchResultInfo the results of the search
Errors MissingParameterException searchRequestInfo or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations