Class Document

Inheritance
object
BaseEntity
BaseEntityWithPermissions
Document
Implements
Inherited Members
Namespace: LemonEdge.API.Entities.Workflow
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class Document : BaseEntityWithPermissions, IDocument, IAttachableBase, IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, IHasVersion, IHasDocumentCategory, ICloneableAsync<IDocument>

Constructors

Document()

Declaration
public Document()

Properties

CategoryID

The category of the document

Declaration
public Guid? CategoryID { get; set; }
Property Value
Type Description
Guid?

CategoryID_Label

Declaration
public string CategoryID_Label { get; set; }
Property Value
Type Description
string

CategoryID_Label_Silent

Declaration
[NotMapped]
public string CategoryID_Label_Silent { get; set; }
Property Value
Type Description
string

Date

The date associated with the inheriting entity.

Declaration
public DateTimeOffset? Date { get; set; }
Property Value
Type Description
DateTimeOffset?
Remarks

We should always use datetimeoffsets. They are international, with time zones, but most importantly odata supports them and not datetime

Description

A user friendly description of the document

Declaration
[StringLength(2000)]
public string Description { get; set; }
Property Value
Type Description
string

FileType

The type of file ascertained from the file extension

Declaration
[StringLength(10)]
public string FileType { get; set; }
Property Value
Type Description
string

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 name of the document ignoring any file extension

Declaration
[StringLength(500)]
public string Name { 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

CopyFromEntity(IBaseEntity)

Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Type Name Description
IBaseEntity src
Overrides

CopyFromSource(IDocument)

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

Declaration
public void CopyFromSource(IDocument source)
Parameters
Type Name Description
IDocument source

The source object to copy all values from.

GetShouldAutoGenerateTaskOnSave()

Declaration
public bool GetShouldAutoGenerateTaskOnSave()
Returns
Type Description
bool

SetAutoGenerateOnSave(bool)

Declaration
public void SetAutoGenerateOnSave(bool value)
Parameters
Type Name Description
bool value

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods