Package energy.eddie.dataneeds.needs.aiida

Interface AiidaDataNeedInterface

All Known Implementing Classes:
AiidaDataNeed, AiidaLocalDataNeed, InboundAiidaDataNeed, InboundAiidaLocalDataNeed, OutboundAiidaDataNeed, OutboundAiidaLocalDataNeed
public interface AiidaDataNeedInterface

  • Method Details

    • asset

      AiidaAsset asset()
      Returns the kind of asset the data is retrieved from
      See Also:

    • dataNeedId

      UUID dataNeedId()
      Returns the data need ID

    • dataTags

      Set<ObisCode> dataTags()
      Returns the set of identifiers for the data that should be shared.

    • schemas

      Set<AiidaSchema> schemas()
      Returns the schema for the data
      See Also:

    • transmissionSchedule

      org.springframework.scheduling.support.CronExpression transmissionSchedule()
      Returns the schedule in cron format, at which data should be sent.

    • allowedPermissionCommands

      Set<PermissionCommand.Action> allowedPermissionCommands()
      Returns the permission commands the eligible party is explicitly granted to send for this data need. A command whose action requires an explicit grant (e.g. SET_TRANSMISSION_ENABLED, UPDATE_TRANSMISSION_SCHEDULE) is accepted only if its action is contained in this set; otherwise it is rejected. TERMINATE is always accepted, regardless of this set.

    • acknowledgementRequired

      boolean acknowledgementRequired()
      Returns whether the receiving party should acknowledge the reception of the data. If true, the receiving party is expected to send an acknowledgment envelope back to the sender after receiving the data. If false, no acknowledgment is expected.

    • type

      String type()
      Returns the type of the Data Need