com.adobe.cq.social.tally.client.api

Class TallyEvent

java.lang.Object

org.osgi.service.event.Event

com.adobe.cq.social.scf.core.SocialEvent<TallyEvent.TallyActions>

com.adobe.cq.social.tally.client.api.TallyEvent

All Implemented Interfaces:

java.io.Serializable

public class TallyEvent
extends SocialEvent<TallyEvent.TallyActions>

Defines events that are triggered in tally components.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TallyEvent.TallyActions List of available tally actions that can trigger a tally 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	TALLY_TOPIC_PREFIX The event topic suffix for tally events

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

OBJECT, SOCIAL_EVENT_TOPIC_PREFIX, TARGET

Constructor Summary

Constructors

Constructor and Description
TallyEvent(java.lang.String tallyPath, java.lang.String userId, java.lang.String parentPath, java.lang.String tallyType, TallyEvent.TallyActions action)
TallyEvent(java.lang.String tallyPath, java.lang.String userId, java.lang.String parentPath, java.lang.String tallyType, TallyEvent.TallyActions action, java.util.Map<java.lang.String,java.lang.Object> objectExtraProps, java.util.Map<java.lang.String,java.lang.Object> targetExtraProps)

Method Summary

Modifier and Type	Method and Description
static TallyEvent	fromEvent(org.osgi.service.event.Event event) Retrieves the tally event from the given generic Event.
java.lang.String	getParentPath()
java.lang.String	getTallyType()

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

TALLY_TOPIC_PREFIX

public static final java.lang.String TALLY_TOPIC_PREFIX

The event topic suffix for tally events

See Also:

Constant Field Values

Constructor Detail

TallyEvent

public TallyEvent(java.lang.String tallyPath,
                  java.lang.String userId,
                  java.lang.String parentPath,
                  java.lang.String tallyType,
                  TallyEvent.TallyActions action)

Parameters:

tallyPath - - the jcr node path to the tally resource on which this event was triggered.

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

parentPath - - the jcr node path to the parent node of the tally resource.

tallyType - - the type of tally component (voting, rating, etc,.).

action - - the tally action that triggered this event.

TallyEvent

public TallyEvent(java.lang.String tallyPath,
                  java.lang.String userId,
                  java.lang.String parentPath,
                  java.lang.String tallyType,
                  TallyEvent.TallyActions action,
                  java.util.Map<java.lang.String,java.lang.Object> objectExtraProps,
                  java.util.Map<java.lang.String,java.lang.Object> targetExtraProps)

Parameters:

tallyPath - - the jcr node path to the tally resource on which this event was triggered.

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

parentPath - - the jcr node path to the parent node of the tally resource.

tallyType - - the type of tally component (voting, rating, etc,.).

action - - the tally action that triggered this event.

Method Detail

getParentPath

public java.lang.String getParentPath()

Returns:

the jcr node path to the parent of the tally resource on which this event was triggered.

fromEvent

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

Retrieves the tally event from the given generic Event.

Parameters:

event - The event.

Returns:

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

getTallyType

public java.lang.String getTallyType()

Returns:

the tally component type of the tally resource on which this event was triggered.