com.sap.portal.navigation

Interface ILoginMessageProvider

All Superinterfaces:

IService

public interface ILoginMessageProvider
extends IService

The interface ILoginMessageProvider that represents a single message provider. The message provider role is to perform the required checkup for deciding which messages should be displayed to the user taken from the environment. The environment is received by the PortalLoginMessagesService . The message provider can create and add different message types using the IAddProviderMessageService interface.

See Also:

IMessageProviderRegistration, IAddProviderMessageService, ILoginMessagesAdminService

Method Summary

void	setUserLoginMessages(Hashtable environment) Adds all messages to be displayed by the PortalLoginMessagesService , for the current user (extracted from the received Environment).

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

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

Method Detail

setUserLoginMessages

void setUserLoginMessages(Hashtable environment)

Adds all messages to be displayed by the PortalLoginMessagesService , for the current user (extracted from the received Environment). Added messages can be of any type allowed by the IAddProviderMessageService interface.

Parameters:

environment - - (Hashtable) The default envronment with the user encoded in the request. The relevant end user can be extracted from the Hashtable using the following Key: "NavigationPrincipal" Value: the user context object from the request.

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