Package com.inductiveautomation.historian.gateway.api.query

Interface AnnotationPublisher

All Superinterfaces:

ResultPublisher<QualifiedPath>

All Known Implementing Classes:

DefaultAnnotationPublisher

public interface AnnotationPublisher
extends ResultPublisher<QualifiedPath>

The AnnotationPublisher is used to publish annotations.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.historian.gateway.api.query.ResultPublisher

ResultPublisher.PublisherState

Method Summary

Modifier and Type	Method	Description
void	publish(Annotation annotation)	Publishes an annotation.

Methods inherited from interface com.inductiveautomation.historian.gateway.api.query.ResultPublisher

cancel, finish, finishWithError, getIdentifier, getState, initializeWithFailure

Method Details

publish

void publish(Annotation annotation)
      throws IllegalStateException

Publishes an annotation.

Parameters:

annotation - The annotation to publish.

Throws:

IllegalStateException - if the publisher is not in PUBLISHING state