Класс ICSSoft.STORMNET.Business.Audit.AuditService

Статическая обёртка для класса, наследующего от IAuditService. Подробнее...

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

Открытые члены
bool	EnableAudit (bool throwExceptions)
	Включить ведение аудита в приложении (предварительно должны быть проинициализированы AppSetting и Audit). Подробнее...
void	DisableAudit ()
	Отключить ведение аудита в приложении. Подробнее...
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 по параметрам переданного сервиса данных). Также будут проверяться настройки класса на случай, если там заданы особые настройки класса. Подробнее...
View	GetViewByAuditRecord (IAuditRecord auditRecord)
	Получение представления, по которому вероятнее всего вёлся аудит объекта, по операции над которым есть запись. Данное представление будет использоваться для получения кэпшенов полей. Подробнее...
View	GetAuditViewByType (Type type, tTypeOfAuditOperation operationType)
	Получение представления для аудита у определенного типа. Подробнее...
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 по параметрам переданного сервиса данных). Подробнее...
bool	IsTypeAuditable (Type curType)
	Является ли класс аудируемым (проверяются настройки по аудиту приложения + настройки класса). Подробнее...
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	WriteCommonAuditOperation (DataObject operationedObject, IDataService dataService, bool throwExceptions=true, IDbTransaction transaction=null)
	Сообщаем о совершении потенциально аудируемого действа. Подробнее...
virtual void	AddCreateAuditInformation (DataObject operationedObject)
	Добавление информации о том, кто и когда создал объект, если он это поддерживает. Подробнее...
virtual void	AddEditAuditInformation (DataObject operationedObject)
	Добавление информации о том, кто и когда отредактировал объект, если он это поддерживает. Подробнее...

Открытые статические члены
static void	InitAuditService (AuditAppSetting appSetting, IAudit audit)
	Инициализация текущего сервиса аудита. Подробнее...

Открытые атрибуты
bool	IsAuditEnabled => AppSetting != null && AppSetting.AuditEnabled
	Включён ли аудит для приложения. Подробнее...
bool	IsAuditRemote => !string.IsNullOrEmpty(AppSetting.AuditWinServiceUrl)
	Выполняется ли аудит удалённо (то есть через вызов AuditWinService). Подробнее...

Статические открытые данные
static IAuditService	Current => _currentAuditService ?? (_currentAuditService = new AuditService())
	Текущий класс для работы с сервисом аудита. Подробнее...

Защищенные члены
virtual bool	RatifyAuditOperation (tExecutionVariant executionVariant, List< AuditAdditionalInfo > auditOperationInfoList, string dataServiceConnectionString, Type dataServiceType, bool throwExceptions, bool checkClassAuditSettings=false)
	Подтверждение созданных ранее операций аудита (если аудит идёт в одну БД с приложением, то будет использован сервис данных по умолчанию). Подробнее...
virtual void	CheckAndSendToAudit (RatificationAuditParameters ratificationAuditParameters, bool checkClassAuditSettings)
	Проверка режима записи данных аудита и в зависимости от этого отправка нужным способом данных аудита. Подробнее...
virtual DateTime	GetAuditOperationTime (DataObject operatedObject)
	Gets the time when auditable operation occurred with the specified object. Подробнее...
virtual string	GetConnectionStringName (string dataServiceConnectionString, Type dataServiceType)
	Получение имени строки соединения с БД приложения на основании переданного сервиса данных (поиск осуществляется среди DetailArrayOfAuditDSSetting по строке соединения и типу сервиса данных; если переданный сервис данных null, то берётся первое валидное имя строки соединения в DetailArrayOfAuditDSSetting). Подробнее...

Свойства
AppMode	ApplicationMode [get, set]
	Режим, в котором работает приложение: win или web. Подробнее...
string	AuditConnectionStringName [get]
	Получение имени строки соединения с БД аудита. (используется для загрузки данных из БД). Если используется запись аудита через windows-сервис, то будет возвращено null. Подробнее...
bool	ShowPrimaryKey [get, set]
	Следует ли отображать записи с изменением первичного ключа на формах. Подробнее...
AuditAppSetting	AppSetting [get, set]
	Настройки аудита в приложении. Подробнее...
IAudit	Audit [get, set]
	Элемент, реализующий логику аудита. Подробнее...
Свойства унаследованные от ICSSoft.STORMNET.Business.Audit.IAuditService
bool	IsAuditEnabled [get]
	Включён ли аудит для приложения Подробнее...
bool	IsAuditRemote [get]
	Выполняется ли аудит удалённо (то есть через вызов AuditWinService) Подробнее...
string	AuditConnectionStringName [get]
	Получение имени строки соединения с БД аудита (используется для загрузки данных из БД). Если используется запись аудита через windows-сервис, то будет возвращено null Подробнее...
bool	ShowPrimaryKey [get, set]
	Следует ли отображать записи с изменением первичного ключа на формах. Подробнее...
AuditAppSetting	AppSetting [get, set]
	Настройки аудита в приложении Подробнее...
IAudit	Audit [get, set]
	Элемент, реализующий логику аудита Подробнее...
AppMode	ApplicationMode [get, set]
	Режим, в котором работает приложение: win или web Подробнее...

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

Статическая обёртка для класса, наследующего от IAuditService.

Методы

virtual void ICSSoft.STORMNET.Business.Audit.AuditService.AddCreateAuditInformation ( DataObject  operationedObject )

inlinevirtual

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

Аргументы

operationedObject

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

virtual void ICSSoft.STORMNET.Business.Audit.AuditService.AddEditAuditInformation ( DataObject  operationedObject )

inlinevirtual

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

Аргументы

operationedObject

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

virtual void ICSSoft.STORMNET.Business.Audit.AuditService.CheckAndSendToAudit ( RatificationAuditParameters  ratificationAuditParameters, bool  checkClassAuditSettings  )

inlineprotectedvirtual

Проверка режима записи данных аудита и в зависимости от этого отправка нужным способом данных аудита.

Аргументы

ratificationAuditParameters	Параметры аудита.
checkClassAuditSettings	Следует ли проверять настройки аудита в классах.

void ICSSoft.STORMNET.Business.Audit.AuditService.DisableAudit ( )

inline

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

bool ICSSoft.STORMNET.Business.Audit.AuditService.EnableAudit ( bool  throwExceptions )

inline

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

Аргументы

throwExceptions

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

Возвращает

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

virtual DateTime ICSSoft.STORMNET.Business.Audit.AuditService.GetAuditOperationTime ( DataObject  operatedObject )

inlineprotectedvirtual

Gets the time when auditable operation occurred with the specified object.

Аргументы

operatedObject

The operated object.

Возвращает

Returns time when auditable operation occurred (DateTime.Now by default).

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

inline

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

Аргументы

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

Возвращает

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

virtual string ICSSoft.STORMNET.Business.Audit.AuditService.GetConnectionStringName ( string  dataServiceConnectionString, Type  dataServiceType  )

inlineprotectedvirtual

Получение имени строки соединения с БД приложения на основании переданного сервиса данных (поиск осуществляется среди DetailArrayOfAuditDSSetting по строке соединения и типу сервиса данных; если переданный сервис данных null, то берётся первое валидное имя строки соединения в DetailArrayOfAuditDSSetting).

Аргументы

dataServiceConnectionString	Строка соединения сервиса данных, который выполняет запись в БД приложения.
dataServiceType	Тип сервиса данных, который выполняет запись в БД приложения.

Возвращает

Имя строки соединения с БД приложения.

View ICSSoft.STORMNET.Business.Audit.AuditService.GetViewByAuditRecord ( IAuditRecord  auditRecord )

inline

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

Аргументы

auditRecord

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

Возвращает

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

static void ICSSoft.STORMNET.Business.Audit.AuditService.InitAuditService ( AuditAppSetting  appSetting, IAudit  audit  )

inlinestatic

Инициализация текущего сервиса аудита.

Аргументы

appSetting	Настройки аудита приложения.
audit	Элемент, реализующий логику аудита.

bool ICSSoft.STORMNET.Business.Audit.AuditService.IsTypeAuditable ( Type  curType )

inline

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

Аргументы

curType

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

Возвращает

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

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

inline

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

Аргументы

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

Возвращает

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

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

inline

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

Аргументы

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

Возвращает

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

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

inline

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

Аргументы

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

Возвращает

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

virtual bool ICSSoft.STORMNET.Business.Audit.AuditService.RatifyAuditOperation ( tExecutionVariant  executionVariant, List< AuditAdditionalInfo >  auditOperationInfoList, string  dataServiceConnectionString, Type  dataServiceType, bool  throwExceptions, bool  checkClassAuditSettings = false  )

inlineprotectedvirtual

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

Аргументы

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

Возвращает

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

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

inline

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

Аргументы

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

Возвращает

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

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

inline

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

Аргументы

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

Возвращает

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

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

inline

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

Аргументы

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

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

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

inline

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

Аргументы

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

Возвращает

Идентификатор записи аудита.

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

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

inline

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

Аргументы

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

Возвращает

Идентификатор записи аудита.

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

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

inline

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

Аргументы

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

Возвращает

Идентификатор записи аудита.

Замещает ICSSoft.STORMNET.Business.Audit.IAuditService.

Данные класса

IAuditService ICSSoft.STORMNET.Business.Audit.AuditService.Current => _currentAuditService ?? (_currentAuditService = new AuditService())

static

Текущий класс для работы с сервисом аудита.

bool ICSSoft.STORMNET.Business.Audit.AuditService.IsAuditEnabled => AppSetting != null && AppSetting.AuditEnabled

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

bool ICSSoft.STORMNET.Business.Audit.AuditService.IsAuditRemote => !string.IsNullOrEmpty(AppSetting.AuditWinServiceUrl)

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

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

AppMode ICSSoft.STORMNET.Business.Audit.AuditService.ApplicationMode

getset

Режим, в котором работает приложение: win или web.

AuditAppSetting ICSSoft.STORMNET.Business.Audit.AuditService.AppSetting

getset

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

IAudit ICSSoft.STORMNET.Business.Audit.AuditService.Audit

getset

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

string ICSSoft.STORMNET.Business.Audit.AuditService.AuditConnectionStringName

get

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

bool ICSSoft.STORMNET.Business.Audit.AuditService.ShowPrimaryKey

getset

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