com.sapportals.wcm.service.actioninbox
Class AbstractActionInboxNotification

[contained in: com.sap.km.cm.service.base.par - km.shared.service.actioninbox_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.service.actioninbox.AbstractActionInboxNotification

All Implemented Interfaces:

IActionInboxNotification

public class AbstractActionInboxNotification

extends java.lang.Object

implements IActionInboxNotification

A base implementation of a IActionInboxNotification.

Copyright 2004 SAP AG

Field Summary

protected java.lang.String	m_AssignedRef the assigend reference.
protected RID	m_AssignedRID the assigend resources RID.
protected java.lang.String	m_CategoryID the id of the category the notification belongs to.
protected Descriptions	m_Descriptions the descriptions stored with the locale.toString() as key.
protected java.util.Date	m_NotificationDate the date when the notification was created.
protected com.sapportals.portal.security.usermanagement.IUMPrincipal	m_Originator the originator of that notification.
protected java.util.Properties	m_Properties the properties.

Constructor Summary

AbstractActionInboxNotification(java.lang.String categoryID, Descriptions descriptions, com.sapportals.portal.security.usermanagement.IUMPrincipal originator, java.util.Date notificationDate, java.util.Properties properties, java.lang.String assignedRef, RID assignedRID)

Method Summary

java.lang.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.
java.lang.String	getCategoryID() Get the id of the category this notification is for.
java.util.Date	getNotificationDate() Provide the exact date, when this notification was generated.
com.sapportals.portal.security.usermanagement.IUMPrincipal	getOriginator() Provide the user, who caused this notification.
java.util.Properties	getProperties() Provide the properties for this notification.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_CategoryID

protected java.lang.String m_CategoryID

the id of the category the notification belongs to.

m_Descriptions

protected Descriptions m_Descriptions

the descriptions stored with the locale.toString() as key.

m_Originator

protected com.sapportals.portal.security.usermanagement.IUMPrincipal m_Originator

the originator of that notification.

m_NotificationDate

protected java.util.Date m_NotificationDate

the date when the notification was created.

m_Properties

protected java.util.Properties m_Properties

the properties.

m_AssignedRef

protected java.lang.String m_AssignedRef

the assigend reference.

m_AssignedRID

protected RID m_AssignedRID

the assigend resources RID.

Constructor Detail

AbstractActionInboxNotification

public AbstractActionInboxNotification(java.lang.String categoryID,
                                       Descriptions descriptions,
                                       com.sapportals.portal.security.usermanagement.IUMPrincipal originator,
                                       java.util.Date notificationDate,
                                       java.util.Properties properties,
                                       java.lang.String assignedRef,
                                       RID assignedRID)

Method Detail

getCategoryID

public java.lang.String getCategoryID()

Description copied from interface: IActionInboxNotification

Get the id of the category this notification is for.

Specified by:

getCategoryID in interface IActionInboxNotification

Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxNotification

Returns:

a Strings with the notification's category id.

getOriginator

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

Description copied from interface: IActionInboxNotification

Provide the user, who caused this notification.

Specified by:

getOriginator in interface IActionInboxNotification

Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxNotification

Returns:

a IUMPrincipal which holds the user who caused this notification.

getNotificationDate

public java.util.Date getNotificationDate()

Description copied from interface: IActionInboxNotification

Provide the exact date, when this notification was generated.

Specified by:

getNotificationDate in interface IActionInboxNotification

Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxNotification

Returns:

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

getProperties

public java.util.Properties getProperties()

Description copied from interface: IActionInboxNotification

Provide the properties for this notification.

Specified by:

getProperties in interface IActionInboxNotification

Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxNotification

Returns:

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

getAssignedRef

public java.lang.String getAssignedRef()

Description copied from interface: IActionInboxNotification

Get the assigned reference to something for this notification.

Specified by:

getAssignedRef in interface IActionInboxNotification

Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxNotification

Returns:

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

getAssignedRID

public RID getAssignedRID()

Description copied from interface: IActionInboxNotification

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

Specified by:

getAssignedRID in interface IActionInboxNotification

Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxNotification

Returns:

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