Interface ITechObject

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

Namespace: Ascon.Vertical.Core

Assembly: Ascon.Vertical.Core.dll

Syntax

public interface ITechObject

Properties

AccessLevel

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

Declaration

TechObjectAccessLevel AccessLevel { get; }

Property Value

Type	Description
TechObjectAccessLevel

Remarks

0 - Нет доступа, 1 – Только чтение, 2 – Чтение/запись, 3 – Полный доступ.

Attributes

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

Declaration

ITechObjectAttributesSource Attributes { get; }

Property Value

Type	Description
ITechObjectAttributesSource

CheckoutId

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

Declaration

int CheckoutId { get; }

Property Value

Type	Description
int

DisplayName

Возвращает отображаемое наименование объекта.

Declaration

string DisplayName { get; }

Property Value

Type	Description
string

ExternalId

Возвращает идентификатор внешнего источника для справочных объектов.

Declaration

string ExternalId { get; }

Property Value

Type	Description
string

FamilyId

Возвращает идентификатор семейства версий.

Declaration

int FamilyId { get; }

Property Value

Type	Description
int

Files

Возвращает перечень файлов объекта.

Declaration

ITechObjectFilesSource Files { get; }

Property Value

Type	Description
ITechObjectFilesSource

Functions

Возвращает перечень функций объекта.

Declaration

ITechObjectFunctionSource Functions { get; }

Property Value

Type	Description
ITechObjectFunctionSource

Id

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

Declaration

int Id { get; }

Property Value

Type	Description
int

IsReadOnly

Возвращает признак "Только чтение".

Declaration

bool IsReadOnly { get; }

Property Value

Type	Description
bool

LinkId

Возвращает идентификатор связи в составе родительского объекта. Может быть Null, если работа с объектом ведется без учета вхождения в состав другого объекта.

Declaration

int? LinkId { get; }

Property Value

Type	Description
int?

Links

Возвращает перечень связей объекта.

Declaration

ITechObjectLinksSource Links { get; }

Property Value

Type	Description
ITechObjectLinksSource

Name

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

Declaration

string Name { get; }

Property Value

Type	Description
string

Numerators

Возвращает перечень нумераторов объекта.

Declaration

ITechNumeratorSource Numerators { get; }

Property Value

Type	Description
ITechNumeratorSource

Permissions

Возвращает перечень прав к объекту.

Declaration

ITechObjectPermissionsSource Permissions { get; }

Property Value

Type	Description
ITechObjectPermissionsSource

Repository

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

Declaration

ITechDataRepository Repository { get; }

Property Value

Type	Description
ITechDataRepository

SecondaryViews

Возвращает перечень вторичных представлений объекта.

Declaration

ITechSecondaryViewsSource SecondaryViews { get; }

Property Value

Type	Description
ITechSecondaryViewsSource

State

Возвращает состояние объекта.

Declaration

ITechStateType State { get; }

Property Value

Type	Description
ITechStateType

Type

Возвращает тип объекта.

Declaration

ITechObjectType Type { get; }

Property Value

Type	Description
ITechObjectType

Version

Возвращает версию объекта.

Declaration

string Version { get; }

Property Value

Type	Description
string

Methods

ChangeName(string, CancellationToken)

Изменяет наименование объекта.

Declaration

