Package energy.eddie.dataneeds.needs.aiida

Interface AiidaDataNeedInterface

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    acknowledgementRequired()
    Returns whether the receiving party should acknowledge the reception of the data.
    Set<PermissionCommand.Action>
    allowedPermissionCommands()
    Returns the permission commands the eligible party is explicitly granted to send for this data need.
    Set<AiidaAsset>
    assets()
    Returns the kinds of asset the data may be retrieved from.
    Set<AiidaContext>
    contexts()
    Returns information about the usage context of permissions created from the data need that AIIDA can use to provide additional functionality specific to that context.
    UUID
    dataNeedId()
    Returns the data need ID
    Set<AiidaSchema>
    schemas()
    Returns the schema for the data
    default boolean
    supportsConnectionLimits()
    Returns true if the data need accepts connection limits
    org.springframework.scheduling.support.CronExpression
    transmissionSchedule()
    Returns the schedule in cron format, at which data should be sent.
    String
    type()
    Returns the type of the Data Need

  • Method Details

    • 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.

    • 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.

    • assets

      Set<AiidaAsset> assets()
      Returns the kinds of asset the data may be retrieved from. An empty set allows any asset.
      See Also:

    • contexts

      Set<AiidaContext> contexts()
      Returns information about the usage context of permissions created from the data need that AIIDA can use to provide additional functionality specific to that context.

    • dataNeedId

      UUID dataNeedId()
      Returns the data need ID

    • 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.

    • type

      String type()
      Returns the type of the Data Need

    • supportsConnectionLimits

      default boolean supportsConnectionLimits()
      Returns true if the data need accepts connection limits