com.sap.portal.search.service

Class SearchProviderDescriptor

java.lang.Object
  extended by com.sap.portal.search.service.SearchProviderDescriptor

public class SearchProviderDescriptor
extends Object

This class describes the search provider descriptor Contains metadata for the search provider.


Constructor Summary
SearchProviderDescriptor(String handlerKey, Locale locale)
          Constructs a new instance
 
Method Summary
 String getAdvancedSearchName()
          Gets the descriptor default advanced search name
 String getBasicSearchName()
          Gets the descriptor default basic search name
 String getDescription()
          Gets the descriptor default description
 String getHandlerKey()
          Gets the descriptor handler key
 Locale getLocale()
          Gets the descriptor Locale
 void setAdvancedSearchName(String advancedSearchName)
          Sets the descriptor default advanced search name
 void setBasicSearchName(String basicSearchName)
          Sets the descriptor default basic search name
 void setDescription(String description)
          Sets the descriptor default description
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchProviderDescriptor

public SearchProviderDescriptor(String handlerKey,
                                Locale locale)
Constructs a new instance

Parameters:
handlerKey - The key of the containing handler that is returned by your implementation of the getKey() method of ISearchProviderHandler that retrieves the descriptor
locale - The current user's locale
Method Detail

getHandlerKey

public String getHandlerKey()
Gets the descriptor handler key

Returns:
handlerKey The key of the containing handler that is returned by your implementation of the getKey() method of ISearchProviderHandler that retrieves the descriptor

getBasicSearchName

public String getBasicSearchName()
Gets the descriptor default basic search name

Returns:
The title of the basic search that appears in the UI

getAdvancedSearchName

public String getAdvancedSearchName()
Gets the descriptor default advanced search name

Returns:
The title of the advanced search that appears in the UI

getDescription

public String getDescription()
Gets the descriptor default description

Returns:
The search provider description that appears in the tooltip

getLocale

public Locale getLocale()
Gets the descriptor Locale

Returns:
The current user's locale

setBasicSearchName

public void setBasicSearchName(String basicSearchName)
Sets the descriptor default basic search name

Parameters:
basicSearchName - The title of the basic search that appears in the UI

setAdvancedSearchName

public void setAdvancedSearchName(String advancedSearchName)
Sets the descriptor default advanced search name

Parameters:
advancedSearchName - The title of the advanced search that appears in the UI

setDescription

public void setDescription(String description)
Sets the descriptor default description

Parameters:
description - The search provider description that appears in the tooltip
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 2011 SAP AG Complete Copyright Notice