com.sapportals.wcm.service.actioninbox

Interface IActionInboxNotification

All Known Subinterfaces:

IActionInboxItem

All Known Implementing Classes:

AbstractActionInboxNotification

public interface IActionInboxNotification

A IActionInboxNotification is something like a 'semantic event' which will be stored as a IActionInboxItem in a user's IActionInboxItemCategory.

Copyright 2004 SAP AG

Method Summary

String	getAssignedRef() Get the assigned reference to something for this notification.
RID	getAssignedRID() Get the rid of the resource that's assigned to this notification.
String	getCategoryID() Get the id of the category this notification is for.
Date	getNotificationDate() Provide the exact date, when this notification was generated.
com.sapportals.portal.security.usermanagement.IUMPrincipal	getOriginator() Deprecated. As of NetWeaver 7.1, replaced by getOriginatorUME()
IPrincipal	getOriginatorUME() Provide the user, who caused this notification.
Properties	getProperties() Provide the properties for this notification.

Method Detail

getCategoryID

String getCategoryID()

Get the id of the category this notification is for.

Returns:

a Strings with the notification's category id.

getOriginator

com.sapportals.portal.security.usermanagement.IUMPrincipal getOriginator()

Deprecated. As of NetWeaver 7.1, replaced by getOriginatorUME()

Provide the user, who caused this notification.

Returns:

a IUMPrincipal which holds the user who caused this notification.

getOriginatorUME

IPrincipal getOriginatorUME()

Provide the user, who caused this notification.

Returns:

a IUMPrincipal which holds the user who caused this notification.

Since:

NetWeaver 7.1

getNotificationDate

Date getNotificationDate()

Provide the exact date, when this notification was generated.

Returns:

a Date with the timestamp of the time when this notification was generated.

getProperties

Properties getProperties()

Provide the properties for this notification.

Returns:

a bag of Properties which define the content of this notification.

getAssignedRef

String getAssignedRef()

Get the assigned reference to something for this notification.

Returns:

a String with the assigned reference or null if no reference is assigned to this notification.

getAssignedRID

RID getAssignedRID()

Get the rid of the resource that's assigned to this notification.

Returns:

the RID of the assigned resource or null if no resource is assigned to this notification.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM