com.sap.portal.search

Interface ISearchProvider

All Superinterfaces:

IService

public interface ISearchProvider
extends IService

Represents a single search provider. Checks whether the requested search is applicable for the specified environment (for example, if the current user has permissions for the specified back-end system) and returns an XML description compliant with a public or internal standard, defining, for example, which fields to display in the search UI.

Method Summary

String	getXMLDescription(Hashtable environment) Retrieves a string containing the search provider’s XML description, compliant with a public or internal standard
boolean	isApplicable(Hashtable environment) Checks whether the requested search is applicable for the specified environment

Methods inherited from interface com.sapportals.portal.prt.service.IService

afterInit, configure, destroy, getContext, getKey, init, release

Method Detail

getXMLDescription

String getXMLDescription(Hashtable environment)

Retrieves a string containing the search provider’s XML description, compliant with a public or internal standard

Parameters:

environment - the user context

Returns:

a string representation of the search description XML

isApplicable

boolean isApplicable(Hashtable environment)

Checks whether the requested search is applicable for the specified environment

Parameters:

environment - the user context

Returns:

true if the current user should be introduced to this search option and false otherwise

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