Class A_CmsReport

    • Constructor Summary

      Constructors 
      Constructor Description
      A_CmsReport()  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void addError​(java.lang.Object obj)
      Adds an error object to the list of errors that occurred during the report.
      void addWarning​(java.lang.Object obj)
      Adds a warning object to the list of warnings that occurred during the report.
      java.lang.String formatRuntime()
      Formats the runtime formatted as "hh:mm:ss".
      java.util.List<java.lang.Object> getErrors()
      Returns a list of all errors that occurred during the report.
      long getLastEntryTime()
      Returns the time of last report entry.
      java.util.Locale getLocale()
      Returns the locale this report was initialized with.
      protected CmsMessages getMessages()
      Returns the default report message bundle.
      java.lang.String getReportUpdate​(I_CmsReportUpdateFormatter formatter)
      Fetches the report update for this report since the last time this method was called.
      long getRuntime()
      Returns the time this report has been running.
      java.lang.String getSiteRoot()
      Returns the original site root of the user who started this report, or null if the original site root has not been set.
      java.util.List<java.lang.Object> getWarnings()
      Returns a list of all warnings that occurred during the report.
      boolean hasError()
      Returns if the report generated an error output.
      boolean hasWarning()
      Returns if the report generated a warning output.
      protected void init​(java.util.Locale locale, java.lang.String siteRoot)
      Initializes some member variables for this report.
      protected void print​(java.lang.String value)
      Prints a String to the report.
      protected abstract void print​(java.lang.String value, int format)
      Prints a String to the report, using the indicated formatting.
      void print​(CmsMessageContainer container)
      Prints a localized message to the report.
      void print​(CmsMessageContainer container, int format)
      Prints a localized message to the report, using the indicated formatting.
      protected void println​(java.lang.String value)
      Prints a String with line break to the report.
      protected void println​(java.lang.String value, int format)
      Prints a String with line break to the report, using the indicated formatting.
      void println​(CmsMessageContainer container)
      Prints a localized message to the report.
      void println​(CmsMessageContainer container, int format)
      Prints a localized message to the report, using the indicated formatting.
      void printMessageWithParam​(int m, int n, CmsMessageContainer container, java.lang.Object param)
      Convenience method to print a localized message, followed by a parameter and dots to the report.
      void printMessageWithParam​(CmsMessageContainer container, java.lang.Object param)
      Prints a localized message followed by a parametera and dots to the report.
      java.lang.String removeSiteRoot​(java.lang.String resourcename)
      Removes the report site root prefix from the absolute path in the resource name, that is adjusts the resource name for the report site root.
      void resetRuntime()
      Resets the runtime to 0 milliseconds.
      protected void setLastEntryTime​(long time)
      Sets the time of the last report entry.
      • Methods inherited from class java.lang.Object

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