[DataContract]
public class DatasetShortcut : BaseEntityWithPermissions, IDatasetShortcut, IBaseEntityWithPermissions, ISetCopier, IHasVersion, IUserSpecific, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IDatasetShortcut>, IUserSpecificPublicToggle, IConvertableViewItem, ISetCopierCloneAlterer

Constructors

DatasetShortcut()

Declaration

public DatasetShortcut()

Properties

Available

Indicates where the user is available to use this shortcut from

Declaration

[EnumDataType(typeof(DatasetShorcutAvailability))]
public DatasetShorcutAvailability Available { get; set; }

Property Value

Type	Description
DatasetShorcutAvailability

Declaration

[NotMapped]
public string Available_Tooltip { get; set; }

Property Value

Type	Description
string

CopierCloneType

Declaration

public SetCopierCloneType CopierCloneType { get; set; }

Property Value

Type	Description
SetCopierCloneType

Description

A user friendly description of this query shortcut

Declaration

[StringLength(2000)]
public string Description { get; set; }

Property Value

Type	Description
string

FolderID

The link to the folder this item is contained in

Declaration

public Guid? FolderID { get; set; }

Property Value

Type	Description
Guid?

FolderID_Label

Declaration

public string FolderID_Label { get; set; }

Property Value

Type	Description
string

FolderID_Label_Silent

Declaration

[NotMapped]
public string FolderID_Label_Silent { get; set; }

Property Value

Type	Description
string

IsPublic

Indicates if this entity is visible to all users (public), or just the current user (private).

Directly maps to UserID property

Declaration

[NotMapped]
public bool IsPublic { get; set; }

Property Value

Type	Description
bool

IsSystem

Indicates this item is part of the core system. Any changes will be overwritten if the version number is lower than the provided version number and the item is also marked as a system item.

Declaration

[Required]
public bool IsSystem { get; set; }

Property Value

Type	Description
bool

Name

The unique user friendly name of this query short cut

Declaration

[Unique]
[Required]
[StringLength(500)]
public string Name { get; set; }

Property Value

Type	Description
string

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

Type	Description
string

QueryableItemSubID

The sub id of this queryable item.

Declaration

[StringLength(500)]
public string QueryableItemSubID { get; set; }

Property Value

Type	Description
string

QueryableItemTypeName

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

Declaration

[StringLength(50)]
public string QueryableItemTypeName { get; set; }

Property Value

Type	Description
string

Replace1QueryableItemID

The item of the specified type that you want to query that comes from replacing the main item from an override

A queryable item inherits IQueryableItem

Declaration

[StringLength(500)]
public string Replace1QueryableItemID { get; set; }

Property Value

Type	Description
string

Replace1QueryableItemSubID

The sub id of this queryable item that comes from replacing the main item from an override.

Declaration

[StringLength(500)]
public string Replace1QueryableItemSubID { get; set; }

Property Value

Type	Description
string

Replace1QueryableItemTypeName

The type of item you want to query that comes from replacing the main item from an override. This can be an Entity, History, or Query.

Declaration

[StringLength(50)]
public string Replace1QueryableItemTypeName { get; set; }

Property Value

Type	Description
string

Replace2QueryableItemID

The item of the specified type that you want to query that comes from replacing the main item from an override

A queryable item inherits IQueryableItem

Declaration

[StringLength(500)]
public string Replace2QueryableItemID { get; set; }

Property Value

Type	Description
string

Replace2QueryableItemSubID

The sub id of this queryable item that comes from replacing the main item from an override.

Declaration

[StringLength(500)]
public string Replace2QueryableItemSubID { get; set; }

Property Value

Type	Description
string

Replace2QueryableItemTypeName

The type of item you want to query that comes from replacing the main item from an override. This can be an Entity, History, or Query.

Declaration

[StringLength(50)]
public string Replace2QueryableItemTypeName { get; set; }

Property Value

Type	Description
string

Replace3QueryableItemID

The item of the specified type that you want to query that comes from replacing the main item from an override

A queryable item inherits IQueryableItem

Declaration

[StringLength(500)]
public string Replace3QueryableItemID { get; set; }

Property Value

Type	Description
string

Replace3QueryableItemSubID

The sub id of this queryable item that comes from replacing the main item from an override.

Declaration

[StringLength(500)]
public string Replace3QueryableItemSubID { get; set; }

Property Value

Type	Description
string

Replace3QueryableItemTypeName

The type of item you want to query that comes from replacing the main item from an override. This can be an Entity, History, or Query.

Declaration

[StringLength(50)]
public string Replace3QueryableItemTypeName { get; set; }

Property Value

Type	Description
string

Replace4QueryableItemID

The item of the specified type that you want to query that comes from replacing the main item from an override

A queryable item inherits IQueryableItem

Declaration

