com.adobe.cq.social.qna.api

Class QnaEvent

java.lang.Object

Event

com.adobe.cq.social.ugcbase.events.SocialEvent<T>

com.adobe.cq.social.commons.events.SocialEvent<QnaEvent.QnaActions>

com.adobe.cq.social.qna.api.QnaEvent

All Implemented Interfaces:

Serializable

public class QnaEvent
extends SocialEvent<QnaEvent.QnaActions>

Defines events that are triggered in a QnA Forum .

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QnaEvent.QnaActions List of available QnA actions that can trigger a QnA event.

Nested classes/interfaces inherited from class com.adobe.cq.social.commons.events.SocialEvent

SocialEvent.SocialActions

Field Summary

Fields

Modifier and Type	Field and Description
static String	QNA_TOPIC The event topic suffix for QnA events.

Fields inherited from class com.adobe.cq.social.ugcbase.events.SocialEvent

SOCIAL_EVENT_TOPIC_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
static QnaEvent	answerCreated(String answerPath, String questionPath, String qnaForumPath, String userId) Creates a QnAEvent that represents an action of QnaActions.ANSWER_CREATED
static QnaEvent	answerDeleted(String answerPath, String questionPath, String qnaForumPath, String userId) Creates a QnAEvent that represents an action of QnaActions.ANSWER_DELETED
static QnaEvent	answerEdited(String answerPath, String questionPath, String qnaForumPath, String userId) Creates a QnAEvent that represents an action of QnaActions.ANSWER_EDITED
static QnaEvent	answerSelected(String questionPath, String answerPath, String qnaForumPath, String userId) Creates a QnAEvent that represents an action of QnaActions.ANSWER_SELECTED
static QnaEvent	answerUnselected(String questionPath, String answerPath, String qnaForumPath, String userId) Creates a QnAEvent that represents an action of QnaActions.ANSWER_UNSELECTED
static QnaEvent	fromEvent(Event event) Retrieves the QnA event from the given generic Event.
String	getAnswerPath()
String	getQnaForumPath()
String	getQuestionPath()
static QnaEvent	questionCreated(String questionPath, String qnaForumPath, String userId) Creates a QnAEvent that represents an action of QnaActions.QUESTION_CREATED
static QnaEvent	questionDeleted(String questionPath, String qnaForumPath, String userId) Creates a QnAEvent that represents an action of QnaActions.QUESTION_DELETED
static QnaEvent	questionEdited(String questionPath, String qnaForumPath, String userId) Creates a QnAEvent that represents an action of QnaActions.QUESTION_EDITED

Methods inherited from class com.adobe.cq.social.ugcbase.events.SocialEvent

getAction, getPath, getUserId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

QNA_TOPIC

public static final String QNA_TOPIC

The event topic suffix for QnA events.

See Also:

Constant Field Values

Method Detail

answerSelected

public static QnaEvent answerSelected(String questionPath,
                      String answerPath,
                      String qnaForumPath,
                      String userId)

Creates a QnAEvent that represents an action of QnaActions.ANSWER_SELECTED

Parameters:

questionPath - - the jcr node path of the question for which an answer was selected.

answerPath - - the jcr node path of the answer that was chosen as the correct answer.

qnaForumPath - - the jcr node path to the QnA forum to which the question belongs.

userId - - the user id of the user who selected the answer.

answerUnselected

public static QnaEvent answerUnselected(String questionPath,
                        String answerPath,
                        String qnaForumPath,
                        String userId)

Creates a QnAEvent that represents an action of QnaActions.ANSWER_UNSELECTED

Parameters:

questionPath - - the jcr node path of the question for which an answer was unselected.

answerPath - - the jcr node path of the answer that was removed as the correct answer.

qnaForumPath - - the jcr node path to the QnA forum to which the question belongs.

userId - - the user id of the user who unselected the answer.

getQnaForumPath

public String getQnaForumPath()

Returns:

the jcr node path to the QnA Forum in which this event happened.

getAnswerPath

public String getAnswerPath()

Returns:

the jcr path to the answer node that was part of this event. For QnAEvents that represent a question being created, deleted or edited, this will be null.

getQuestionPath

public String getQuestionPath()

Returns:

the jcr path to the question node that was part of this event.

questionCreated

public static QnaEvent questionCreated(String questionPath,
                       String qnaForumPath,
                       String userId)

Creates a QnAEvent that represents an action of QnaActions.QUESTION_CREATED

Parameters:

questionPath - - the jcr node path to the question that was created.

qnaForumPath - - the jcr node path to the QnA Forum in which the question was created.

userId - - the user id of the user who created the question.

questionEdited

public static QnaEvent questionEdited(String questionPath,
                      String qnaForumPath,
                      String userId)

Creates a QnAEvent that represents an action of QnaActions.QUESTION_EDITED

Parameters:

questionPath - - the jcr node path to the question that was edited.

qnaForumPath - - the jcr node path to the QnA Forum in which the question was edited.

userId - - the user id of the user who edited the question.

questionDeleted

public static QnaEvent questionDeleted(String questionPath,
                       String qnaForumPath,
                       String userId)

Creates a QnAEvent that represents an action of QnaActions.QUESTION_DELETED

Parameters:

questionPath - - the jcr node path to the question that was deleted.

qnaForumPath - - the jcr node path to the QnA Forum in which the question was deleted.

userId - - the user id of the user who deleted the question.

answerCreated

public static QnaEvent answerCreated(String answerPath,
                     String questionPath,
                     String qnaForumPath,
                     String userId)

Creates a QnAEvent that represents an action of QnaActions.ANSWER_CREATED

Parameters:

answerPath - - the jcr node path to the answer that was created.

questionPath - - the jcr node path to the question for which the answer was created.

qnaForumPath - - the jcr node path to the QnA Forum in which the answer was created.

userId - - the user id for the user who created the answer.

answerDeleted

public static QnaEvent answerDeleted(String answerPath,
                     String questionPath,
                     String qnaForumPath,
                     String userId)

Creates a QnAEvent that represents an action of QnaActions.ANSWER_DELETED

Parameters:

answerPath - - the jcr node path to the answer that was deleted.

questionPath - - the jcr node path to the question for which the answer was deleted.

qnaForumPath - - the jcr node path to the QnA Forum in which the answer was deleted.

userId - - the user id for the user who deleted the answer.

answerEdited

public static QnaEvent answerEdited(String answerPath,
                    String questionPath,
                    String qnaForumPath,
                    String userId)

Creates a QnAEvent that represents an action of QnaActions.ANSWER_EDITED

Parameters:

answerPath - - the jcr node path to the answer that was edited.

questionPath - - the jcr node path to the question for which the answer was edited.

qnaForumPath - - the jcr node path to the QnA Forum in which the answer was edited.

userId - - the user id for the user who edited the answer.

fromEvent

public static QnaEvent fromEvent(Event event)

Retrieves the QnA event from the given generic Event.

Parameters:

event - The event.

Returns:

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