Class CheckReport.ReportEntry

java.lang.Object
de.aristaflow.adept2.util.CheckReport.ReportEntry
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
LocalisedCheckReport.LocalisedReportEntry
Enclosing class:
CheckReport

public static class CheckReport.ReportEntry extends Object implements Serializable
Represents an entry in the check report. It corresponds to one error/info/warning/success message of a check.
Author:
Markus Lauer, Kevin Goeser
See Also:
  • Constructor Details

    • ReportEntry

      protected ReportEntry(int entryNumber, String checkID, CheckReport.ResultType reportEntryType, String message, URI... affectedElements)
      Constructs the report entry with the given parameters.
      Parameters:
      entryNumber - the number of this entry in the report
      checkID - the check which created the entry
      reportEntryType - the type of the entry
      message - the message itself
      affectedElements - the process elements affected by this entry
  • Method Details

    • getCheckID

      public String getCheckID()
      Returns ID of the check which created the entry.
      Returns:
      the kind of check
    • getMessage

      public String getMessage()
      Returns the message of the check report entry.
      Returns:
      the message output by a check
    • getReportEntryType

      public CheckReport.ResultType getReportEntryType()
      Returns the type of the entry that identifies the entry e.g. as an error.
      Returns:
      the type of the entry.
    • getEntryNumber

      public int getEntryNumber()
      Returns the number of the entry.
      Returns:
      the number of the entry.
    • getAffectedADEPT2ProcessElements

      public URI[] getAffectedADEPT2ProcessElements()
      Returns the process element identifier URIs that references the process elements which are affected by this report item.
      Returns:
      the process element identifier URIs of the affected elements.