com.sap.portal.suggestion.providers

Interface ISuggestionProviderRegistration

All Superinterfaces:
IService

public interface ISuggestionProviderRegistration
extends IService

A service which is responsible for managing the registration of ISuggestionProvider objects and setting the active ISuggestionMerger


Field Summary
static String KEY
           
 
Method Summary
 void register(ISuggestionProvider suggestionProvider)
          Registers the specified suggestion provider for the portal suggestion providers service
 void register(String providerKey, ISuggestionProvider suggestionProvider)
          Deprecated. As of SP06. Instead use register(ISuggestionProvider)
 void setDefaultSuggestionMerger()
          Registers the default implementation of ISuggestionMerger to the portal suggestion providers service
 void setSuggestionMerger(ISuggestionMerger suggestionMerger)
          Registers the specified custom implementation of ISuggestionMerger for the portal suggestion providers service
 void unregister(ISuggestionProvider suggestionProvider)
          Unregisters the specified suggestion provider from the portal suggestion providers service
 void unregister(String providerKey)
          Deprecated. As of SP06. Instead use unregister(ISuggestionProvider)
 
Methods inherited from interface com.sapportals.portal.prt.service.IService
afterInit, configure, destroy, getContext, getKey, init, release
 

Field Detail

KEY

static final String KEY
See Also:
Constant Field Values
Method Detail

register

void register(String providerKey,
              ISuggestionProvider suggestionProvider)
Deprecated. As of SP06. Instead use register(ISuggestionProvider)


register

void register(ISuggestionProvider suggestionProvider)
Registers the specified suggestion provider for the portal suggestion providers service

Parameters:
suggestionProvider - the suggestion provider to register

unregister

void unregister(String providerKey)
Deprecated. As of SP06. Instead use unregister(ISuggestionProvider)


unregister

void unregister(ISuggestionProvider suggestionProvider)
Unregisters the specified suggestion provider from the portal suggestion providers service

Parameters:
suggestionProvider - the suggestion provider

setSuggestionMerger

void setSuggestionMerger(ISuggestionMerger suggestionMerger)
Registers the specified custom implementation of ISuggestionMerger for the portal suggestion providers service

Parameters:
suggestionMerger - suggestionsResultsMerger the custom implementation of ISuggestionMerger

setDefaultSuggestionMerger

void setDefaultSuggestionMerger()
Registers the default implementation of ISuggestionMerger to the portal suggestion providers service

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