com.sapportals.portal.prt.component

Interface IPortalComponentContext

public interface IPortalComponentContext

The IPortalComponentContext defines a user specific view on a Portal Component.

It gives access to the component's profile; A component may store objects in its context that will be kept as long as the component context is not released.

Method Summary

IPortalComponentEvent	createComponentEvent(IPortalComponentRequest aRequest, String nameSpace, String eventName) Deprecated. Do not use anymore
void	fireEvent(IPortalComponentEvent componentEvent, IPortalComponentRequest request) Deprecated. Do not use anymore
String	getApplicationName() Gets the name of the portal application the component belongs to
Enumeration	getAttributeNames() Returns a Enumeration view of the attribute names contained in this context.
IPortalComponent	getComponent() Returns the component attached to this context.
String	getComponentName() Gets the name of the component associated to this context.
String	getContextName() Returns the name of this context.
IPortalComponentProfile	getProfile() Returns the profile of the component.
ResourceBundle	getResourceBundle(Locale locale) Returns the resourcebundle of the component in a given locale.
Object	getValue(String name) Returns the value of the specified attribute name, specified as a string, or null if the attribute was not found.
void	initialize(IPortalNode portalNode, INode node) Deprecated. Do not use anymore
void	putValue(String name, Object value) Associates the specified value with the specified attribute name, specified as a String.
void	register(String eventName, String nameSpace) Deprecated. Do not use anymore
void	removeValue(String name) Removes the attribute with the specified name from this context.
void	unregister(String name, String nameSpace) Deprecated. Do not use anymore

Method Detail

getComponent

IPortalComponent getComponent()

Returns the component attached to this context.

Returns:

The component attached to this context

getContextName

String getContextName()

Returns the name of this context.

Returns:

The name of the context.

getComponentName

String getComponentName()

Gets the name of the component associated to this context. A component can be associated to several contexts.

Returns:

The name of the associated component.

getProfile

IPortalComponentProfile getProfile()

Returns the profile of the component. The profile is personalizable and can be made persistent.

Returns:

The profile of the component

getResourceBundle

ResourceBundle getResourceBundle(Locale locale)

Returns the resourcebundle of the component in a given locale.

Returns:

The resourcebundle of the component

putValue

void putValue(String name,
              Object value)

Associates the specified value with the specified attribute name, specified as a String.

Parameters:

name - the attribute name.

value - the attribute value.

getValue

Object getValue(String name)

Returns the value of the specified attribute name, specified as a string, or null if the attribute was not found.

Parameters:

name - the attribute name as a string

Returns:

the value to which the attribute name is mapped in this hashtable; null if it is not mapped to any value.

removeValue

void removeValue(String name)

Removes the attribute with the specified name from this context.

Parameters:

name - attribute name

getAttributeNames

Enumeration getAttributeNames()

Returns a Enumeration view of the attribute names contained in this context.

Returns:

an Enumeration of attributes names held in this context or null if empty.

register

void register(String eventName,
              String nameSpace)

Deprecated. Do not use anymore

Adds this context as listener to an event.

Parameters:

eventName - name of the event to register.

nameSpace - the name space of the event to register.

unregister

void unregister(String name,
                String nameSpace)

Deprecated. Do not use anymore

Removes this context as listener to event.

Parameters:

name - name of the event to unregister.

nameSpace - name space of the event to unregister.

initialize

void initialize(IPortalNode portalNode,
                INode node)

Deprecated. Do not use anymore

Initialize this context for the current Portal Node. It may be used to register all listeners attached to this context on the portal node.

Parameters:

portalNode - the portal node.

node - the node for this context.

fireEvent

void fireEvent(IPortalComponentEvent componentEvent,
               IPortalComponentRequest request)

Deprecated. Do not use anymore

Notifies all listeners that have registered interest for notification on the specified component event.

Parameters:

componentEvent - the component event containing potential data.

request - the portal component request.

createComponentEvent

IPortalComponentEvent createComponentEvent(IPortalComponentRequest aRequest,
                                           String nameSpace,
                                           String eventName)

Deprecated. Do not use anymore

Create a component event.

Parameters:

aRequest - the portal component request.

eventName - the name of the event to create.

nameSpace - the name space of the event.

Returns:

the newly created component event.

getApplicationName

String getApplicationName()

Gets the name of the portal application the component belongs to

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/lib/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._apideprecated	default	EP-PIN-PRT