Package com.inductiveautomation.historian.common.rpc

Interface HistorianRpcFunctions

All Known Implementing Classes:
GatewayRpcFunctions
public interface HistorianRpcFunctions
Defines the RPC (Remote Procedure Call) functions for the Historian module.

This interface provides methods for browsing, querying, and storing data points, annotations, and metadata, as well as applying changes to annotations and historical sources. It is annotated with RpcInterface to indicate its use in remote communication.

  • Method Details

    • browse

      Results<Result> browse(QualifiedPath path, BrowseFilter filter)
      Browses the specified path using the provided filter.
      Parameters:
      path - The QualifiedPath to browse.
      filter - The BrowseFilter to apply during browsing.
      Returns:
      A Results object containing the browse results.

    • queryDataPoints

      void queryDataPoints(DataPointQueryOptions<?> queryOptions, ResultWriterOptions writerOptions)
      Queries data points based on the provided query options and writes the results using the specified writer options.
      Parameters:
      queryOptions - The DataPointQueryOptions specifying the query parameters.
      writerOptions - The ResultWriterOptions specifying how to write the results.

    • queryAnnotations

      Results<AnnotationPoint> queryAnnotations(AnnotationQueryOptions queryOptions)
      Queries annotations based on the provided query options.
      Parameters:
      queryOptions - The AnnotationQueryOptions specifying the query parameters.
      Returns:
      A Results object containing the queried annotations.

    • queryMetadata

      Results<MetadataPoint> queryMetadata(MetadataQueryOptions queryOptions)
      Queries metadata points based on the provided query options.
      Parameters:
      queryOptions - The MetadataQueryOptions specifying the query parameters.
      Returns:
      A Results object containing the queried metadata points.

    • storeDataPoints

      QualityCode storeDataPoints(List<AtomicPoint<?>> dataPoints, boolean blockForResult)
      Stores the provided list of data points.
      Parameters:
      dataPoints - A List of AtomicPoint objects to store.
      blockForResult - A flag indicating whether the result should be obtained after confirmation that storage has been attempted.
      Returns:
      A QualityCode indicating the result of the operation.

    • storeAnnotations

      QualityCode storeAnnotations(List<AnnotationPoint> annotations, boolean blockForResult)
      Stores the provided list of annotations.
      Parameters:
      annotations - A List of AnnotationPoint objects to store.
      blockForResult - A flag indicating whether the result should be obtained after confirmation that storage has been attempted.
      Returns:
      A QualityCode indicating the result of the operation.

    • storeMetadata

      QualityCode storeMetadata(List<MetadataPoint> metadata, boolean blockForResult)
      Stores the provided list of metadata points.
      Parameters:
      metadata - A List of MetadataPoint objects to store.
      blockForResult - A flag indicating whether the result should be obtained after confirmation that storage has been attempted.
      Returns:
      A QualityCode indicating the result of the operation.

    • applyAnnotationChanges

      QualityCode applyAnnotationChanges(List<AnnotationChangePoint> changes, boolean blockForResult)
      Applies the provided list of annotation changes.
      Parameters:
      changes - A List of AnnotationChangePoint objects representing the changes to apply.
      blockForResult - A flag indicating whether the result should be obtained after confirmation that the changes have been applied.
      Returns:
      A QualityCode indicating the result of the operation.

    • applyHistoricalSourceChanges

      QualityCode applyHistoricalSourceChanges(List<SourceChangePoint> changes, boolean blockForResult)
      Applies the provided list of historical source changes.
      Parameters:
      changes - A List of SourceChangePoint objects representing the changes to apply.
      blockForResult - A flag indicating whether the result should be obtained after confirmation that the changes have been applied.
      Returns:
      A QualityCode indicating the result of the operation.