IDataArchiveService Interface

Service contract for data archival and purging

Namespace: SanteDB.Core.Services
Assembly: SanteDB.Core.Api (in SanteDB.Core.Api.dll) Version: 3.0.2081-alpha+b4ae72647f2cc271f89142f76fff26ad69e00f5a

Syntax

C++

Copy

public interface IDataArchiveService : IServiceImplementation

Public Interface IDataArchiveService
	Inherits IServiceImplementation

public interface class IDataArchiveService : IServiceImplementation

type IDataArchiveService = 
    interface
        interface IServiceImplementation
    end

The IDataArchiveService type exposes the following members.

Properties

	Name	Description
	ServiceName	Gets the service name (Inherited from IServiceImplementation)

Top

Methods

	Name	Description
	Archive	Push the specified records to the archive
	Exists	Validates whether the specified key exists in the archive
	Purge	Purge the specified object from the archive
	Retrieve	Retrieve a record from the archive by key and type

Top

Remarks

The data archive service is used by various jobs throughout SanteDB iCDR (such as the DataRetentionJob) to copy records which are past their retention rules to a secondary data storage facility. This service can be used for long-term archival of old (non-clinically relevant data) data and supports the purging of data which is no longer needed.

Reference

SanteDB.Core.Services Namespace