GetLockInfo – получить информацию о блокировке сущности
<< Click to Display Table of Contents >> Объектная модель > Основные механизмы > Locks – блокировки GetLockInfo – получить информацию о блокировке сущности |
Метод используется для получения информации о текущем состоянии блокировки сущности. С помощью метода можно узнать, заблокирована ли сущность. В случае блокировки можно установить имя пользователя, заблокировавшего сущность, время и дату блокировки.
Перегрузки
GetLockInfo(IEntity entity) |
Получить информацию о текущем состоянии блокировки сущности |
GetLockInfo(IBinaryData body) |
Получить информацию о текущем состоянии блокировки бинарных данных сущности |
Синтаксис
C# |
public static LockInfo GetLockInfo(IEntity entity); public static LockInfo GetLockInfo(IBinaryData body); |
Параметры
entity – сущность, для которой нужно получить информацию о блокировках;
body – бинарные данные сущности, для которых нужно получить информацию о блокировках.
Возвращаемое значение
Информация о текущей блокировке сущности.
Метод GetLockInfo() возвращает объект LockInfo, содержащий следующие свойства:
Имя |
Тип |
Описание |
---|---|---|
IsLocked |
bool |
Признак того, что сущность заблокирована. Возможные значения: True. Сущность заблокирована. False. Сущность не заблокирована |
IsLockedByMe |
bool |
Признак того, что сущность заблокирована текущим пользователем. Возможные значения: True. Сущность заблокирована текущим пользователем. False. Сущность заблокирована не текущим пользователем |
IsLockedByOther |
bool |
Признак того, что сущность заблокирована другим (не текущим) пользователем. Возможные значения: True. Сущность заблокирована другим пользователем. False. Сущность заблокирована текущим пользователем |
LockedMessage |
string |
Сообщение о блокировке |
LockTime |
DateTime |
Время установки блокировки |
OwnerName |
string |
Имя пользователя, который установил блокировку |
Пример. Проверка блокировки версий документа
/// <summary>
/// Проверка заблокированности любой версии.
/// </summary>
/// <param name="versions">Список версий документа.</param>
/// <returns>True, если заблокирована хотя бы одна версия.</returns>
public static bool VersionIsLocked(List<Sungero.Content.IElectronicDocumentVersions> versions)
{
foreach (var version in versions)
{
var lockInfo = version.Body != null ? Locks.GetLockInfo(version.Body): null;
var isLockedByOther = lockInfo != null && lockInfo.IsLocked;
if (isLockedByOther)
return true;
}
return false;
}
© Компания Directum, 2024 |