Package org.sensorhub.api.command

Interface ICommandResult

All Known Implementing Classes:
CommandResult
public interface ICommandResult

Interface for command results

Several ways it can work:

  1. Process creates a dedicated datastream, ingests obs in it, then provides the datastream ID in the command result
  2. Process uses a persistent output datastream, ingests obs in it, then provides only obs IDs (can publish to several different datastreams) in the command result
  3. Process provides a list of datablock inline. In this case, the result is not stored in a separate datastream and is only accessible via the command channel. This is typically used for on-demand processes where only the user who called the process (i.e. sent the command) is interested by the result)

Since:
Sep 10, 2022

  • Method Details

    • getObservations

      Collection<IObsData> getObservations()
      Returns:
      inline result data, as a list of observations matching the result schema defined by ICommandStreamInfo

    • getObservationRefs

      Collection<BigId> getObservationRefs()
      Returns:
      reference to observations (when not provided inline) generated during the execution of the command and added to one or more existing datastream(s).

    • getDataStreamID

      BigId getDataStreamID()
      Returns:
      reference to an entire datastream that contains one or more observations (but usually many) generated during the execution of the command.