Package energy.eddie.aiida.models.permission.dataneed

Class AiidaLocalDataNeed

java.lang.Object

energy.eddie.aiida.models.permission.dataneed.AiidaLocalDataNeed

All Implemented Interfaces:

AiidaDataNeedInterface

Direct Known Subclasses:

InboundAiidaLocalDataNeed, OutboundAiidaLocalDataNeed

@Entity
public abstract class AiidaLocalDataNeed
extends Object
implements AiidaDataNeedInterface

Stores the locally required information about a data need of a permission.

Field Summary

Fields

Modifier and Type	Field	Description
protected AiidaAsset	asset
protected UUID	dataNeedId
protected Set<ObisCode>	dataTags
protected boolean	isAcknowledgementRequired
protected String	name
protected String	policyLink
protected String	purpose
protected Set<AiidaSchema>	schemas
protected org.springframework.scheduling.support.CronExpression	transmissionSchedule
protected String	type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AiidaLocalDataNeed()	Constructor only for JPA.
protected	AiidaLocalDataNeed(AiidaDataNeed dataNeed)

Method Summary

Modifier and Type	Method	Description
AiidaAsset	asset()	Returns the kind of asset the data is retrieved from
UUID	dataNeedId()	Returns the data need ID
Set<ObisCode>	dataTags()	Returns the set of identifiers for the data that should be shared.
boolean	isAcknowledgementRequired()	Returns whether the receiving party should acknowledge the reception of the data.
String	name()
Set<AiidaSchema>	schemas()	Returns the schema for the data
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

Methods inherited from class java.lang.Object

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

Field Details

dataNeedId

protected UUID dataNeedId

type

protected String type

name

protected String name

purpose

protected String purpose

policyLink

protected String policyLink

transmissionSchedule

protected org.springframework.scheduling.support.CronExpression transmissionSchedule

isAcknowledgementRequired

protected boolean isAcknowledgementRequired

schemas

protected Set<AiidaSchema> schemas

asset

protected AiidaAsset asset

dataTags

protected Set<ObisCode> dataTags

Constructor Details

AiidaLocalDataNeed

protected AiidaLocalDataNeed()

Constructor only for JPA.

AiidaLocalDataNeed

protected AiidaLocalDataNeed(AiidaDataNeed dataNeed)

Method Details

name

public String name()

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

dataNeedId

public UUID dataNeedId()

Description copied from interface: AiidaDataNeedInterface

Returns the data need ID

Specified by:

dataNeedId in interface AiidaDataNeedInterface

dataTags

public Set<ObisCode> dataTags()

Description copied from interface: AiidaDataNeedInterface

Returns the set of identifiers for the data that should be shared.

Specified by:

dataTags 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

isAcknowledgementRequired

public boolean isAcknowledgementRequired()

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:

isAcknowledgementRequired in interface AiidaDataNeedInterface

type

public String type()

Description copied from interface: AiidaDataNeedInterface

Returns the type of the Data Need

Specified by:

type in interface AiidaDataNeedInterface