org.xwiki.extension.job.history

Class ExtensionJobHistoryRecord

java.lang.Object

org.xwiki.extension.job.history.ExtensionJobHistoryRecord

@Unstable
public class ExtensionJobHistoryRecord
extends Object

A record in the ExtensionJobHistory.

Since:

7.1RC1

Version:

$Id: 5c3ddedfa33309de8a06414ebb878995eb6801c2 $

Constructor Summary

Constructors

Constructor and Description
ExtensionJobHistoryRecord(String jobType, ExtensionRequest request, Map<String,QuestionRecorder<Object>> answers, Date startDate, Date endDate) Creates a new unmodifiable history record.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,QuestionRecorder<Object>>	getAnswers()
Date	getEndDate()
String	getId()
String	getJobType()
ExtensionRequest	getRequest()
Date	getStartDate()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionJobHistoryRecord

public ExtensionJobHistoryRecord(String jobType,
                         ExtensionRequest request,
                         Map<String,QuestionRecorder<Object>> answers,
                         Date startDate,
                         Date endDate)

Creates a new unmodifiable history record.

Parameters:

jobType - the job type (normally the job component hint, e.g. "install")

request - the extension request

answers - the answers that were given by the user to the questions asked by the job specified by this history record (if the job was interactive); the key in the given map identifies the question type; the value represents the recorded answers for the corresponding question type

startDate - the date when the job execution started

endDate - the date when the job execution ended

Method Detail

getJobType

public String getJobType()

Returns:

the job type (normally the job component hint, e.g. "install")

getRequest

public ExtensionRequest getRequest()

Returns:

the extension request

getAnswers

public Map<String,QuestionRecorder<Object>> getAnswers()

Returns:

the answers that were given by the user to the questions asked by the job specified by this history record (if the job was interactive); the key in the returned map identifies the question type; the value represents the recorded answers for the corresponding question type

getStartDate

public Date getStartDate()

Returns:

the date when the job execution started

getEndDate

public Date getEndDate()

Returns:

the date when the job execution ended

getId

public String getId()

Returns:

a string that can be used to identify this record