Package com.inductiveautomation.ignition.gateway.history

Interface ForwardTransaction

public interface ForwardTransaction
Represents a set of historical data that shares the same schema, and thus can likely be stored inside of a transaction in order to increase efficiency.

  • Method Summary

    Modifier and Type
    Method
    Description
    HistoricalData
    getData()
    Gets the value in the transaction.
    int
    markComplete()
    Called when the data has been successfully forwarded to the data store.
    int
    markFailed(Exception err)
    Called when there's a failure.

  • Method Details

    • getData

      HistoricalData getData()
      Gets the value in the transaction. Usually just one value, but can be more in the form of a DataTransaction.

    • markComplete

      int markComplete()
      Called when the data has been successfully forwarded to the data store.
      Returns:
      Amount of items that were successfully forwarded

    • markFailed

      int markFailed(Exception err)
      Called when there's a failure. The failure may be critical or not. After several failures, the data will likely be quarantined.
      Returns:
      Amount of items that failed to forward