Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.core.report
Interface Reporter<T extends Message>

Type Parameters:
T - the message type
All Superinterfaces:
Report<T>, ReportLog<T>
All Known Subinterfaces:
InstanceValidationReporter, IOReporter, TransformationReporter
All Known Implementing Classes:
DefaultInstanceValidationReporter, DefaultIOReporter, DefaultReporter, DefaultTransformationReporter

public interface Reporter<T extends Message>
extends Report<T>, ReportLog<T>

Reporter interface

Since:
2.5
Author:
Simon Templer
Partner:
01 / Fraunhofer Institute for Computer Graphics Research

Method Summary
 void setStartTime(Date starttime)
          Set the start time of the report.
 void setSuccess(boolean success)
          Set if the task was successful.
 void setSummary(String summary)
          Set the summary message of the report.
 void setTimestamp(Date timestamp)
          Set the report time
 
Methods inherited from interface eu.esdihumboldt.hale.common.core.report.Report
getErrors, getInfos, getMessageType, getStartTime, getSummary, getTaskName, getTimestamp, getWarnings, isSuccess
 
Methods inherited from interface eu.esdihumboldt.hale.common.core.report.ReportLog
error, info, warn
 

Method Detail

setSuccess

void setSuccess(boolean success)
Set if the task was successful. Should set the timestamps if none are provided so far. Should be called when the task is finished.

Parameters:
success - if the task was successful

setSummary

void setSummary(String summary)
Set the summary message of the report.

Parameters:
summary - the summary to set, if null the report will revert to the default summary.

setTimestamp

void setTimestamp(Date timestamp)
Set the report time

Parameters:
timestamp - the timestamp

setStartTime

void setStartTime(Date starttime)
Set the start time of the report. This is optional. If a start time is present the Report.getTimestamp() can be seen as an end time and used to compute a duration.

Parameters:
starttime - the starttime

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d