Package energy.eddie.dataneeds.needs.aiida

Class AiidaDataNeed

java.lang.Object

energy.eddie.dataneeds.needs.DataNeed

energy.eddie.dataneeds.needs.TimeframedDataNeed

energy.eddie.dataneeds.needs.aiida.AiidaDataNeed

All Implemented Interfaces:

AiidaDataNeedInterface

Direct Known Subclasses:

InboundAiidaDataNeed, OutboundAiidaDataNeed

@Entity
public abstract class AiidaDataNeed
extends TimeframedDataNeed
implements AiidaDataNeedInterface

Constructor Summary

Constructors

Constructor	Description
AiidaDataNeed()

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.
AiidaAsset	asset()	Returns the kind of asset the data is 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
abstract Set<AiidaSchema>	supportedSchemas()
org.springframework.scheduling.support.CronExpression	transmissionSchedule()	Returns the schedule in cron format, at which data should be sent.

Methods inherited from class energy.eddie.dataneeds.needs.TimeframedDataNeed

duration

Methods inherited from class energy.eddie.dataneeds.needs.DataNeed

createdAt, description, id, isEnabled, name, policyLink, purpose, regionConnectorFilter, setId, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface energy.eddie.dataneeds.needs.aiida.AiidaDataNeedInterface

supportsLimitDefaults, type

Constructor Details

AiidaDataNeed

public AiidaDataNeed()

Method Details

acknowledgementRequired

public boolean acknowledgementRequired()

Description copied from interface: AiidaDataNeedInterface

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.

Specified by:

acknowledgementRequired in interface AiidaDataNeedInterface

allowedPermissionCommands

public Set<PermissionCommand.Action> allowedPermissionCommands()

Description copied from interface: AiidaDataNeedInterface

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.

Specified by:

allowedPermissionCommands in interface AiidaDataNeedInterface

asset

public AiidaAsset asset()

Description copied from interface: AiidaDataNeedInterface

Returns the kind of asset the data is retrieved from

Specified by:

asset in interface AiidaDataNeedInterface

See Also:

• AiidaAsset

contexts

public Set<AiidaContext> contexts()

Description copied from interface: AiidaDataNeedInterface

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.

Specified by:

contexts in interface AiidaDataNeedInterface

dataNeedId

public UUID dataNeedId()

Description copied from interface: AiidaDataNeedInterface

Returns the data need ID

Specified by:

dataNeedId in interface AiidaDataNeedInterface

schemas

public Set<AiidaSchema> schemas()

Description copied from interface: AiidaDataNeedInterface

Returns the schema for the data

Specified by:

schemas in interface AiidaDataNeedInterface

See Also:

• AiidaSchema

transmissionSchedule

public org.springframework.scheduling.support.CronExpression transmissionSchedule()

Description copied from interface: AiidaDataNeedInterface

Returns the schedule in cron format, at which data should be sent.

Specified by:

transmissionSchedule in interface AiidaDataNeedInterface

supportedSchemas

public abstract Set<AiidaSchema> supportedSchemas()