Interface IBlendingTranInstrumentValue
The system entity for a blending transaction instrument value, which contains belongs to the configuration of a blending transaction
See https://web.lemonedge.com/help/blending-transaction-values/ for more information
Inherited Members
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.BlendingTranInstrumentValue, "dbo.LT_BlendingTranInstrumentValues", "BlendingTransactionInstrumentValue", LabelColumn = "Name", IsStandingDataEntity = true)]
[DefaultEntityIcon(ImageType.BlendingTransactionTypes)]
public interface IBlendingTranInstrumentValue : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
BlendingTranID
[Key] Links to IBlendingTran. The parent blending transaction this entity belongs to
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.BlendingTran, "ID", SingleJoinType.One, "Blending Transaction", "Blending Instrument Values", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = false, InheritPermissions = true)]
Guid BlendingTranID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Name
[Key] A unique name within this Blending Transaction to indicate the values aggregated and held by this data point. This name can be referenced throughout the algorithm to retrieve the associated value.
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of these blending transaction instrument values.")]
[Required]
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
TransactionAggregatorID
Links to ITransactionAggregator. The Transaction Aggregator to use to determine which values across the set of matching Transactions should be aggregated into a result we can use in the algorithm
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.TransactionAggregator, "ID", SingleJoinType.One, "Transaction Aggregator", "Blending Instrument Values", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("The values of the matching transactions that should be aggregated for this set of instruments.")]
Guid TransactionAggregatorID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
TransactionMatcherID
Links to ITransactionMatcher. The Transaction Matcher to use to filter to just the Transactions on the type of data you want to aggregate
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.TransactionMatcher, "ID", SingleJoinType.One, "Transaction Matcher", "Blending Instrument Values", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("The matching transactions that should have their values aggregated for this set of instruments.")]
Guid TransactionMatcherID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Type
The type of data to run this data aggregation against.
- Source: The Transactions associated with the Source data from Instrument Sets configuration.
- Target: The Transactions associated with the Target data from Instrument Sets configuration.
Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[HardCodedDefaultValueOnNew("0")]
[EntityDescription("The type of values to be aggregated.")]
[Required]
BlendingTranInstrumentValueType Type { get; set; }
Property Value
Type | Description |
---|---|
BlendingTranInstrumentValueType |