DataRetentionFeature Class

Data retention feature which enables the retention service

Inheritance Hierarchy

SystemObject
SanteDB.Core.Configuration.FeaturesDataRetentionFeature

Namespace: SanteDB.Core.Configuration.Features
Assembly: SanteDB.Core.Api (in SanteDB.Core.Api.dll) Version: 2.2.1

Syntax

public class DataRetentionFeature : IFeature

Public Class DataRetentionFeature
	Implements IFeature

public ref class DataRetentionFeature : IFeature

type DataRetentionFeature =  
    class
        interface IFeature
    end

The DataRetentionFeature type exposes the following members.

Constructors

	Name	Description
	DataRetentionFeature	Creates a new data retention feature

Properties

	Name	Description
	Configuration	Gets or sets the configuration object which the feature wishes the configuration tool to render.
	ConfigurationType	Gets or sets the type of configuration section which this feature is expecting
	Description	Gets a human readable description of the feature which can be shown on the user interface
	Flags	Gets the flags for this feature (such as auto-configure, always apply configuration, etc.)
	Group	The group in which this feature belongs
	Name	Gets the name of the feature to show in the main configuration panel

Methods

	Name	Description
	CreateInstallTasks	Creates one or more IConfigurationTask instances which can be executed to setup the feature
	CreateUninstallTasks	Creates one or more IConfigurationTask instances which can be executed to remove the feature from SanteDB
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	QueryState	Query the status of the feature in configuration
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Extension Methods

	Name	Description
	ConvertTReturn	The purpose of this method is to convert object me to TReturn. Why? Because if you have an instance of Act that actually needs to be a SubstanceAdministration we can't just cast so we have to copy. (Defined by ExtensionMethods.)
	GetInstanceOfTDomain	Gets an instance of TDomain from me (Defined by ModelExtensions.)

Remarks

This feature sets up the DataRetentionConfigurationSection with the user's preferred retention rules, and then enables the DataRetentionJob in the host context.