Task<bool> ChangeName(string newName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	newName	Новое наименование объекта.
CancellationToken	cancellationToken	Признак отмены.

Returns

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

ChangeState(ITechStateType, CancellationToken)

Изменяет состояние объекта.

Declaration

Task<bool> ChangeState(ITechStateType newState, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechStateType	newState	Новое состояние объекта.
CancellationToken	cancellationToken	Признак отмены.

Returns

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

CreateVersion(int, CancellationToken)

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

Declaration

Task<ITechObject> CreateVersion(int versionSegmentIndexToIncrease, CancellationToken cancellationToken)

Parameters

Type	Name	Description
int	versionSegmentIndexToIncrease	Номер разряда версии, подлежащий увеличению.
CancellationToken	cancellationToken	Признак отмены.

Returns

Type	Description
Task<ITechObject>	Созданная версия объекта.

GetAllParentVersions(CancellationToken)

Возвращает список всех предыдущих версий объекта, от которых был создан текущий.

Declaration

Task<IReadOnlyList<ITechObject>> GetAllParentVersions(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Признак отмены.

Returns

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

GetAllVersions(CancellationToken)

Возвращает список всех версий объекта.

Declaration

Task<IReadOnlyList<ITechObject>> GetAllVersions(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Признак отмены.

Returns

Type	Description
Task<IReadOnlyList<ITechObject>>	Список всех версий объекта.

GetInfo(CancellationToken)

Возвращает расширенную информацию об объекте.

Declaration

Task<ITechObjectInfo> GetInfo(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Признак отмены.

Returns

Type	Description
Task<ITechObjectInfo>	Расширенная информация об объекте.

GetParentVersion(CancellationToken)

Возвращает версию объекта, из которой был создан текущий.

Declaration

Task<ITechObject?> GetParentVersion(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Признак отмены.

Returns

Type	Description
Task<ITechObject>	Версия объекта, из которой был создан текущий или null.

GetStates(CancellationToken)

Возвращает список состояний, в которые текущий пользователь может перевести заданный объект.

Declaration

Task<IReadOnlyList<ITechStateType>> GetStates(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Признак отмены.

Returns

Type	Description
Task<IReadOnlyList<ITechStateType>>	Список состояний.

Remarks

Учитываются права на перевод объекта заданного типа из состояния в состояние.

IsInstanceOf(ITechObjectType)

Определяет, является ли объект экземпляром указанного типа.

Declaration

bool IsInstanceOf(ITechObjectType type)

Parameters

Type	Name	Description
ITechObjectType	type	Тип для определения.

Returns

Type	Description
bool	true - если является, иначе - false .

IsInstanceOf(string)

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

Declaration

bool IsInstanceOf(string typeName)

Parameters

Type	Name	Description
string	typeName	Наименование типа.

Returns

Type	Description
bool	true - если является, иначе - false .

IsInstanceOfAny(IEnumerable<ITechObjectType>)

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

Declaration

bool IsInstanceOfAny(IEnumerable<ITechObjectType> types)

Parameters

Type	Name	Description
IEnumerable<ITechObjectType>	types	Список наименований типов.

Returns

Type	Description
bool	true if [is instance of any] [the specified type names]; otherwise, false .

IsInstanceOfAny(IEnumerable<string>)

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

Declaration

bool IsInstanceOfAny(IEnumerable<string> typeNames)

Parameters

Type	Name	Description
IEnumerable<string>	typeNames	Список наименований типов.

Returns

Type	Description
bool	true - если является, иначе - false .

RenumerateChildren(string?, CancellationToken)

Получает и выполняет перенумерацию дочерних связей.

Declaration

Task<List<TechObjectsLinksRenumerateResult>?> RenumerateChildren(string? filter, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	filter	Перечень используемых фильтров.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<List<TechObjectsLinksRenumerateResult>>	Описание результата выполнения перенумерации.

ToDto()

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

Declaration

TechObjectDto ToDto()

Returns

Type	Description
TechObjectDto	Сформированное описание.

ToStringAsync()

Возвращает строку, представляющую текущий объект.

Declaration

Task<string> ToStringAsync()

Returns

Type	Description
Task<string>	Строка, представляющая текущий объект.

ToStringAsync(string)

Возвращает строку, представляющую текущий объект в указанном формате.

Declaration

Task<string> ToStringAsync(string format)

Parameters

Type	Name	Description
string	format	Формат формируемой строки. Поддерживаемые форматы: T - возвращается тэгированный текст (ЕСКД), S - возвращается простой текст(ЕСТД), S1 - дополнительно к формату S всегда отображать отклонения в скобках. Если формат не указан, то используется формат T.

Returns

Type	Description
Task<string>	Строка, представляющая текущий объект в указанном формате.

VerifyAsync()

Проверяет данные объекта.

Declaration

Task<List<TechVerificationMessage>> VerifyAsync()

Returns

Type	Description
Task<List<TechVerificationMessage>>	Список сообщений проверки данных.