[EntityDefinition(EntityID.Folder, "dbo.LT_Folders", "Folder", LabelColumn = "Name", IsStandingDataEntity = false)]
[DefaultEntityIcon(ImageType.FolderTree)]
[EntityIndex(Name = "FolderEntity", ColumnNames = new string[] { "RootFolderEntityID", "ParentFolderID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending, IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
[EntityIndex(Name = "Name", ColumnNames = new string[] { "UserID", "Name" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending, IndexOrder.Ascending }, IncludeColumns = new string[] { "SafeID", "ParentFolderID", "AlgorithmStepID" }, IsClustered = false, IsUnique = false)]
public interface IFolder : IBaseEntityWithPermissions, IBaseEntityWithPermissionsUser, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, IUserSpecific

Properties

IsHidden

Indicate this folder is hidden in the UI. Default is false.

Declaration

[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicate this folder is not hidden in the UI. Default is false")]
bool IsHidden { get; set; }

Property Value

Type	Description
bool

Name

The name of the folder LabelColumn

Declaration

[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityDescription("The name of the folder.")]
[EntityKeyProperty]
[Required]
string Name { get; set; }

Property Value

Type	Description
string

ParentFolderID

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntitySelfRelationship("ID", SingleJoinType.ZeroToOne, "Parent Folder", "Sub Folders", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = false, InheritPermissions = false, PreventAutoConstraint = true)]
[EntityDescription("Parent folder this one belongs to")]
Guid? ParentFolderID { get; set; }

Property Value

Type	Description
Guid?

PermissionEntityID

[Key] Instance ID of the Permission Entity Type

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityDescription("The Instance ID relating to the Permission Entity Type (eg. document category = tax).")]
[EntityKeyProperty]
[EntityLinkToAnyParentRelationship("PermissionEntityTypeID", SingleJoinType.ZeroToOne, "Permissions", false, null)]
Guid? PermissionEntityID { get; set; }

Property Value

Type	Description
Guid?

PermissionEntityTypeID

The Entity type that drive link to the permissions (eg. document categories driving investor access to document folders).

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("The Entity type that drive link to the permissions (eg. document categories driving investor access to document folders).")]
[EntityKeyProperty]
Guid? PermissionEntityTypeID { get; set; }

Property Value

Type	Description
Guid?

RootFolderEntityID

[Key] The item this root folder is associated with

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityDescription("The item this root folder is associated with.")]
[EntityKeyProperty]
[EntityLinkToAnyParentRelationship("RootFolderEntityTypeID", SingleJoinType.ZeroToOne, "Folders", false, new Type[] { typeof(IVennSetQueryableItem), typeof(ISQLTypeWrapper), typeof(IDatasetQueryableItem) }, OnlyWithLabels = true)]
Guid? RootFolderEntityID { get; set; }

Property Value

Type	Description
Guid?

RootFolderEntityTypeID

The type this root folder is associated with

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("The type this root folder is associated with.")]
[EntityKeyProperty]
Guid? RootFolderEntityTypeID { get; set; }

Property Value

Type	Description
Guid?

Extension Methods

LinqExtensions.AsArray<T>(T)

LinqExtensions.ToArrayOfOne<T>(T)

LinqExtensions.ToListOfOne<T>(T)

MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)

WeakReferenceExtensions.WeakReference(object)

SQLExtensions.ToSQLValue(object, bool)

ReflectionExtensions.ClearEventInvocations(object, string)

StringExtensions.ToCSVFormatString(object, Type)