com.adobe.cq.social.commons.events

Class CommentEvent

java.lang.Object

org.osgi.service.event.Event

com.adobe.cq.social.scf.core.SocialEvent<CommentEvent.CommentActions>

com.adobe.cq.social.commons.events.CommentEvent

All Implemented Interfaces:

java.io.Serializable

public class CommentEvent
extends SocialEvent<CommentEvent.CommentActions>

Defines events that are triggered in a comment system.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommentEvent.CommentActions List of available comment actions that can trigger a comment event.

Nested classes/interfaces inherited from class com.adobe.cq.social.scf.core.SocialEvent

SocialEvent.BaseEventObject, SocialEvent.EventObject, SocialEvent.SocialActions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMENT_TOPIC The event topic suffix for comment events.
static java.lang.String	VERBS_ALLOW
static java.lang.String	VERBS_CHANGESTATE
static java.lang.String	VERBS_REOPEN

Fields inherited from class com.adobe.cq.social.scf.core.SocialEvent

OBJECT, SOCIAL_EVENT_TOPIC_PREFIX, TARGET

Constructor Summary

Constructors

Constructor and Description
CommentEvent(Comment comment, java.lang.String userId, CommentEvent.CommentActions action)

Method Summary

Modifier and Type	Method and Description
static CommentEvent	fromEvent(org.osgi.service.event.Event event) Retrieves the comment event from the given generic Event.
java.lang.String	getCommentSystemPath()

Methods inherited from class com.adobe.cq.social.scf.core.SocialEvent

getAction, getObject, getPath, getTarget, 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

COMMENT_TOPIC

public static final java.lang.String COMMENT_TOPIC

The event topic suffix for comment events.

See Also:

Constant Field Values

VERBS_CHANGESTATE

public static final java.lang.String VERBS_CHANGESTATE

See Also:

Constant Field Values

VERBS_ALLOW

public static final java.lang.String VERBS_ALLOW

See Also:

Constant Field Values

VERBS_REOPEN

public static final java.lang.String VERBS_REOPEN

See Also:

Constant Field Values

Constructor Detail

CommentEvent

public CommentEvent(Comment comment,
                    java.lang.String userId,
                    CommentEvent.CommentActions action)

Parameters:

comment - - the comment node on which the event was triggered

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

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

Method Detail

getCommentSystemPath

public java.lang.String getCommentSystemPath()

Returns:

the path to the comment system of the comment on which this event was triggered.

fromEvent

public static CommentEvent fromEvent(org.osgi.service.event.Event event)

Retrieves the comment event from the given generic Event.

Parameters:

event - The event.

Returns:

The comment event or null if the given event is not a comment event.