[StringLength(500)]
public string Replace4QueryableItemID { get; set; }

Property Value

Type	Description
string

Replace4QueryableItemSubID

The sub id of this queryable item that comes from replacing the main item from an override.

Declaration

[StringLength(500)]
public string Replace4QueryableItemSubID { get; set; }

Property Value

Type	Description
string

Replace4QueryableItemTypeName

The type of item you want to query that comes from replacing the main item from an override. This can be an Entity, History, or Query.

Declaration

[StringLength(50)]
public string Replace4QueryableItemTypeName { get; set; }

Property Value

Type	Description
string

Replace5QueryableItemID

The item of the specified type that you want to query that comes from replacing the main item from an override

A queryable item inherits IQueryableItem

Declaration

[StringLength(500)]
public string Replace5QueryableItemID { get; set; }

Property Value

Type	Description
string

Replace5QueryableItemSubID

The sub id of this queryable item that comes from replacing the main item from an override.

Declaration

[StringLength(500)]
public string Replace5QueryableItemSubID { get; set; }

Property Value

Type	Description
string

Replace5QueryableItemTypeName

The type of item you want to query that comes from replacing the main item from an override. This can be an Entity, History, or Query.

Declaration

[StringLength(50)]
public string Replace5QueryableItemTypeName { get; set; }

Property Value

Type	Description
string

Replace6QueryableItemID

The item of the specified type that you want to query that comes from replacing the main item from an override

A queryable item inherits IQueryableItem

Declaration

[StringLength(500)]
public string Replace6QueryableItemID { get; set; }

Property Value

Type	Description
string

Replace6QueryableItemSubID

The sub id of this queryable item that comes from replacing the main item from an override.

Declaration

[StringLength(500)]
public string Replace6QueryableItemSubID { get; set; }

Property Value

Type	Description
string

Replace6QueryableItemTypeName

The type of item you want to query that comes from replacing the main item from an override. This can be an Entity, History, or Query.

Declaration

[StringLength(50)]
public string Replace6QueryableItemTypeName { get; set; }

Property Value

Type	Description
string

UserID

Links to IUser. Indicates if this entity record is private to just the specified user, or if it is public to everyone (holding null)

Declaration

public Guid? UserID { get; set; }

Property Value

Type	Description
Guid?

UserID_Label

Declaration

public string UserID_Label { get; set; }

Property Value

Type	Description
string

UserID_Label_Silent

Declaration

[NotMapped]
public string UserID_Label_Silent { get; set; }

Property Value

Type	Description
string

Version

Indicates the version number of this item. Changes will only be overwritten if the provided new item has a higer version number than this one.

Declaration

[Required]
[DatabasePropertyValidation("MyItem.IsSystem", "var allUserTeams = await Cache.GetAllItems<LemonEdge.API.Entities.Administration.IUserTeam>(); (await Cache.GetAllItems<LemonEdge.API.Entities.Administration.ITeam>()).Any(x => allUserTeams.Where(ut => ut.UserID == User.ID).Select(ut => ut.TeamID).Contains(x.ID) && x.CanEditSystemItems)", "User is not authorized to modify system items.")]
public short Version { get; set; }

Property Value

Type	Description
short

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

Type	Name	Description
IEntityUpdater	host	The context this item was copied into
UserInfo	user	The current user
IReadOnlyCache	cache	The current local cache
IBaseEntity	sourceItem	The original source item this item was copied from

Returns

Type	Description
Task	A task inidicating the finishing of this method

CanConvertToType(Type)

Declaration

public bool CanConvertToType(Type type)

Parameters

Type	Name	Description
Type	type

Returns

Type	Description
bool

Convert(IEntityRetriever, Type)

Declaration

public Task<object> Convert(IEntityRetriever context, Type toType)

Parameters

Type	Name	Description
IEntityRetriever	context
Type	toType

Returns

Type	Description
Task<object>

CopyFromEntity(IBaseEntity)

Declaration

protected override void CopyFromEntity(IBaseEntity src)

Parameters

Type	Name	Description
IBaseEntity	src

Overrides

BaseEntity.CopyFromEntity(IBaseEntity)

CopyFromSource(IDatasetShortcut)

Updates all properties in this item to have the same properties as the source object.

Declaration

public void CopyFromSource(IDatasetShortcut source)

Parameters

Type	Name	Description
IDatasetShortcut	source	The source object to copy all values from.

CopyRelatedItem(IBaseEntity, EntityRelationship)

Determines whether the source item should be copied based on the provided relationship

Declaration

public bool CopyRelatedItem(IBaseEntity sourceItem, EntityRelationship rel)

Parameters

Type	Name	Description
IBaseEntity	sourceItem	The original source item this item was copied from
EntityRelationship	rel	The particular relationship from the source item

Returns

Type	Description
bool

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string