Interface IVennsetQueryableItem

The system entity for a VennSet Queryable Item, which belongs to a IVennSet

See https://web.lemonedge.com/help/venn-set-queryable-items-view/ for more information

Inherited Members
System.IEquatable<LemonEdge.API.Core.IBaseEntity>.Equals(LemonEdge.API.Core.IBaseEntity)
System.ComponentModel.INotifyPropertyChanged.PropertyChanged
System.ComponentModel.INotifyPropertyChanging.PropertyChanging
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.VennSetQueryableItem, "dbo.LT_VennSetQueryableItems", "VennSetQueryableItem", LabelColumn = "Name")]
[DefaultEntityIcon(ImageType.Venn)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.SQLWrapper, "OwnerEntityID", "ID", ExcludeFromRelationship = true)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.Transaction, "ParentItemID", "ID", ExcludeFromRelationship = true)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.DataSourceIDs, "EntityID", "ID", ExcludeFromRelationship = true)]
public interface IVennsetQueryableItem : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

Distinct

Indicates all rows returned must be distinct removing any duplicate values

Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates if only distinct row results should be returned in this queryable item.")]
bool Distinct { get; set; }
Property Value
Type Description
System.Boolean

Name

[Key] This is the user friendly name of the queryable item as it will appear in the list.

This makes looking at the data structure very easy at a glance.It is also the name the user will see if they are able to open a row of data from this item type

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The name of this queryable item.")]
[Required]
string Name { get; set; }
Property Value
Type Description
System.String

QueryableItemID

The item of the specified type that you want to query

A queryable item inherits IQueryableItem

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The id of this queryable item.")]
string QueryableItemID { get; set; }
Property Value
Type Description
System.String

QueryableItemSubID

The sub id of this queryable item.

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, true)]
[EntityDescription("The sub id of this queryable item.")]
string QueryableItemSubID { get; set; }
Property Value
Type Description
System.String

QueryableItemTypeName

The type of item you want to query. This can be an Entity, History, or Query.

Declaration
[EntityProperty(SQLType.NVarChar, (short)50, false)]
[EntityDescription("The type of queryable item.")]
[Required]
string QueryableItemTypeName { get; set; }
Property Value
Type Description
System.String

ReplicateForAll

If the queryable item type is a type that has sub Queryable Item Options, such as permissions, then this indicates you want to replicate your query for every option and union the results together.

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this queryable item should be replicated for each possible type in the function.")]
bool ReplicateForAll { get; set; }
Property Value
Type Description
System.Boolean

Sequence

Holds the order of this queryable item in the set.

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Holds the order of this queryable item in the set.")]
[EntitySequence]
short Sequence { get; set; }
Property Value
Type Description
System.Int16

SetType

Specifies the operator to apply when combining the data from this set with the data from the prior set

Declaration
[EntityProperty(SQLType.SmallInt, true)]
[EntityDescription("The type of set operator to use when combining this queryable item to the one prior to it.")]
SetOperator? SetType { get; set; }
Property Value
Type Description
System.Nullable<SetOperator>

Skip

Indicates the queryable item should skip the specified number of rows (requires an order in the Columns) before returning the remaining amount

Declaration
[EntityProperty(SQLType.Int, true)]
[EntityDescription("Indicates if the specified number of rows should be skipped before returning the rows in this queryable item.")]
int? Skip { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Top

Indicates the queryable item should always only return the following number of rows

Declaration
[EntityProperty(SQLType.Int, true)]
[EntityDescription("Indicates if just the top specified number of rows should be returned in this queryable item.")]
int? Top { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

VennSetID

Links to IVennSet. The parent vennset this queryable item belongs to

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.VennSet, "ID", SingleJoinType.One, "Parent Venn Set", "Queryable Items", DeleteWithRelationship = true, PartOfParentSet = true, InheritPermissions = true)]
Guid VennSetID { get; set; }
Property Value
Type Description
System.Guid

Extension Methods

See Also