com.sap.portal.suggestion.providers

Interface ISuggestionProvider

All Known Subinterfaces:
ISuggestionProviderExtended

public interface ISuggestionProvider

Represents a Provider of com.sap.portal.suggestion.providers.Suggestion objects


Method Summary
 ICategoryDescriptor getCategory()
          Return an ICategoryDescriptor object which represents a category supported by this provider
 String getSuggestionProviderID()
          Returns the ID of the suggestion provider
 List<ISuggestion> search(String searchTerm, com.sap.security.api.IUser user, Locale locale, ISuggestionFilter filterObj)
          Searches
 

Method Detail

search

List<ISuggestion> search(String searchTerm,
                         com.sap.security.api.IUser user,
                         Locale locale,
                         ISuggestionFilter filterObj)
Searches

Parameters:
searchTerm - - the search term entered by the user
user - - the current user
locale - - the current user's locale
filterObj - - a ISuggestionFilter object containing filter parameters according to which the suggestions should be filtered
Returns:
A list of com.sap.portal.suggestion.providers.Suggestion objects

getCategory

ICategoryDescriptor getCategory()
Return an ICategoryDescriptor object which represents a category supported by this provider

Returns:
an ICategoryDescriptor object which represents a category supported by this provider

getSuggestionProviderID

String getSuggestionProviderID()
Returns the ID of the suggestion provider

Returns:
The ID of ISuggestionProvider
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 2015 SAP AG Complete Copyright Notice