Interface ITechObjectsSource

Представляет источник объектов технологических данных.

Namespace: Ascon.Vertical.Core

Assembly: Ascon.Vertical.Core.dll

Syntax

public interface ITechObjectsSource

Methods

CanCreate(ITechObjectType)

Вычисляет возможность создания объекта указанного типа.

Declaration

bool CanCreate(ITechObjectType type)

Parameters

Type	Name	Description
ITechObjectType	type	Тип объекта.

Returns

Type	Description
bool	True - если можно создать объект указанного типа в состоянии по умолчанию.

CanDelete(ITechObject)

Вычисляет возможность удаления объекта.

Declaration

bool CanDelete(ITechObject obj)

Parameters

Type	Name	Description
ITechObject	obj	Объект.

Returns

Type	Description
bool	True - если можно удалить объект указанного типа.

Create(ITechObjectType, string, CancellationToken)

Создаёт новый объект.

Declaration

Task<ITechObject> Create(ITechObjectType type, string name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObjectType	type	Тип создаваемого объекта.
string	name	Наименование создаваемого объекта.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<ITechObject>	Созданный объект.

CreateCopy(ITechObject, ITechObjectsLink, bool, CancellationToken)

Создает копию объекта.

Declaration

Task<TechObjectCopyResult> CreateCopy(ITechObject parent, ITechObjectsLink prototypeLink, bool recursive, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObject	parent	Объект, в состав которого добавляется копия.
ITechObjectsLink	prototypeLink	Описание связи и объекта, копию которого нужно создать.
bool	recursive	Признак копирования вложенных объектов (True - копировать вложенные объекты, False - не копировать).
CancellationToken	cancellationToken	Признак отмены.

Returns

Type	Description
Task<TechObjectCopyResult>	Описание результата создания копии объекта.

Remarks

Копирует значения атрибутов объекта в зависимости от заданных в модели настроек.

CreateFromPolynom(string, IReadOnlyList<int>, string?, CancellationToken)

Создаёт новый объект, связанный со справочником.

Declaration

Task<ITechObject?> CreateFromPolynom(string location, IReadOnlyList<int> typesIds, string? name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	location	Строка расположения объекта в справочнике.
IReadOnlyList<int>	typesIds	Идентфикаторы возможных типов создаваемого объекта.
string	name	Наименование создаваемого объекта (необходимо указывать при характере ассоциации "многие к одному").
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<ITechObject>	Созданный объект.

CreateVersion(ITechObject, IReadOnlyList<ITechObjectsLink>?, int, CancellationToken)

Создает новую версию объекта.

Declaration

Task<TechObjectCreateVersionResult> CreateVersion(ITechObject obj, IReadOnlyList<ITechObjectsLink>? links, int versionSegmentIndexToIncrease, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObject	obj	Объект, для которого требуется создать новую версию.
IReadOnlyList<ITechObjectsLink>	links	Список идентификаторов связи по иерархии вверх, для объектов которых создается версия.
int	versionSegmentIndexToIncrease	Номер разряда версии, подлежащий увеличению.
CancellationToken	cancellationToken	Признак отмены.

Returns

Type	Description
Task<TechObjectCreateVersionResult>	Описание результата создания версии объекта.

Remarks

Будут созданы новые версии объектов по иерархии вверх согласно переданным связям.

Delete(ITechObjectsLink, bool, CancellationToken)

Удаляет объект из состава родительского объекта.

Declaration

Task<TechObjectDeleteResultDto> Delete(ITechObjectsLink link, bool recursive, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObjectsLink	link	Связь с удаляемым объектом.
bool	recursive	Признак, что необходимо удалить и все вложенные объекты.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<TechObjectDeleteResultDto>	Признак успешного удаления.

Delete(IReadOnlyCollection<ITechObjectsLink>, bool, CancellationToken)

Удаляет список объектов из состава родительских объектов.

Declaration

Task<IReadOnlyCollection<TechObjectDeleteResultDto>> Delete(IReadOnlyCollection<ITechObjectsLink> links, bool recursive, CancellationToken cancellationToken)

Parameters

Type	Name	Description
IReadOnlyCollection<ITechObjectsLink>	links	Связи с родительским объектом.
bool	recursive	Признак, что необходимо удалить и все вложенные объекты.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyCollection<TechObjectDeleteResultDto>>	Признак успешного удаления.

Remarks

При возникновении ошибок в процессе удаления, все объекты не будут удалены.

Delete(int, bool, CancellationToken)

Удаляет объект, который не входит в состав другого объекта.

Declaration

Task<TechObjectDeleteResultDto> Delete(int objId, bool recursive, CancellationToken cancellationToken)

Parameters

Type	Name	Description
int	objId	Идентификатор удаляемого объекта.
bool	recursive	Признак, что необходимо удалить и все вложенные объекты.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<TechObjectDeleteResultDto>	Признак успешного удаления.

DeleteByIds(ICollection<int>, CancellationToken)

Удаляет список объектов по указанным идентификаторам.

Declaration

Task DeleteByIds(ICollection<int> ids, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ICollection<int>	ids	Список идентификаторов удаляемых объектов.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task	Признак успешного удаления.

Exist((ITechObjectType ObjectType, string ObjectName)[], CancellationToken)

Вычисляет существование в базе данных объектов с заданными наименованиями.

Declaration

Task<bool[]> Exist((ITechObjectType ObjectType, string ObjectName)[] objectsNames, CancellationToken cancellationToken)

Parameters

Type	Name	Description
(ITechObjectType ObjectType, string ObjectName)[]	objectsNames	Перечень типов и наименований объектов.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<bool[]>	Массив признаков существования объекта в том же порядке, что и входной массив.

Exists(ITechObjectType, string, CancellationToken)

Вычисляет существование в базе данных объекта с заданным наименованием.

Declaration

Task<bool> Exists(ITechObjectType type, string name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObjectType	type	Тип объекта.
string	name	Наименование объекта.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<bool>	True - если объект с заданным наименованием найден.

GetAllByType(ITechObjectType, IEnumerable<(string Name, string Value)>, CancellationToken)

Возвращает все объекты заданного типа, имеющие указанные значения атрибутов.

Declaration

Task<IReadOnlyList<ITechObject>> GetAllByType(ITechObjectType type, IEnumerable<(string Name, string Value)> attributes, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObjectType	type	Тип объекта.
IEnumerable<(string Name, string Value)>	attributes	Атрибуты объекта (пары имя атрибута + значение). Может использоваться маска ввода - символ "_" заменяет любой одиночный символ, символ "%" заменяет последовательность символов.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechObject>>	Список найденных по условиям объектов.

GetAllByType(ITechObjectType, CancellationToken)

Возвращает все объекты с указанным типом.

Declaration

Task<IReadOnlyList<ITechObject>> GetAllByType(ITechObjectType type, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObjectType	type	Тип объекта.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechObject>>	Список объектов определённого типа.

GetAllByTypes(IEnumerable<ITechObjectType>, string?, CancellationToken)

Возвращает все объекты с указанными типами.

Declaration

Task<IReadOnlyList<ITechObject>> GetAllByTypes(IEnumerable<ITechObjectType> types, string? name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
IEnumerable<ITechObjectType>	types	Тип объекта.
string	name	Ключевой атрибут объекта - имя. Может использоваться маска ввода - символ "_" заменяет любой одиночный символ, символ "%" заменяет последовательность символов.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechObject>>	Список объектов определённых типов.

GetById(int, CancellationToken)

Возвращает объект по идентификатору.

Declaration

Task<ITechObject?> GetById(int id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
int	id	Идентификатор объекта.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<ITechObject>	Объект с указанным идентификатором или null.

GetByIds(IEnumerable<int>, CancellationToken)

Возвращает объекты по идентификаторам.

Declaration

Task<IReadOnlyList<ITechObject>> GetByIds(IEnumerable<int> ids, CancellationToken cancellationToken)

Parameters

Type	Name	Description
IEnumerable<int>	ids	Идентификаторы объектов.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechObject>>	Список объектов с указанными идентификаторами или null.

GetObjectsCreationActionInfo(IReadOnlyList<int>, CancellationToken)

Получает информацию о создании объектов.

Declaration

Task<IReadOnlyCollection<TechObjectCreationActionInfoResult>> GetObjectsCreationActionInfo(IReadOnlyList<int> objectsIds, CancellationToken cancellationToken)

Parameters

Type	Name	Description
IReadOnlyList<int>	objectsIds	Список идентификаторов объектов.
CancellationToken	cancellationToken	Признак отмены.

Returns

Type	Description
Task<IReadOnlyCollection<TechObjectCreationActionInfoResult>>	Список с информацией о создании объектов.