Interface Checking


public interface Checking
Checking provides access to information related to checking activities, such as whether checking has been done, and what the results are.
Since:
9.10.6
  • Field Details

  • Method Details

    • getState

      Checking.State getState()
      Returns the state of the checking.
      Returns:
      the state
      Since:
      9.10.6
    • getResults

      Collection<Result> getResults()
      Returns results of the checking. When checking is ongoing, the results returned might be empty.
      Returns:
      results of the checking
      Since:
      9.10.6
    • getResults

      Collection<Result> getResults(Rule rule)
      Returns results of the checking for a given Rule. When checking is ongoing, the results returned might be empty.
      Parameters:
      rule - the rule for which to get results
      Returns:
      results of the checking for a given rule
      Since:
      9.12.0
    • runChecking

      Collection<Result> runChecking(boolean checkSelected) throws ProjectNotOpenException, CheckingInterruptedException
      Runs checking and returns the checking results.
      Parameters:
      checkSelected - Runs checking in selected mode if true else runs normal checking
      Returns:
      Collection of checking results
      Throws:
      ProjectNotOpenException - Project not opened exception
      CheckingInterruptedException - Interruption during checking
      Since:
      9.12.7