I_CmsReport

所有已知实现类:

A_CmsReport, CmsHtmlReport, CmsLogReport, CmsMultiplexReport, CmsPrintStreamReport, CmsPublishReport, CmsShellReport, CmsStringBufferReport
```
public interface I_CmsReport
```
This is the interface for the report classes which are used for the output during operations that run on a spearate Thread in OpenCms, like publish, import, export etc.

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`static int`	`FORMAT_DEFAULT` Indicates default formatting.
`static int`	`FORMAT_ERROR` Indicates error formatting.
`static int`	`FORMAT_HEADLINE` Indicates headline formatting.
`static int`	`FORMAT_NOTE` Indicates note formatting.
`static int`	`FORMAT_OK` Indicates OK formatting.
`static int`	`FORMAT_WARNING` Indicates warning formatting.
`static java.lang.String`	`REPORT_TYPE_EXTENDED` Request parameter value that this report should create an "extended" output.
`static java.lang.String`	`REPORT_TYPE_SIMPLE` Request parameter value that this report should create a "simple" output.

方法概要

方法
限定符和类型	方法和说明
`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.
`java.lang.String`	`getReportUpdate()` Updates this report, this processes all new output added since the last call to this method.
`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.
`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.
`void`	`println()` Adds a line break to the report.
`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`	`println(java.lang.Throwable t)` Adds an Exception to the report, ensuring that the Exception content is processed to generate a valid output esp. for HTML pages.
`void`	`printMessageWithParam(CmsMessageContainer container, java.lang.Object param)` Prints a localized message followed by a parametera and dots to the report.
`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.
`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.

- 字段详细资料
  - FORMAT_DEFAULT
```
static final int FORMAT_DEFAULT
```
    Indicates default formatting.
    
    另请参阅:
    常量字段值
  - FORMAT_ERROR
```
static final int FORMAT_ERROR
```
    Indicates error formatting.
    
    另请参阅:
    常量字段值
  - FORMAT_HEADLINE
```
static final int FORMAT_HEADLINE
```
    Indicates headline formatting.
    
    另请参阅:
    常量字段值
  - FORMAT_NOTE
```
static final int FORMAT_NOTE
```
    Indicates note formatting.
    
    另请参阅:
    常量字段值
  - FORMAT_OK
```
static final int FORMAT_OK
```
    Indicates OK formatting.
    
    另请参阅:
    常量字段值
  - FORMAT_WARNING
```
static final int FORMAT_WARNING
```
    Indicates warning formatting.
    
    另请参阅:
    常量字段值
  - REPORT_TYPE_EXTENDED
```
static final java.lang.String REPORT_TYPE_EXTENDED
```
    Request parameter value that this report should create an "extended" output.
    
    另请参阅:
    常量字段值
  - REPORT_TYPE_SIMPLE
```
static final java.lang.String REPORT_TYPE_SIMPLE
```
    Request parameter value that this report should create a "simple" output.
    
    另请参阅:
    常量字段值
- 方法详细资料
  - addError
```
void addError(java.lang.Object obj)
```
    Adds an error object to the list of errors that occurred during the report.
    
    参数:
    obj - the error object
  - addWarning
```
void addWarning(java.lang.Object obj)
```
    Adds a warning object to the list of warnings that occurred during the report.
    
    参数:
    obj - the error object
  - formatRuntime
```
java.lang.String formatRuntime()
```
    Formats the runtime formatted as "hh:mm:ss".
    
    返回:
    the runtime formatted as "hh:mm:ss"
  - getErrors
```
java.util.List<java.lang.Object> getErrors()
```
    Returns a list of all errors that occurred during the report.
    
    返回:
    an error list that occurred during the report
  - getLastEntryTime
```
long getLastEntryTime()
```
    Returns the time of last report entry.
    Will return zero if no entry has been written.
    
    返回:
    time of last report entry
  - getLocale
```
java.util.Locale getLocale()
```
    Returns the locale this report was initialized with.
    
    返回:
    the locale this report was initialized with
  - getReportUpdate
```
java.lang.String getReportUpdate()
```
    Updates this report, this processes all new output added since the last call to this method.
    This is only required in case the output is written to a HTML page, if the shell output is used, this will just return an empty String.
    
    返回:
    new elements that have been added to the report and not yet processed.
  - getRuntime
```
long getRuntime()
```
    Returns the time this report has been running.
    
    返回:
    the time this report has been running
  - getSiteRoot
```
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.
    
    返回:
    the original site root of the user who started this report
  - getWarnings
```
java.util.List<java.lang.Object> getWarnings()
```
    Returns a list of all warnings that occurred during the report.
    
    返回:
    a warning list that occurred during the report
  - hasError
```
boolean hasError()
```
    Returns if the report generated an error output.
    
    返回:
    true if the report generated an error, otherwise false
  - hasWarning
```
boolean hasWarning()
```
    Returns if the report generated a warning output.
    
    返回:
    true if the report generated a warning, otherwise false
  - print
```
void print(CmsMessageContainer container)
```
    Prints a localized message to the report.
    
    参数:
    container - the String to add
  - print
```
void print(CmsMessageContainer container,
         int format)
```
    Prints a localized message to the report, using the indicated formatting.
    Use the contants starting with FORMAT from this interface to indicate which formatting to use.
    
    参数:
    container - the String to add
    format - the formatting to use for the output
  - println
```
void println()
```
    Adds a line break to the report.
  - println
```
void println(CmsMessageContainer container)
```
    Prints a localized message to the report.
    
    参数:
    container - the message container to add
  - println
```
void println(CmsMessageContainer container,
           int format)
```
    Prints a localized message to the report, using the indicated formatting.
    Use the contants starting with FORMAT from this interface to indicate which formatting to use.
    
    参数:
    container - the message container to add
    format - the formatting to use for the output
  - println
```
void println(java.lang.Throwable t)
```
    Adds an Exception to the report, ensuring that the Exception content is processed to generate a valid output esp. for HTML pages.
    The exception will be stored and the output will later be processed in a special way.
    
    参数:
    t - the exception to add
  - printMessageWithParam
```
void printMessageWithParam(CmsMessageContainer container,
                         java.lang.Object param)
```
    Prints a localized message followed by a parametera and dots to the report.
    
    参数:
    container - the Message to add
    param - the Parameter to add
  - printMessageWithParam
```
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.
    The output follows the pattern: ( 3 / 8 ) Deleting filename.txt ...
    
    参数:
    m - the number of the report output
    n - the total number of report outputs
    container - the Message to add
    param - the Parameter to add
  - removeSiteRoot
```
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.
    If the site root for this report has not been set, or the resource name does not start with the report site root, the name it is left untouched.
    
    参数:
    resourcename - the resource name (full path)
    
    返回:
    the resource name adjusted for the report site root
    另请参阅:
    CmsRequestContext.removeSiteRoot(String)
  - resetRuntime
```
void resetRuntime()
```
    Resets the runtime to 0 milliseconds.

接口 I_CmsReport

字段概要

方法概要

字段详细资料

FORMAT_DEFAULT

FORMAT_ERROR

FORMAT_HEADLINE

FORMAT_NOTE

FORMAT_OK

FORMAT_WARNING

REPORT_TYPE_EXTENDED

REPORT_TYPE_SIMPLE

方法详细资料

addError

addWarning

formatRuntime

getErrors

getLastEntryTime

getLocale

getReportUpdate

getRuntime

getSiteRoot

getWarnings

hasError

hasWarning

print

print

println

println

println

println

printMessageWithParam

printMessageWithParam

removeSiteRoot

resetRuntime