|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.silverpeas.notification.NotificationSource
public class NotificationSource
The source from which a notification was generated. Usually, a notification is triggered by a user action and it informs the event concerning the resource involved in the action. For example, the creation of a new publication by a user in Silverpeas. So the notification is always generated within the scope of a Silverpeas component instance and may involve the action of a given user. This class can be extended to provide additional information about the context of the notification generation.
Constructor Summary | |
---|---|
NotificationSource()
|
Method Summary | |
---|---|
String |
getComponentInstanceId()
Gets the unique identifier of the Silverpeas component instance within which a notification was occured. |
String |
getUserId()
Gets the unique identifier of the user performed the action that has triggered the notification. |
NotificationSource |
withComponentInstanceId(String componentId)
Sets the unique identifier of the Silverpeas component instance within which the notification is occuring. |
NotificationSource |
withUserId(String userId)
Sets the unique identifier of the user that is involved in the notification by performing an action on a Silverpeas managed resource. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NotificationSource()
Method Detail |
---|
public String getComponentInstanceId()
public NotificationSource withComponentInstanceId(String componentId)
componentId
- the component instance identifier.
public String getUserId()
public NotificationSource withUserId(String userId)
userId
- the user identifier.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |