Интерфейс ICSSoft.STORMNET.Business.Audit.IAuditService

Интерфейс для сервиса аудита (отвечает за API и настройки). Подробнее...

Граф наследования:ICSSoft.STORMNET.Business.Audit.IAuditService:

Открытые члены
bool	IsTypeAuditable (Type curType)
	Является ли класс аудируемым (проверяются настройки по аудиту приложения + настройки класса). Подробнее...
bool	EnableAudit (bool throwExceptions)
	Включить ведение аудита в приложении (предварительно должны быть проинициализированы AppSetting и Audit). Подробнее...
void	DisableAudit ()
	Отключить ведение аудита в приложении. Подробнее...
Guid?	WriteCommonAuditOperation (DataObject operationedObject, IDataService dataService, bool throwExceptions=true, IDbTransaction transaction=null)
	Сообщаем о совершении потенциально аудируемого действа. Подробнее...
bool	RatifyAuditOperation (tExecutionVariant executionVariant, List< Guid > auditOperationIdList, bool throwExceptions)
	Подтверждение созданных ранее операций аудита (если аудит идёт в одну БД с приложением, то будет использован сервис данных по умолчанию). Подробнее...
bool	RatifyAuditOperation (tExecutionVariant executionVariant, List< Guid > auditOperationIdList, string dataServiceConnectionString, Type dataServiceType, bool throwExceptions)
	Подтверждение созданных ранее операций аудита (если аудит идёт в одну БД с приложением, то будет использован сервис данных по умолчанию). Подробнее...
bool	RatifyAuditOperation (tExecutionVariant executionVariant, List< Guid > auditOperationIdList, IDataService dataService, bool throwExceptions)
	Подтверждение созданных ранее операций аудита (выполнение зависит от выбранного режима записи данных аудита) (если аудит идёт в одну БД с приложением, то будет в сервис аудита передаваться имя строки соединения, найденное в AuditService.Current.AppSetting.AuditDSSettings по параметрам переданного сервиса данных). Подробнее...
Guid?	WriteCustomAuditOperation (CustomAuditParameters customAuditParameters, bool throwExceptions)
	Сделать запись в аудит (если аудит идёт в одну БД с приложением, то будет использован сервис данных по умолчанию). Подробнее...
Guid?	WriteCustomAuditOperation (CustomAuditParameters customAuditParameters, IDataService dataService, bool throwExceptions)
	Сделать запись в аудит (если аудит идёт в одну БД с приложением, то будет в сервис аудита передаваться имя строки соединения, найденное в AuditService.Current.AppSetting.AuditDSSettings по параметрам переданного сервиса данных). Подробнее...
Guid?	WriteCustomAuditOperation (CustomAuditParameters customAuditParameters, string dataServiceConnectionString, Type dataServiceType, bool throwExceptions)
	Сделать запись в аудит (если аудит идёт в одну БД с приложением, то будет в сервис аудита передаваться имя строки соединения, найденное в AuditService.Current.AppSetting.AuditDSSettings по параметрам переданного сервиса данных). Подробнее...
void	AddCreateAuditInformation (DataObject operationedObject)
	Добавление информации о том, кто и когда создал объект, если он это поддерживает. Подробнее...
void	AddEditAuditInformation (DataObject operationedObject)
	Добавление информации о том, кто и когда отредактировал объект, если он это поддерживает. Подробнее...
View	GetViewByAuditRecord (IAuditRecord auditRecord)
	Получение представления, по которому вероятнее всего вёлся аудит объекта, по операции над которым есть запись. Данное представление будет использоваться для получения кэпшенов полей. Подробнее...
View	GetAuditViewByType (Type type, tTypeOfAuditOperation operationType)
	Получение представления для аудита у определенного типа. Подробнее...
void	WriteCommonAuditOperationWithAutoFields (IEnumerable< DataObject > operationedObjects, ICollection< AuditAdditionalInfo > auditOperationInfoList, IDataService dataService, bool throwExceptions=true, IDbTransaction transaction=null)
	Сообщаем о совершении потенциально аудируемого действа. Подробнее...
AuditAdditionalInfo	WriteCommonAuditOperationWithAutoFields (DataObject operationedObject, IDataService dataService, bool throwExceptions=true, IDbTransaction transaction=null)
	Сообщаем о совершении потенциально аудируемого действа. Подробнее...
bool	RatifyAuditOperationWithAutoFields (tExecutionVariant executionVariant, List< AuditAdditionalInfo > auditOperationInfoList, IDataService dataService, bool throwExceptions)
	Подтверждение созданных ранее операций аудита (выполнение зависит от выбранного режима записи данных аудита) (если аудит идёт в одну БД с приложением, то будет в сервис аудита передаваться имя строки соединения, найденное в AuditService.Current.AppSetting.AuditDSSettings по параметрам переданного сервиса данных). Подробнее...

Свойства
bool	IsAuditEnabled [get]
	Включён ли аудит для приложения. Подробнее...
bool	IsAuditRemote [get]
	Выполняется ли аудит удалённо (то есть через вызов AuditWinService). Подробнее...
string	AuditConnectionStringName [get]
	Получение имени строки соединения с БД аудита (используется для загрузки данных из БД). Если используется запись аудита через windows-сервис, то будет возвращено null. Подробнее...
bool	ShowPrimaryKey [get, set]
	Следует ли отображать записи с изменением первичного ключа на формах. Подробнее...
bool	PersistUtcDates [get, set]
	Флаг, указывающий, что в бд даты хранятся в формате UTC. Значение по умолчанию false. Подробнее...
AuditAppSetting	AppSetting [get, set]
	Настройки аудита в приложении. Подробнее...
IAudit	Audit [get, set]
	Элемент, реализующий логику аудита. Подробнее...

Подробное описание

Интерфейс для сервиса аудита (отвечает за API и настройки).

Методы

AddCreateAuditInformation()

void ICSSoft.STORMNET.Business.Audit.IAuditService.AddCreateAuditInformation

(

DataObject

operationedObject

)

Добавление информации о том, кто и когда создал объект, если он это поддерживает.

Аргументы

operationedObject

Объект, куда добавляется информация.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

AddEditAuditInformation()

void ICSSoft.STORMNET.Business.Audit.IAuditService.AddEditAuditInformation

(

DataObject

operationedObject

)

Добавление информации о том, кто и когда отредактировал объект, если он это поддерживает.

Аргументы

operationedObject

Объект, куда добавляется информация.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

DisableAudit()

void ICSSoft.STORMNET.Business.Audit.IAuditService.DisableAudit

(

)

Отключить ведение аудита в приложении.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

EnableAudit()

bool ICSSoft.STORMNET.Business.Audit.IAuditService.EnableAudit

(

bool

throwExceptions

)

Включить ведение аудита в приложении (предварительно должны быть проинициализированы AppSetting и Audit).

Аргументы

throwExceptions

Следует ли вызывать исключения в ошибочной ситуации.

Возвращает

Удалось ли включить аудит.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

GetAuditViewByType()

View ICSSoft.STORMNET.Business.Audit.IAuditService.GetAuditViewByType	(	Type	type,
		tTypeOfAuditOperation	operationType
	)

Получение представления для аудита у определенного типа.

Аргументы

type	Тип, у которого нужно получить представление для аудита.
operationType	Тип аудируемой операции, для которой нужно получить представление. (Select, Insert, Update или Delete).

Возвращает

Представление для аудита.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

GetViewByAuditRecord()

View ICSSoft.STORMNET.Business.Audit.IAuditService.GetViewByAuditRecord

(

IAuditRecord

auditRecord

)

Получение представления, по которому вероятнее всего вёлся аудит объекта, по операции над которым есть запись. Данное представление будет использоваться для получения кэпшенов полей.

Аргументы

auditRecord

Запись из аудита, по которой необходимо определить представление.

Возвращает

Найденное представление (если что-то не удалось, то выдастся null; исключения не должно быть в любом случае).

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

IsTypeAuditable()

bool ICSSoft.STORMNET.Business.Audit.IAuditService.IsTypeAuditable

(

Type

curType

)

Является ли класс аудируемым (проверяются настройки по аудиту приложения + настройки класса).

Аргументы

curType

Исследуемый тип.

Возвращает

True, если является и нужно вести аудит.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

RatifyAuditOperation() [1/3]

bool ICSSoft.STORMNET.Business.Audit.IAuditService.RatifyAuditOperation	(	tExecutionVariant	executionVariant,
		List< Guid >	auditOperationIdList,
		bool	throwExceptions
	)

Подтверждение созданных ранее операций аудита (если аудит идёт в одну БД с приложением, то будет использован сервис данных по умолчанию).

Аргументы

executionVariant	Какой статус будет присвоен операции.
auditOperationIdList	Список айдишников записей аудита.
throwExceptions	Следует ли пробрасывать дальше возникшее исключение.

Возвращает

True, если всё закончилось без ошибок.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

RatifyAuditOperation() [2/3]

bool ICSSoft.STORMNET.Business.Audit.IAuditService.RatifyAuditOperation	(	tExecutionVariant	executionVariant,
		List< Guid >	auditOperationIdList,
		IDataService	dataService,
		bool	throwExceptions
	)

Подтверждение созданных ранее операций аудита (выполнение зависит от выбранного режима записи данных аудита) (если аудит идёт в одну БД с приложением, то будет в сервис аудита передаваться имя строки соединения, найденное в AuditService.Current.AppSetting.AuditDSSettings по параметрам переданного сервиса данных).

Аргументы

executionVariant	Какой статус будет присвоен операции.
auditOperationIdList	Список айдишников записей аудита.
dataService	Сервис данных, по параметрам которого (строка соединения и тип) осуществляется поиск в AuditService.Current.AppSetting.AuditDSSettings.
throwExceptions	Следует ли пробрасывать дальше возникшее исключение.

Возвращает

True, если всё закончилось без ошибок.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

RatifyAuditOperation() [3/3]

bool ICSSoft.STORMNET.Business.Audit.IAuditService.RatifyAuditOperation	(	tExecutionVariant	executionVariant,
		List< Guid >	auditOperationIdList,
		string	dataServiceConnectionString,
		Type	dataServiceType,
		bool	throwExceptions
	)

Подтверждение созданных ранее операций аудита (если аудит идёт в одну БД с приложением, то будет использован сервис данных по умолчанию).

Аргументы

executionVariant	Какой статус будет присвоен операции.
auditOperationIdList	Список айдишников записей аудита.
dataServiceConnectionString	Строка соединения сервиса данных, который выполняет запись в БД приложения.
dataServiceType	Тип сервиса данных, который выполняет запись в БД приложения.
throwExceptions	Следует ли пробрасывать дальше возникшее исключение.

Возвращает

True, если всё закончилось без ошибок.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

RatifyAuditOperationWithAutoFields()

bool ICSSoft.STORMNET.Business.Audit.IAuditService.RatifyAuditOperationWithAutoFields	(	tExecutionVariant	executionVariant,
		List< AuditAdditionalInfo >	auditOperationInfoList,
		IDataService	dataService,
		bool	throwExceptions
	)

Подтверждение созданных ранее операций аудита (выполнение зависит от выбранного режима записи данных аудита) (если аудит идёт в одну БД с приложением, то будет в сервис аудита передаваться имя строки соединения, найденное в AuditService.Current.AppSetting.AuditDSSettings по параметрам переданного сервиса данных).

Аргументы

executionVariant	Какой статус будет присвоен операции.
auditOperationInfoList	Дополнительная информация, которую необходимо передать в аудит.
dataService	Сервис данных, по параметрам которого (строка соединения и тип) осуществляется поиск в AuditService.Current.AppSetting.AuditDSSettings.
throwExceptions	Следует ли пробрасывать дальше возникшее исключение.

Возвращает

True, если всё закончилось без ошибок.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

WriteCommonAuditOperation()

Guid? ICSSoft.STORMNET.Business.Audit.IAuditService.WriteCommonAuditOperation	(	DataObject	operationedObject,
		IDataService	dataService,
		bool	throwExceptions = true,
		IDbTransaction	transaction = null
	)

Сообщаем о совершении потенциально аудируемого действа.

Аргументы

operationedObject	Объект, над которым выполняется операция.
dataService	Сервис данных, который выполянет операцию.
throwExceptions	Следует ли пробрасывать дальше возникшее исключение (по умолчанию - true).
transaction	Транзакция, через которую необходимо проводить выполнение зачиток из БД приложения аудиту (при работе AuditService иногда необходимо дочитать объект или получить сохранённую копию, а выполнение данного действия без транзакции может привести к взаимоблокировке). По умолчанию - null.

Возвращает

Ответ о том, можно ли выполнять операцию (если null, то значит, что что-то пошло не так).

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

WriteCommonAuditOperationWithAutoFields() [1/2]

AuditAdditionalInfo ICSSoft.STORMNET.Business.Audit.IAuditService.WriteCommonAuditOperationWithAutoFields	(	DataObject	operationedObject,
		IDataService	dataService,
		bool	throwExceptions = true,
		IDbTransaction	transaction = null
	)

Сообщаем о совершении потенциально аудируемого действа.

Аргументы

operationedObject	Объект, над которым выполняется операция.
dataService	Сервис данных, который выполянет операцию.
throwExceptions	Следует ли пробрасывать дальше возникшее исключение (по умолчанию - true).
transaction	Транзакция, через которую необходимо проводить выполнение зачиток из БД приложения аудиту (при работе AuditService иногда необходимо дочитать объект или получить сохранённую копию, а выполнение данного действия без транзакции может привести к взаимоблокировке). По умолчанию - null.

Возвращает

Ответ о том, можно ли выполнять операцию (если null, то значит, что что-то пошло не так).

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

WriteCommonAuditOperationWithAutoFields() [2/2]

void ICSSoft.STORMNET.Business.Audit.IAuditService.WriteCommonAuditOperationWithAutoFields	(	IEnumerable< DataObject >	operationedObjects,
		ICollection< AuditAdditionalInfo >	auditOperationInfoList,
		IDataService	dataService,
		bool	throwExceptions = true,
		IDbTransaction	transaction = null
	)

Сообщаем о совершении потенциально аудируемого действа.

Аргументы

operationedObjects	Объекты, над которыми выполняется операция.
auditOperationInfoList	Дополнительная информация, которую необходимо передать в аудит.
dataService	Сервис данных, который выполянет операцию.
throwExceptions	Следует ли пробрасывать дальше возникшее исключение (по умолчанию - true).
transaction	Транзакция, через которую необходимо проводить выполнение зачиток из БД приложения аудиту (при работе AuditService иногда необходимо дочитать объект или получить сохранённую копию, а выполнение данного действия без транзакции может привести к взаимоблокировке). По умолчанию - null.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

WriteCustomAuditOperation() [1/3]

Guid? ICSSoft.STORMNET.Business.Audit.IAuditService.WriteCustomAuditOperation	(	CustomAuditParameters	customAuditParameters,
		bool	throwExceptions
	)

Сделать запись в аудит (если аудит идёт в одну БД с приложением, то будет использован сервис данных по умолчанию).

Аргументы

customAuditParameters	Параметры аудита.
throwExceptions	Следует ли пробрасывать дальше возникшее исключение.

Возвращает

Id записи аудита.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

WriteCustomAuditOperation() [2/3]

Guid? ICSSoft.STORMNET.Business.Audit.IAuditService.WriteCustomAuditOperation	(	CustomAuditParameters	customAuditParameters,
		IDataService	dataService,
		bool	throwExceptions
	)

Сделать запись в аудит (если аудит идёт в одну БД с приложением, то будет в сервис аудита передаваться имя строки соединения, найденное в AuditService.Current.AppSetting.AuditDSSettings по параметрам переданного сервиса данных).

Аргументы

customAuditParameters	Параметры аудита.
dataService	Сервис данных, по параметрам которого (строка соединения и тип) осуществляется поиск в AuditService.Current.AppSetting.AuditDSSettings.
throwExceptions	Следует ли пробрасывать дальше возникшее исключение.

Возвращает

Id записи аудита.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

WriteCustomAuditOperation() [3/3]

Guid? ICSSoft.STORMNET.Business.Audit.IAuditService.WriteCustomAuditOperation	(	CustomAuditParameters	customAuditParameters,
		string	dataServiceConnectionString,
		Type	dataServiceType,
		bool	throwExceptions
	)

Сделать запись в аудит (если аудит идёт в одну БД с приложением, то будет в сервис аудита передаваться имя строки соединения, найденное в AuditService.Current.AppSetting.AuditDSSettings по параметрам переданного сервиса данных).

Аргументы

customAuditParameters	Параметры аудита.
dataServiceConnectionString	Строка соединения сервиса данных, который выполняет запись в БД приложения.
dataServiceType	Тип сервиса данных, который выполняет запись в БД приложения.
throwExceptions	Следует ли пробрасывать дальше возникшее исключение.

Возвращает

Id записи аудита.

Замещается в ICSSoft.STORMNET.Business.Audit.AuditService.

Полный список свойств

AppSetting

AuditAppSetting ICSSoft.STORMNET.Business.Audit.IAuditService.AppSetting

getset

Настройки аудита в приложении.

Audit

IAudit ICSSoft.STORMNET.Business.Audit.IAuditService.Audit

getset

Элемент, реализующий логику аудита.

AuditConnectionStringName

string ICSSoft.STORMNET.Business.Audit.IAuditService.AuditConnectionStringName

get

Получение имени строки соединения с БД аудита (используется для загрузки данных из БД). Если используется запись аудита через windows-сервис, то будет возвращено null.

IsAuditEnabled

bool ICSSoft.STORMNET.Business.Audit.IAuditService.IsAuditEnabled

get

Включён ли аудит для приложения.

IsAuditRemote

bool ICSSoft.STORMNET.Business.Audit.IAuditService.IsAuditRemote

get

Выполняется ли аудит удалённо (то есть через вызов AuditWinService).

PersistUtcDates

bool ICSSoft.STORMNET.Business.Audit.IAuditService.PersistUtcDates

getset

Флаг, указывающий, что в бд даты хранятся в формате UTC. Значение по умолчанию false.

ShowPrimaryKey

bool ICSSoft.STORMNET.Business.Audit.IAuditService.ShowPrimaryKey

getset

Следует ли отображать записи с изменением первичного ключа на формах.