com.adobe.cq.social.commons.moderation.events

Class ModerationEvent

java.lang.Object

org.osgi.service.event.Event

com.adobe.cq.social.scf.core.SocialEvent<ModerationOperationExtension.ModerationOperation>

com.adobe.cq.social.commons.moderation.events.ModerationEvent

All Implemented Interfaces:

java.io.Serializable

public class ModerationEvent
extends SocialEvent<ModerationOperationExtension.ModerationOperation>

An Event to be sent when a moderation action occurs.

See Also:

Serialized Form

Nested Class Summary

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	TOPIC
static java.lang.String	TOPIC_SUFFIX Strings for the topic of this event.

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

OBJECT, SOCIAL_EVENT_TOPIC_PREFIX, TARGET

Constructor Summary

Constructors

Constructor and Description
ModerationEvent(java.lang.String path, java.lang.String userId, ModerationOperationExtension.ModerationOperation action, java.util.Map<java.lang.String,java.lang.Object> additionalData) Constructors

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object that)
static ModerationEvent	fromEvent(Event event) Retrieves the ModerationEvent from the given generic Event.

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, getProperty, getPropertyNames, getTopic, hashCode, matches, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

TOPIC_SUFFIX

public static final java.lang.String TOPIC_SUFFIX

Strings for the topic of this event.

See Also:

Constant Field Values

TOPIC

public static final java.lang.String TOPIC

See Also:

Constant Field Values

Constructor Detail

ModerationEvent

public ModerationEvent(java.lang.String path,
                       java.lang.String userId,
                       ModerationOperationExtension.ModerationOperation action,
                       java.util.Map<java.lang.String,java.lang.Object> additionalData)

Constructors

Parameters:

path - String

userId - user

action - ModerationOperation

additionalData - Map

Method Detail

fromEvent

public static ModerationEvent fromEvent(Event event)

Retrieves the ModerationEvent from the given generic Event.

Parameters:

event - The event.

Returns:

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

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class Event