Package org.codice.ddf.admin.configurator

Interface OperationReport

public interface OperationReport
Summary report for a Configurator.commit(String, String...).

This code is experimental. While this class is functional and tested, it may change or be removed in a future version of the library.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsFailedResults()
    Returns true if any tasks failed, causing failure results.
    List<Result>
    getFailedResults()
    An immutable list of Results that failed.
    Result
    getResult(UUID key)
    Method to retrieve a specific task result from the report.
    boolean
    hasTransactionSucceeded()
    Indicates if the transaction completed successfully with all tasks committing their changes.
    void
    putResult(UUID key, Result result)
    Used internally to populate the report.

  • Method Details

    • hasTransactionSucceeded

      boolean hasTransactionSucceeded()
      Indicates if the transaction completed successfully with all tasks committing their changes.
      Returns:
      true if the transaction completed; else, false

    • getResult

      Result getResult(UUID key)
      Method to retrieve a specific task result from the report.
      Parameters:
      key - the UUID key returned from an initial setup call for a Configurator task
      Returns:
      the result of the task

    • getFailedResults

      List<Result> getFailedResults()
      An immutable list of Results that failed.
      Returns:
      an immutable list of failed results. It is an implementor's responsibility to ensure that the collection is unmodifiable.

    • containsFailedResults

      boolean containsFailedResults()
      Returns true if any tasks failed, causing failure results.
      Returns:
      true if any failures present; else, false

    • putResult

      void putResult(UUID key, Result result)
      Used internally to populate the report. Clients should not call this method directly.
      Parameters:
      key - the unique key of an operation
      result - the result of the operation