com.adobe.cq.social.scf.core

Class SocialEvent<T extends SocialEvent.SocialActions>

java.lang.Object

org.osgi.service.event.Event

com.adobe.cq.social.scf.core.SocialEvent<T>

Type Parameters:

T - type representing the actions supported by the SocialEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CalendarActionsEvent, CommentEvent, FileLibraryEvent, ForumEvent, JournalEvent, MessagingSocialEvent, ModerationEvent, PublishEvent, QnaEvent, ReviewEvent, TallyEvent

public abstract class SocialEvent<T extends SocialEvent.SocialActions>
extends org.osgi.service.event.Event
implements java.io.Serializable

A generic class to define a Social Event and provide the basic framework and data exposed by events triggered by social actions. This class can be subtyped to define specific social events.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SocialEvent.BaseEventObject Default implementation of the SocialEvent.EventObject
static interface	SocialEvent.EventObject Representation of an event object.
static interface	SocialEvent.SocialActions Verbs for a list of predefined action.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OBJECT Describes the primary object of the activity.
static java.lang.String	SOCIAL_EVENT_TOPIC_PREFIX All Event instances created using SocialEvents will have an event topic starting with this string.
static java.lang.String	TARGET The target SocialEvent.EventObject instance of this event.

Constructor Summary

Constructors

Constructor and Description
SocialEvent(org.osgi.service.event.Event event) This constructor should be used to create a Social Event given an OSGi Event.
SocialEvent(java.lang.String topic, java.lang.String path, java.lang.String userId, T action, java.util.Map<java.lang.String,java.lang.Object> additionalData)
SocialEvent(java.lang.String topic, java.lang.String path, java.lang.String userId, T action, SocialEvent.EventObject source, SocialEvent.EventObject destination, java.util.Map<java.lang.String,java.lang.Object> additionalData)

Method Summary

Modifier and Type	Method and Description
T	getAction()
SocialEvent.EventObject	getObject()
java.lang.String	getPath()
SocialEvent.EventObject	getTarget()
java.lang.String	getUserId()

Methods inherited from class org.osgi.service.event.Event

containsProperty, equals, getProperty, getPropertyNames, getTopic, hashCode, matches, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

TARGET

public static java.lang.String TARGET

The target SocialEvent.EventObject instance of this event.

OBJECT

public static java.lang.String OBJECT

Describes the primary object of the activity. An activity SHOULD contain an object property whose value is a single Object.

SOCIAL_EVENT_TOPIC_PREFIX

public static final java.lang.String SOCIAL_EVENT_TOPIC_PREFIX

All Event instances created using SocialEvents will have an event topic starting with this string.

See Also:

Constant Field Values

Constructor Detail

SocialEvent

public SocialEvent(org.osgi.service.event.Event event)

This constructor should be used to create a Social Event given an OSGi Event.

Parameters:

event - an OSGi event that is known to be a social event

SocialEvent

public SocialEvent(java.lang.String topic,
                   java.lang.String path,
                   java.lang.String userId,
                   T action,
                   java.util.Map<java.lang.String,java.lang.Object> additionalData)

Parameters:

topic - - the topic string for the event.

path - - the jcr node path where the event occurred.

userId - - the user id of the user who triggered the event.

action - - the action that was taken to trigger the event.

additionalData - - a key value pair of any other data that should be part of the event payload.

SocialEvent

public SocialEvent(java.lang.String topic,
                   java.lang.String path,
                   java.lang.String userId,
                   T action,
                   SocialEvent.EventObject source,
                   SocialEvent.EventObject destination,
                   java.util.Map<java.lang.String,java.lang.Object> additionalData)

Method Detail

getUserId

public java.lang.String getUserId()

Returns:

the user id of the user who triggered the event

getAction

public T getAction()

Returns:

the action that triggered this event.

getPath

public java.lang.String getPath()

Returns:

the jcr node path where this event occurred.

getTarget

public SocialEvent.EventObject getTarget()

Returns:

the SocialEvent.EventObject Target of the activity.

getObject

public SocialEvent.EventObject getObject()

Returns:

the SocialEvent.EventObject Object of the activity.