org.xwiki.job.event.status

Class QuestionAskedEvent

java.lang.Object

org.xwiki.job.event.status.AbstractQuestionEvent

org.xwiki.job.event.status.QuestionAskedEvent

All Implemented Interfaces:

QuestionEvent, org.xwiki.observation.event.Event

public class QuestionAskedEvent
extends AbstractQuestionEvent

Event fired when an interactive job asks a question. The event listeners have the chance to answer the question before it reaches the user. The event is send with the following parameters:

• source: the related JobStatus instance that can be used to access the question
• data: null

Since:

7.1RC1

Version:

$Id: c63036aa58d7365539d7d4d4bd8fa73f886a928f $

Constructor Summary

Constructors

Constructor and Description
QuestionAskedEvent() Creates a new event.
QuestionAskedEvent(String questionType) Creates a new event for a question of the specified type.
QuestionAskedEvent(String questionType, List<String> jobId) Creates a new event for a question of the specified type and a job with the given id.

Method Summary

Modifier and Type	Method and Description
void	answered() Specify that the question that triggered this event has been answered.
boolean	isAnswered()

Methods inherited from class org.xwiki.job.event.status.AbstractQuestionEvent

equals, getJobId, getQuestionType, hashCode, matches

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QuestionAskedEvent

public QuestionAskedEvent()

Creates a new event.

QuestionAskedEvent

public QuestionAskedEvent(String questionType)

Creates a new event for a question of the specified type.

Parameters:

questionType - the type of question that has been asked

QuestionAskedEvent

public QuestionAskedEvent(String questionType,
                          List<String> jobId)

Creates a new event for a question of the specified type and a job with the given id.

Parameters:

questionType - the type of question that has been asked

jobId - the id of the job that raised the question that triggered this event

Method Detail

answered

public void answered()

Specify that the question that triggered this event has been answered. This method is normally called by an event listener that answers the question by modifying the object that represents the question.

isAnswered

public boolean isAnswered()

Returns:

true if the question that triggered this event has been answered by one of the event listeners, false otherwise