Class ArchiveRecovery

Provides recovery operations for archived records, including listing archived versions and restoring specific versions.

Index

Constructors

Accessors

Methods

GetArchivedVersions RestoreVersion

Constructors

constructor

new ArchiveRecovery(): ArchiveRecovery
Returns ArchiveRecovery

Accessors

Provider

get Provider(): IMetadataProvider
Returns IMetadataProvider
- Defined in Archiving/Engine/src/ArchiveRecovery.ts:20
set Provider(value: IMetadataProvider): void
Parameters
- value: IMetadataProvider
Returns void
- Defined in Archiving/Engine/src/ArchiveRecovery.ts:16

Methods

GetArchivedVersions

GetArchivedVersions(
    entityName: string,
    recordId: string,
    contextUser: UserInfo,
): Promise<BaseEntity<unknown>[]>
Retrieves all archived versions for a specific entity record. Queries the ArchiveRunDetail table for matching records.
Parameters
- entityName: string
  The name of the entity
- recordId: string
  The primary key value of the record
- contextUser: UserInfo
  User context for database access
Returns Promise<BaseEntity<unknown>[]>
Array of ArchiveRunDetail records, ordered by most recent first
- Defined in Archiving/Engine/src/ArchiveRecovery.ts:33

RestoreVersion

RestoreVersion(
archiveRunDetailId: string,
contextUser: UserInfo,
): Promise<RestoreRecordResult>
Restores a specific archived version of a record. Loads the ArchiveRunDetail, initializes the storage driver, reads the archive document, and applies the values back to the record.
Parameters
- archiveRunDetailId: string
  ID of the ArchiveRunDetail record to restore
- contextUser: UserInfo
  User context for database and storage access
Returns Promise<RestoreRecordResult>
Result indicating success/failure and which fields were restored
- Defined in Archiving/Engine/src/ArchiveRecovery.ts:59