Hydrologic Formation Entitlement Right in ESG data model

The hydrologic formation entitlement right granted to a party during a period of time.

Traits

This entity has the following traits:

is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeHydrologicFormationEntitlementRight/(resolvedAttributes)/PeriodStartTimestampattribute

minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.

ParameterValueData typeExplanation
versionNumber"1.2.3"string

is.IDM.modelVersion
Semantic version number of the IDM.

ParameterValueData typeExplanation
versionNumber"1.4.0"string

is.nativeTo.businessArea
The name of the business area from which the entity originates.

ParameterValueData typeExplanation
name"Hydro Power Generation"string

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHydrologic Formation Entitlement Right
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe hydrologic formation entitlement right granted to a party during a period of time.
entitya reference to the constant entity holding the list of localized text

has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or re-states parts of logical schemas to produce one resolved schema.

ParameterValueData typeExplanation
level"resolved"stringPossible values: logical, composition, resolved

Attributes

Name Description First Included in Instance
HydrologicFormationId The unique identifier of a Hydrologic Formation. HydrologicFormationEntitlementRight
PartyId The unique identifier of a Party. HydrologicFormationEntitlementRight
HydrologicFormationEntitlementRightTypeId The unique identifier of a Hydrologic Formation Entitlement Right Type. HydrologicFormationEntitlementRight
PeriodStartTimestamp The period start timestamp for which a associated Hydrologic Formation Entitlement Right effective. HydrologicFormationEntitlementRight
PeriodEndTimestamp The period end timestamp for which a associated Hydrologic Formation Entitlement Right effective. HydrologicFormationEntitlementRight
WaterQuantity The quantity of water that the party is entitled to during the given period. HydrologicFormationEntitlementRight
WaterQuantityUnitOfMeasureId The unique identifier of a Unit Of Measure. HydrologicFormationEntitlementRight
HydrologicFormationEntitlementRightNote A note, comment or additional information regarding a Hydrologic Formation Entitlement Right. HydrologicFormationEntitlementRight

HydrologicFormationId

The unique identifier of a Hydrologic Formation.
First included in: HydrologicFormationEntitlementRight (this entity)

Properties

NameValue
displayNameHydrologic Formation ID
descriptionThe unique identifier of a Hydrologic Formation.
isPrimaryKeytrue
dataFormatint64

Traits

The HydrologicFormationId attribute has the following traits:

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeHydrologicFormationEntitlementRight/(resolvedAttributes)/HydrologicFormationIdattribute

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
HydrologicFormation.cdm.json/HydrologicFormationHydrologicFormationId
entitya reference to the constant entity holding the list of entity references

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHydrologic Formation ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Hydrologic Formation.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

PartyId

The unique identifier of a Party.
First included in: HydrologicFormationEntitlementRight (this entity)

Properties

NameValue
displayNameParty ID
descriptionThe unique identifier of a Party.
isPrimaryKeytrue
dataFormatint64

Traits

The PartyId attribute has the following traits:

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeHydrologicFormationEntitlementRight/(resolvedAttributes)/PartyIdattribute

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
Party.cdm.json/PartyPartyId
entitya reference to the constant entity holding the list of entity references

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enParty ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Party.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

HydrologicFormationEntitlementRightTypeId

The unique identifier of a Hydrologic Formation Entitlement Right Type.
First included in: HydrologicFormationEntitlementRight (this entity)

Properties

NameValue
displayNameHydrologic Formation Entitlement Right Type ID
descriptionThe unique identifier of a Hydrologic Formation Entitlement Right Type.
isPrimaryKeytrue
dataFormatint32

Traits

The HydrologicFormationEntitlementRightTypeId attribute has the following traits:

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeHydrologicFormationEntitlementRight/(resolvedAttributes)/HydrologicFormationEntitlementRightTypeIdattribute

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
HydrologicFormationEntitlementRightType.cdm.json/HydrologicFormationEntitlementRightTypeHydrologicFormationEntitlementRightTypeId
entitya reference to the constant entity holding the list of entity references

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHydrologic Formation Entitlement Right Type ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Hydrologic Formation Entitlement Right Type.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

PeriodStartTimestamp

The period start timestamp for which a associated Hydrologic Formation Entitlement Right effective.
First included in: HydrologicFormationEntitlementRight (this entity)

Properties

NameValue
displayNamePeriod Start Timestamp
descriptionThe period start timestamp for which a associated Hydrologic Formation Entitlement Right effective.
isPrimaryKeytrue
dataFormatdateTime

Traits

The PeriodStartTimestamp attribute has the following traits:

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeHydrologicFormationEntitlementRight/(resolvedAttributes)/PeriodStartTimestampattribute

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPeriod Start Timestamp
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe period start timestamp for which a associated Hydrologic Formation Entitlement Right effective.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

PeriodEndTimestamp

The period end timestamp for which a associated Hydrologic Formation Entitlement Right effective.
First included in: HydrologicFormationEntitlementRight (this entity)

Properties

NameValue
displayNamePeriod End Timestamp
descriptionThe period end timestamp for which a associated Hydrologic Formation Entitlement Right effective.
dataFormatdateTime
isNullabletrue

Traits

The PeriodEndTimestamp attribute has the following traits:

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPeriod End Timestamp
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe period end timestamp for which a associated Hydrologic Formation Entitlement Right effective.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

WaterQuantity

The quantity of water that the party is entitled to during the given period.
First included in: HydrologicFormationEntitlementRight (this entity)

Properties

NameValue
displayNameWater Quantity
descriptionThe quantity of water that the party is entitled to during the given period.
dataFormatdecimal
isNullabletrue

Traits

The WaterQuantity attribute has the following traits:

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"2"integerthe number of digits to the right of the decimal place

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWater Quantity
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe quantity of water that the party is entitled to during the given period.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

WaterQuantityUnitOfMeasureId

The unique identifier of a Unit Of Measure.
First included in: HydrologicFormationEntitlementRight (this entity)

Properties

NameValue
displayNameWater Quantity Unit Of Measure ID
descriptionThe unique identifier of a Unit Of Measure.
dataFormatint32
isNullabletrue

Traits

The WaterQuantityUnitOfMeasureId attribute has the following traits:

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWater Quantity Unit Of Measure ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Unit Of Measure.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
UnitOfMeasure.cdm.json/UnitOfMeasureUnitOfMeasureId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.integer

HydrologicFormationEntitlementRightNote

A note, comment or additional information regarding a Hydrologic Formation Entitlement Right.
First included in: HydrologicFormationEntitlementRight (this entity)

Properties

NameValue
displayNameHydrologic Formation Entitlement Right Note
descriptionA note, comment or additional information regarding a Hydrologic Formation Entitlement Right.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

The HydrologicFormationEntitlementRightNote attribute has the following traits:

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHydrologic Formation Entitlement Right Note
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA note, comment or additional information regarding a Hydrologic Formation Entitlement Right.
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"2048"integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object