Skip to main content

Abstract Class: RecoverableBaseEntity

Defined in: service-core/src/models/RecoverableBaseEntity.ts:17

The RecoverableBaseEntity provides an entity base class for those classes wishing to implement soft delete capability. A soft delete means that a delete operation does not remove the entity from the database but instead simply marks it as deleted. To completely remove the entity from the database the user must explicitly specify the entity to be purged.

Extends​

Extended by​

Constructors​

Constructor​

new RecoverableBaseEntity(other?): RecoverableBaseEntity

Defined in: service-core/src/models/RecoverableBaseEntity.ts:27

Parameters​

other?​

Partial<RecoverableBaseEntity>

Returns​

RecoverableBaseEntity

Overrides​

BaseEntity.constructor

Properties​

dateCreated​

dateCreated: Date

Defined in: service-core/src/models/BaseEntity.ts:36

The date and time that the entity was created.

Inherited from​

BaseEntity.dateCreated

dateModified​

dateModified: Date

Defined in: service-core/src/models/BaseEntity.ts:44

The date and time that the entity was last modified.

Inherited from​

BaseEntity.dateModified

deleted​

deleted: boolean = false

Defined in: service-core/src/models/RecoverableBaseEntity.ts:25

Indicates if the document has been soft deleted. Only RepoUtils.delete() (gated on ACLAction.DELETE) may change this — @ReadOnly prevents it from being set via the ordinary create/update paths, which are only gated on ACLAction.CREATE/UPDATE.

uid​

uid: string

Defined in: service-core/src/models/BaseEntity.ts:28

The universally unique identifier of the entity.

Inherited from​

BaseEntity.uid

version​

version: number = 0

Defined in: service-core/src/models/BaseEntity.ts:51

The optimistic lock version.

Inherited from​

BaseEntity.version