Humboldt Alignment Editor 2.5.0

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

Type Parameters:
T - the message type
All Known Subinterfaces:
InstanceValidationReport, InstanceValidationReporter, IOReport, IOReporter, Reporter<T>, TransformationReport, TransformationReporter
All Known Implementing Classes:
DefaultInstanceValidationReporter, DefaultIOReporter, DefaultReporter, DefaultTransformationReporter

public interface Report<T extends Message>

Report interface

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

Method Summary
 Collection<T> getErrors()
          Get the error messages
 Collection<T> getInfos()
          Get the info messages
 Class<T> getMessageType()
          Get the message type (for determining the message type at runtime).
 Date getStartTime()
          Get the start time of the report.
 String getSummary()
          Get a short message stating a summary of the report
 String getTaskName()
          Get the name of the task the report relates to
 Date getTimestamp()
          Get the report time
 Collection<T> getWarnings()
          Get the warning messages
 boolean isSuccess()
          States if the report represents a successful task
 

Method Detail

getTaskName

String getTaskName()
Get the name of the task the report relates to

Returns:
the task name

isSuccess

boolean isSuccess()
States if the report represents a successful task

Returns:
if the task was successful

getSummary

String getSummary()
Get a short message stating a summary of the report

Returns:
a short summary message

getTimestamp

Date getTimestamp()
Get the report time

Returns:
the report time

getStartTime

Date getStartTime()
Get the start time of the report. This is optional. If a start time is present the getTimestamp() can be seen as an end time and used to compute a duration.

Returns:
the start time or null

getWarnings

Collection<T> getWarnings()
Get the warning messages

Returns:
the warning messages

getErrors

Collection<T> getErrors()
Get the error messages

Returns:
the error messages

getInfos

Collection<T> getInfos()
Get the info messages

Returns:
the info messages

getMessageType

Class<T> getMessageType()
Get the message type (for determining the message type at runtime).

Returns:
the message type

Humboldt Alignment Editor 2.5.0

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