com.sap.portal.navigation

Interface IAddProviderMessageService

All Superinterfaces:

IService

public interface IAddProviderMessageService
extends IService

The interface IAddProviderMessageService enables different providers to add messages of type LoginMessageData

See Also:

ILoginMessageProvider, IMessageProviderRegistration, ILoginMessagesAdminService

Field Summary

static String

KEY The Service key

Method Summary

boolean

addComponentBasedLoginMessage(String messageId, String messageTitle, String componentURL, boolean isPopup, int componentWidth, int componentHeight) Creates a message that is represented by a component.

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

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

Field Detail

KEY

static final String KEY

The Service key

See Also:

Constant Field Values

Method Detail

addComponentBasedLoginMessage

boolean addComponentBasedLoginMessage(String messageId,
                                      String messageTitle,
                                      String componentURL,
                                      boolean isPopup,
                                      int componentWidth,
                                      int componentHeight)

Creates a message that is represented by a component. The component is responsible for displaying the message.

Parameters:

messageTitle - - The message title

componentURL - - PCD path for the message component

isPopup - - Determines whether the message will be displayed as part of login messages (false) or as an exclusive modal pop-up (true)

Returns:

true if the message was created and added successfully 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