Interface IInstrumentSetBase
Any LemonEdge entity interface that inherits this, means it is acquires all the functionality of an InstrumentSet
See https://web.lemonedge.com/help/instrument-sets/ for more info
Inherited Members
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
public interface IInstrumentSetBase : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
Description
A user friendly description of this set.
Declaration
[EntityProperty(SQLType.NVarChar, (short)2000, true)]
[EntityDescription("A user friendly description of this set.")]
string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EntitySetID
Links to IEntitySet. Indicates only instruments that belong to entities within this specified entity set will match.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.EntitySet, "ID", SingleJoinType.ZeroToOne, "Entity Set", "InstrumentSetTypeID Sets", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("Indicates only instruments that belong to entities within this specified entity set will match.")]
Guid? EntitySetID { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
InstrumentSetTypeID
Links to IInstrumentSetType. This is used for grouping Instrument Sets in custom ways to make using them easier for Users.
Part of the key for this Instrument Set
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.InstrumentSetType, "ID", SingleJoinType.One, "IInstrumentSetType", "Instrument Set", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("This is used for grouping Instrument Sets in custom ways to make using them easier for Users.")]
Guid InstrumentSetTypeID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
LoadAllInstruments
Indicates this set should include all Instruments in the Entity Set then exclude the specified items.
If false then it only includes the specified items.
Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this set should include all Instruments in the Entity Set then exclude the specified items. If false then it only includes the specified items.")]
bool LoadAllInstruments { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Name
A unique friendly identifiable name for the Instrument Set.
Part of the key for this Instrument Set
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("A unique friendly identifiable name for the Instrument Set.")]
[Required]
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |