Package org.opencms.workplace.tools.content.check

Class CmsContentCheckResult

  • public class CmsContentCheckResult
extends java.lang.Object
    This class holds the results of the content tests and provides methods to access the collected errors and warnings.

    Since:
    6.1.2

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsContentCheckResult()
      Constructor, creates an empty CmsContentCheckResult.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addResult​(CmsContentCheckResource testResource)
      Adds the testing results of a CmsContentCheckResource to the result lists.
      java.util.List getAllCheckResources()
      Gets a list of all CmsContentCheckResource that colleced an error or a warning during the content check.
      java.util.List getAllResources()
      Gets a list of all resources that colleced an error or a warning during the content check.
      java.util.List getErrorCheckResources()
      Gets a list of all CmsContentCheckResource that colleced an error during the content check.
      java.util.List getErrorResources()
      Gets a list of all resources that colleced an error during the content check.
      java.util.Map getErrors()
      Gets a map of all error collected during the content check.
      java.util.List getErrors​(java.lang.String resourceName)
      Gets a list of errors collected during the content check for a given resource.
      java.util.List getWarningCheckResources()
      Gets a list of all CmsContentCheckResource that colleced a warning during the content check.
      java.util.List getWarningResources()
      Gets a list of all resources that colleced a warning during the content check.
      java.util.Map getWarnings()
      Gets a map of all warnings collected during the content check.
      java.util.List getWarnings​(java.lang.String resourceName)
      Gets a list of warnings collected during the content check for a given resource.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CmsContentCheckResult

        public CmsContentCheckResult()
        Constructor, creates an empty CmsContentCheckResult.

    • Method Detail

      • addResult

        public void addResult​(CmsContentCheckResource testResource)
        Adds the testing results of a CmsContentCheckResource to the result lists.

        Parameters:
        testResource - the CmsContentCheckResource to add the results from

      • getAllCheckResources

        public java.util.List getAllCheckResources()
        Gets a list of all CmsContentCheckResource that colleced an error or a warning during the content check.

        Returns:
        List of CmsContentCheckResource which collected an error or a warning.

      • getAllResources

        public java.util.List getAllResources()
        Gets a list of all resources that colleced an error or a warning during the content check.

        Returns:
        List of CmsResources which collected an error or a warning.

      • getErrorCheckResources

        public java.util.List getErrorCheckResources()
        Gets a list of all CmsContentCheckResource that colleced an error during the content check.

        Returns:
        List of CmsContentCheckResource which collected an error.

      • getErrorResources

        public java.util.List getErrorResources()
        Gets a list of all resources that colleced an error during the content check.

        Returns:
        List of CmsResources which collected an error.

      • getErrors

        public java.util.Map getErrors()
        Gets a map of all error collected during the content check.

        The map contains the complete resource root path as keys and a list of errors as values.

        Returns:
        map of collected warnings

      • getErrors

        public java.util.List getErrors​(java.lang.String resourceName)
        Gets a list of errors collected during the content check for a given resource.

        Parameters:
        resourceName - the complete root path of the resource to get the list from
        Returns:
        list of error messages or null if no warnings are found

      • getWarningCheckResources

        public java.util.List getWarningCheckResources()
        Gets a list of all CmsContentCheckResource that colleced a warning during the content check.

        Returns:
        List of CmsContentCheckResource which collected a warning.

      • getWarningResources

        public java.util.List getWarningResources()
        Gets a list of all resources that colleced a warning during the content check.

        Returns:
        List of CmsResources which collected a warning.

      • getWarnings

        public java.util.Map getWarnings()
        Gets a map of all warnings collected during the content check.

        The map contains the complete resource root path as keys and a list of warnings as values.

        Returns:
        map of collected warnings

      • getWarnings

        public java.util.List getWarnings​(java.lang.String resourceName)
        Gets a list of warnings collected during the content check for a given resource.

        Parameters:
        resourceName - the complete root path of the resource to get the list from
        Returns:
        list of warning messages or null if no warnings are found