com.sap.portal.search.service

Interface ISearchProviderHandler


public interface ISearchProviderHandler

The interface describes a Search Provider's Handler. The handler contains the search provider's SearchTypes object and the SearchProviderDescriptor object.


Method Summary
 SearchProviderDescriptor getDescriptor(Locale locale)
          Gets the search provider's descriptor
 String getKey()
          Gets the handler key - the key should be unique for each search provider
 SearchTypes getSearchTypes(HttpServletRequest request, HttpServletResponse response)
          Deprecated. 
 SearchTypes getSearchTypes(com.sap.security.api.IUser user, Locale locale)
          Retrieves properties of both basic and advanced search.
 

Method Detail

getSearchTypes

@Deprecated
SearchTypes getSearchTypes(HttpServletRequest request,
                                      HttpServletResponse response)
                           throws UserException
Deprecated. 

Retrieves properties of both basic and advanced search. This method is deprecated and used only for the SAP CRM search provider. All other providers should use the getSearchTypes(IUser user , Locale locale) method.

Parameters:
request - The servlet request
response - The servlet response
Returns:
The handler's SearchTypes object
Throws:
UserException - if the user is not applicable

getSearchTypes

SearchTypes getSearchTypes(com.sap.security.api.IUser user,
                           Locale locale)
                           throws UserException
Retrieves properties of both basic and advanced search.

Parameters:
user - The current user
locale - The current user’s locale
Returns:
The handler's SearchTypes object
Throws:
UserException - if the user is not applicable

getDescriptor

SearchProviderDescriptor getDescriptor(Locale locale)
Gets the search provider's descriptor

Parameters:
locale - The current user’s locale
Returns:
The handler SearchProviderDescriptor object

getKey

String getKey()
Gets the handler key - the key should be unique for each search provider

Returns:
the handler key
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-RUNTIME [sap.com] tc/ep/navigation/api api EP-PIN


Copyright 2013 SAP AG Complete Copyright Notice