Class DatasetQueryableItem
Inheritance
DatasetQueryableItem
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class DatasetQueryableItem : BaseEntity, IDatasetQueryableItem, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IDatasetQueryableItem>, ISetCopierCustomChildren, ISetCopierCloneAlterer
Constructors
DatasetQueryableItem()
Declaration
public DatasetQueryableItem()
Properties
Color
Declaration
[NotMapped]
public Color Color { get; set; }
Property Value
CopierCloneType
Declaration
public SetCopierCloneType CopierCloneType { get; set; }
Property Value
DatasetID
Links to IDataset. The parent dataset this queryable item belongs to
Declaration
[RequiredNoDefaultIDValidation]
public Guid DatasetID { get; set; }
Property Value
DatasetID_Label
Declaration
public string DatasetID_Label { get; set; }
Property Value
DatasetID_Label_Silent
Declaration
[NotMapped]
public string DatasetID_Label_Silent { get; set; }
Property Value
Distinct
Indicates all rows returned must be distinct removing any duplicate values
Declaration
public bool Distinct { get; set; }
Property Value
IsWith
Not used yet: Indicates this queryable item should generate a with statement that can be used by the next queryable item set
Declaration
public bool IsWith { get; set; }
Property Value
JoinType
If this Queryable Item is a child of any other Queryable Item, then this specifies the type of join this queryable
item will have to the overall dataset:
- Exclusive: Equivalent to Inner Join in SQL.
- Inclusive: Equivalent to Outer Join in SQL
- CrossJoin: Equivalent to Cross Join in SQL
Declaration
[EnumDataType(typeof(DatasetRelationshipJoinType))]
public DatasetRelationshipJoinType? JoinType { get; set; }
Property Value
Declaration
[NotMapped]
public string JoinType_Tooltip { get; set; }
Property Value
Name
[Key] This is the user friendly name of the queryable item as it will appear in the treeview.
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
[Required]
[StringLength(500)]
public string Name { get; set; }
Property Value
ParentID
The Queryable Item this entity is a child of (if it is not the root queryable item)
Declaration
public Guid? ParentID { get; set; }
Property Value
ParentID_Label
Declaration
public string ParentID_Label { get; set; }
Property Value
ParentID_Label_Silent
Declaration
[NotMapped]
public string ParentID_Label_Silent { get; set; }
Property Value
QueryableItemID
The item of the specified type that you want to query
A queryable item inherits IQueryableItem
Declaration
[StringLength(500)]
public string QueryableItemID { get; set; }
Property Value
QueryableItemSubID
The sub id of this queryable item.
Declaration
[StringLength(500)]
public string QueryableItemSubID { get; set; }
Property Value
QueryableItemTypeName
The type of item you want to query. This can be an Entity, History, or Query.
Declaration
[Required]
[StringLength(50)]
public string QueryableItemTypeName { get; set; }
Property Value
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
public bool ReplicateForAll { get; set; }
Property Value
Sequence
Holds the order of this queryable item in the set.
Declaration
public short Sequence { get; set; }
Property Value
SetType
Specifies the operator to apply when combining the data from this set with the data from the prior set
Declaration
[EnumDataType(typeof(SetOperator))]
public SetOperator? SetType { get; set; }
Property Value
Declaration
[NotMapped]
public string SetType_Tooltip { get; set; }
Property Value
Skip
Indicates the queryable item should skip the specified number of rows (requires an order in the Columns) before
returning the remaining amount
Declaration
public int? Skip { get; set; }
Property Value
Top
Indicates the queryable item should always only return the following number of rows
Declaration
public int? Top { get; set; }
Property Value
Methods
AlterCopiedItem(IEntityUpdater, UserInfo, IReadOnlyCache, IBaseEntity)
A custom ability to alter this item when it is was copied by the user in the UI, not when it is being imported
Declaration
public Task AlterCopiedItem(IEntityUpdater host, UserInfo user, IReadOnlyCache cache, IBaseEntity sourceItem)
Parameters
Returns
| Type |
Description |
| Task |
A task inidicating the finishing of this method
|
CopyFromEntity(IBaseEntity)
Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Overrides
CopyFromSource(IDatasetQueryableItem)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(IDatasetQueryableItem source)
Parameters
GetCustomChildItem(IEntityRetriever, string)
Declaration
public Task<IBaseEntity> GetCustomChildItem(IEntityRetriever context, string propertyName)
Parameters
Returns
GetCustomChildPropertyNames()
Declaration
public IEnumerable<string> GetCustomChildPropertyNames()
Returns
HasCustomChild(string)
Declaration
public bool HasCustomChild(string propertyName)
Parameters
| Type |
Name |
Description |
| string |
propertyName |
|
Returns
ToString()
Declaration
public override string ToString()
Returns
Overrides
Implements
Extension Methods