Interface ISessionObjects

Объекты сессии API.

Inherited Members

IApiObject.GetProtectionMessage()

IApiObject.StorageType

IApiObject.WriteAccess

IApiObject.Deleted

IApiEntity.IsValid()

IApiEntity.ObjectType

IApiEntity.ObjectId

IApiEntity.Identifier

INotifyPropertyChanged.PropertyChanged

Namespace: Ascon.Polynom.Api

Assembly: Ascon.Polynom.Api.dll

Syntax

public interface ISessionObjects : IApiObject, IApiEntity, INotifyPropertyChanged

Properties

AllConcepts

Возвращает все понятия.

Declaration

IApiReadOnlyCollection<IConcept> AllConcepts { get; }

Property Value

Type	Description
IApiReadOnlyCollection<IConcept>

AllIndexableContractPropertySources

Возвращает коллекцию всех источников свойств контрактов, для которых установлен флаг "Индексируемое свойство".

Declaration

IApiReadOnlyCollection<IContractPropertySource> AllIndexableContractPropertySources { get; }

Property Value

Type	Description
IApiReadOnlyCollection<IContractPropertySource>	Коллекция источников свойств контрактов.

AllLinkDefinitions

Возвращает коллекцию всех определений связей.

Declaration

IApiReadOnlyCollection<ILinkDefinition> AllLinkDefinitions { get; }

Property Value

Type	Description
IApiReadOnlyCollection<ILinkDefinition>

AllMeasureEntities

Возвращает коллекцию всех измеряемых величин.

Declaration

IApiReadOnlyCollection<IMeasureEntity> AllMeasureEntities { get; }

Property Value

Type	Description
IApiReadOnlyCollection<IMeasureEntity>

AllPropDefGroups

Возвращает коллекцию всех групп свойств.

Declaration

IApiReadOnlyCollection<IPropDefGroup> AllPropDefGroups { get; }

Property Value

Type	Description
IApiReadOnlyCollection<IPropDefGroup>

AllPropertyDefinitions

Возвращает коллекцию всех определений свойств.

Declaration

IApiReadOnlyCollection<IPropertyDefinition> AllPropertyDefinitions { get; }

Property Value

Type	Description
IApiReadOnlyCollection<IPropertyDefinition>

AllPublicContractPropertySources

Возвращает коллекцию всех источников свойств контрактов, для которых установлен флаг "публичное".

Declaration

IApiReadOnlyCollection<IContractPropertySource> AllPublicContractPropertySources { get; }

Property Value

Type	Description
IApiReadOnlyCollection<IContractPropertySource>	Коллекция источников свойств контрактов.

AllReferences

Возвращает коллекцию справочников.

Declaration

IApiReadOnlyCollection<IReference> AllReferences { get; }

Property Value

Type	Description
IApiReadOnlyCollection<IReference>

AllRestrictedLists

Возвращает все ограничительные перечни

Declaration

IApiReadOnlyCollection<IRestrictedList> AllRestrictedLists { get; }

Property Value

Type	Description
IApiReadOnlyCollection<IRestrictedList>

EventLogRoot

Журнал событий.

Declaration

IEventLogRoot EventLogRoot { get; }

Property Value

Type	Description
IEventLogRoot

FormulaCatalog

Возвращает каталог формул.

Declaration

IFormulaCatalog FormulaCatalog { get; }

Property Value

Type	Description
IFormulaCatalog

FullMetaInformation

Метаинформация API.

Declaration

IFullMetaInformation FullMetaInformation { get; }

Property Value

Type	Description
IFullMetaInformation

LinkDefCatalog

Возвращает каталог определений связей.

Declaration

ILinkDefCatalog LinkDefCatalog { get; }

Property Value

Type	Description
ILinkDefCatalog

NotificationSystem

Система уведомлений

Declaration

INotificationSystem NotificationSystem { get; }

Property Value

Type	Description
INotificationSystem

PropDefCatalog

Возвращает каталог определений свойств.

Declaration

IPropDefCatalog PropDefCatalog { get; }

Property Value

Type	Description
IPropDefCatalog

RootConcepts

Возвращает список корневых понятий.

Declaration

IApiReadOnlyCollection<IConcept> RootConcepts { get; }

Property Value

Type	Description
IApiReadOnlyCollection<IConcept>

TicketsManager

Менеджер заявок.

Declaration

ITicketsManager TicketsManager { get; }

Property Value

Type	Description
ITicketsManager

Methods

CheckModified()

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

Declaration

bool CheckModified()

Returns

Type	Description
bool	true если изменены; иначе, false.

CheckSimilarName(IPropertyOwner, string)

Проверяет, есть ли у объектов данного типа похожие имена (свойство "Наименование").

Declaration

bool CheckSimilarName(IPropertyOwner propertyOwner, string name)

Parameters

Type	Name	Description
IPropertyOwner	propertyOwner	Созданный владелец свойств (определяет тип).
string	name	Имя.

Returns

Type	Description
bool	true, если похожее имя существует, иначе false.

Remarks

Заданный владелец свойств в проверке не учитывается.

CompareLocations(string, string)

Сравнение строковых расположений объектов.

Declaration

int CompareLocations(string locationA, string locationB)

Parameters

Type	Name	Description
string	locationA	Строковое расположение объекта А.
string	locationB	Строковое расположение объекта Б.

Returns

Type	Description
int	-1, если строковые расположения ведут к разным объектам; 0, если строковые расположения ведут к одному объекту по одинаковым путям; 1, если строковые расположения ведут к одному объекту по разным путям.

CompleteSubscribe()

Завершение массовой подписки сущностей API.

Declaration

void CompleteSubscribe()

Remarks

Должна предваряться вызовом PrepareSubscribe.

CreateClassificationTree(ClassificationTreeOptions)

Создает дерево классификации.

Declaration

IClassificationTree CreateClassificationTree(ClassificationTreeOptions options = ClassificationTreeOptions.Default)

Parameters

Type	Name	Description
ClassificationTreeOptions	options	Опции дерева.

Returns

Type	Description
IClassificationTree	Созданное дерево классификации.

CreateCompatibilityCondition(ILinkDefinitionEnd)

Создаёт и возвращает условие совместимости.

Declaration

ICompatibilityConditionForPropValue CreateCompatibilityCondition(ILinkDefinitionEnd linkDefinitionEnd)

Parameters

Type	Name	Description
ILinkDefinitionEnd	linkDefinitionEnd	Конец связи.

Returns

Type	Description
ICompatibilityConditionForPropValue	Условие совместимости.

CreateCompatibilityCondition(ILinkDefinitionEnd, IElement)

Создаёт и возвращает условие совместимости.

Declaration

ICompatibilityConditionForElement CreateCompatibilityCondition(ILinkDefinitionEnd linkDefinitionEnd, IElement element)

Parameters

Type	Name	Description
ILinkDefinitionEnd	linkDefinitionEnd	Конец связи.
IElement	element	Объект.

Returns

Type	Description
ICompatibilityConditionForElement	Условие совместимости.

CreateComplexCondition(IntersectionType, IEnumerable<ICondition>, Guid?, ObjectStorageType)

Создает сложное условие.

Declaration

IComplexCondition CreateComplexCondition(IntersectionType intersectionType, IEnumerable<ICondition> conditions = null, Guid? id = null, ObjectStorageType storageType = ObjectStorageType.Transient)

Parameters

Type	Name	Description
IntersectionType	intersectionType	Признак сложения подусловий (И/ИЛИ).
IEnumerable<ICondition>	conditions	Подусловия.
Guid?	id	Уникальный идентификатор.
ObjectStorageType	storageType	Тип хранения.

Returns

Type	Description
IComplexCondition	Созданное сложное условие.

CreateConcept(string, string, IConcept, string, Guid?, ObjectStorageType)

Создает понятие.

Declaration

IConcept CreateConcept(string name, string code = null, IConcept superConcept = null, string description = null, Guid? id = null, ObjectStorageType storageType = ObjectStorageType.Persistent)

Parameters

Type	Name	Description
string	name	Имя понятия.
string	code	Код понятия.
IConcept	superConcept	Супер-понятие.
string	description	Описание.
Guid?	id	Уникальный идентификатор.
ObjectStorageType	storageType	Тип хранения.

Returns

Type	Description
IConcept	Созданный понятие.

CreateConceptClassificationTree(ConceptClassificationTreeOptions)

Создает дерево классификации понятий.

Declaration

IConceptClassificationTree CreateConceptClassificationTree(ConceptClassificationTreeOptions options = ConceptClassificationTreeOptions.Default)

Parameters

Type	Name	Description
ConceptClassificationTreeOptions	options	Опции.

Returns

Type	Description
IConceptClassificationTree	Созданное дерево классификации понятий.

CreateConceptPropertySourceTree(IEnumerable<IPropertyOwnerScope>, ConceptPropertySourcesTreeOptions, IEnumerable<IConcept>, IEnumerable<PropertyType>)

Создает дерево понятий и их свойств.

Declaration

IConceptPropertySourceTree CreateConceptPropertySourceTree(IEnumerable<IPropertyOwnerScope> scopes = null, ConceptPropertySourcesTreeOptions options = ConceptPropertySourcesTreeOptions.Default, IEnumerable<IConcept> exceptConcepts = null, IEnumerable<PropertyType> allowedPropertyTypes = null)

Parameters

Type	Name	Description
IEnumerable<IPropertyOwnerScope>	scopes	Области.
ConceptPropertySourcesTreeOptions	options	Опции дерева.
IEnumerable<IConcept>	exceptConcepts	Понятия, которые будут исключены из дерева.
IEnumerable<PropertyType>	allowedPropertyTypes	Допустимые типы свойств

Returns

Type	Description
IConceptPropertySourceTree	Созданное дерево понятий и их свойств.

CreateEventLogTree()

Создает дерево событий из журнала событий.

Declaration

IEventLogTree CreateEventLogTree()

Returns

Type	Description
IEventLogTree	Созданное дерево событий.

CreateFormulaTree(FormulaTreeOptions)

Создает дерево формул.

Declaration

IFormulaTree CreateFormulaTree(FormulaTreeOptions options = FormulaTreeOptions.Default)

Parameters

Type	Name	Description
FormulaTreeOptions	options	Опции.

Returns

Type	Description
IFormulaTree	Созданное дерево формул.

CreateLinkDefClassificationTree(LinkDefClassificationTreeOptions, ISet<LinkEndMultiplicity>)

Создает классификации определений связей.

Declaration

ILinkDefClassificationTree CreateLinkDefClassificationTree(LinkDefClassificationTreeOptions options = LinkDefClassificationTreeOptions.Default, ISet<LinkEndMultiplicity> showMultiplicities = null)

Parameters

Type	Name	Description
LinkDefClassificationTreeOptions	options	Опции.
ISet<LinkEndMultiplicity>	showMultiplicities	Отображаемые множественности.

Returns

Type	Description
ILinkDefClassificationTree	Созданное дерево классификации определений связей.

CreateLinkableEndsTree(IEnumerable<IPropertyOwnerScope>, LinkDefClassificationTreeOptions, ISet<LinkEndMultiplicity>)

Создает дерево концов связей объектов в указанных областях.

Declaration

ILinkableEndsTree CreateLinkableEndsTree(IEnumerable<IPropertyOwnerScope> scopes, LinkDefClassificationTreeOptions options = LinkDefClassificationTreeOptions.Default, ISet<LinkEndMultiplicity> showMultiplicities = null)

Parameters

Type	Name	Description
IEnumerable<IPropertyOwnerScope>	scopes	Области объектов, для которых нужно построить дерево.
LinkDefClassificationTreeOptions	options	Опции.
ISet<LinkEndMultiplicity>	showMultiplicities	Отображаемые множественности.

Returns

Type	Description
ILinkableEndsTree	Созданное дерево концов связей.

CreateLinksTree(IEnumerable<IPropertyOwnerScope>, IEnumerable<ILinkDefinitionEnd>, ElementLinksTreeOptions)

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

Declaration

IElementLinksTree CreateLinksTree(IEnumerable<IPropertyOwnerScope> scopes, IEnumerable<ILinkDefinitionEnd> linkDefinitionEnds = null, ElementLinksTreeOptions options = ElementLinksTreeOptions.Default)

Parameters

Type	Name	Description
IEnumerable<IPropertyOwnerScope>	scopes	Область объектов, для которых строится дерево связанных с ними объектов.
IEnumerable<ILinkDefinitionEnd>	linkDefinitionEnds	Концы типов связей, дерево будет строиться только для указанных концов, если null, тогда для всех.
ElementLinksTreeOptions	options	Опции.

Returns

Type	Description
IElementLinksTree	Созданное дерево связанных объектов.

CreateMeasureClassificationTree()

Создает дерево классификации единиц измерений.

Declaration

IMeasureClassificationTree CreateMeasureClassificationTree()

Returns

Type	Description
IMeasureClassificationTree	Созданное дерево классификации единиц измерений.

CreateMeasureEntity(string, string, string, Guid?, ObjectStorageType)

Создает измеряемую величину.

Declaration

IMeasureEntity CreateMeasureEntity(string name, string code = null, string description = null, Guid? id = null, ObjectStorageType storageType = ObjectStorageType.Persistent)

Parameters

Type	Name	Description
string	name	Имя измеряемой величины.
string	code	Идентификатор ЕдИзм.
string	description	Описание.
Guid?	id	Уникальный идентификатор.
ObjectStorageType	storageType	Тип хранения.

Returns

Type	Description
IMeasureEntity	Созданная измеряемая величина.

CreateNamedPropertyOwnerScope(IPropertyOwnerScope, string)

Создает именованную область элементов.

Declaration

INamedPropertyOwnerScope CreateNamedPropertyOwnerScope(IPropertyOwnerScope scope, string name = null)

Parameters

Type	Name	Description
IPropertyOwnerScope	scope	Другая область.
string	name	Имя области.

Returns

Type	Description
INamedPropertyOwnerScope	Созданная область элементов.

CreateNamedPropertyOwnerScope(IEnumerable<IPropertyOwner>, string)

Создает именованную область элементов.

Declaration

INamedPropertyOwnerScope CreateNamedPropertyOwnerScope(IEnumerable<IPropertyOwner> owners, string name = null)

Parameters

Type	Name	Description
IEnumerable<IPropertyOwner>	owners	Элементы, помещаемые в создаваемую область.
string	name	Имя области.

Returns

Type	Description
INamedPropertyOwnerScope	Созданная область элементов.

CreatePropDefClassificationTree(PropDefClassificationTreeOptions, IEnumerable<PropertyType>)

Создает дерево классификации определений свойств.

Declaration

IPropDefClassificationTree CreatePropDefClassificationTree(PropDefClassificationTreeOptions options = PropDefClassificationTreeOptions.Default, IEnumerable<PropertyType> allowedPropertyTypes = null)

Parameters

Type	Name	Description
PropDefClassificationTreeOptions	options	Опции дерева.
IEnumerable<PropertyType>	allowedPropertyTypes	Допустимые типы свойств

Returns

Type	Description
IPropDefClassificationTree	Созданное дерево классификации определений свойств.

CreateReference(string, int?, Guid?, ObjectStorageType, Guid?, Guid?)

Создает справочник.

Declaration

IReference CreateReference(string name, int? iconCode = null, Guid? id = null, ObjectStorageType storageType = ObjectStorageType.Persistent, Guid? documentCatalogId = null, Guid? viewpointCatalogId = null)

Parameters

Type	Name	Description
string	name	Название справочника.
int?	iconCode	Код иконки.
Guid?	id	Уникальный идентификатор.
ObjectStorageType	storageType	Тип хранения.
Guid?	documentCatalogId	Идентификатор каталога документов.
Guid?	viewpointCatalogId	Идентификатор каталога представлений.

Returns

Type	Description
IReference	Созданный справочник.

CreateRestrictedList(string, string)

Создает элемент ограничительного перечня.

Declaration

IRestrictedList CreateRestrictedList(string name, string code = null)

Parameters

Type	Name	Description
string	name	Название элемента ограничительного перечня.
string	code	Код.

Returns

Type	Description
IRestrictedList	Элемент ограничительного перечня

CreateScopeClassificationTree(IEnumerable<IPropertyOwnerScope>, ClassificationTreeOptions)

Создает дерево классификации, отфильтрованное по областям.

Declaration

IScopeClassificationTree CreateScopeClassificationTree(IEnumerable<IPropertyOwnerScope> scopes, ClassificationTreeOptions options = ClassificationTreeOptions.ShowElements)

Parameters

Type	Name	Description
IEnumerable<IPropertyOwnerScope>	scopes	Области.
ClassificationTreeOptions	options	Опции дерева.

Returns

Type	Description
IScopeClassificationTree	Созданное дерево.

CreateScopeTree(ScopeTreeKind, ILinkDefinitionEnd, ScopeTreeOptions)

Создает дерево областей.

Declaration

IScopeTree CreateScopeTree(ScopeTreeKind kind, ILinkDefinitionEnd linkDefinitionEnd = null, ScopeTreeOptions options = ScopeTreeOptions.Default)

Parameters

Type	Name	Description
ScopeTreeKind	kind	Вид дерева.
ILinkDefinitionEnd	linkDefinitionEnd	Конец связи.
ScopeTreeOptions	options	Опции.

Returns

Type	Description
IScopeTree	Созданное дерево областей.

CreateSecurityTree()

Создает дерево безопасности.

Declaration

ISecurityTree CreateSecurityTree()

Returns

Type	Description
ISecurityTree	Созданное дерево безопасности.

CreateSimpleCondition(IContract, IPropertyDefinition, int, IPropertyValueData, ILinkDefinitionEnd, int, Guid?, ObjectStorageType)

Создает простое условие.

Declaration

ISimpleCondition CreateSimpleCondition(IContract contract, IPropertyDefinition definition, int operation, IPropertyValueData data, ILinkDefinitionEnd linkDefinitionEnd = null, int options = 0, Guid? id = null, ObjectStorageType storageType = ObjectStorageType.Transient)

Parameters

Type	Name	Description
IContract	contract	Контракт, по которому идет поиск (если null, поиск идет во всех контрактах с данным определением свойства).
IPropertyDefinition	definition	Определение свойства.
int	operation	Операция.
IPropertyValueData	data	Значение.
ILinkDefinitionEnd	linkDefinitionEnd	Описание конца связи.
int	options	Опции операции.
Guid?	id	Уникальный идентификатор.
ObjectStorageType	storageType	Тип хранения.

Returns

Type	Description
ISimpleCondition	Созданное простое условие.

CreateSimpleCondition(ISearchConditionTargetQualifier, int, IPropertyValueData, int, Guid?, ObjectStorageType)

Создает простое условие.

Declaration

ISimpleCondition CreateSimpleCondition(ISearchConditionTargetQualifier searchConditionTargetQualifier, int operation, IPropertyValueData data, int options = 0, Guid? id = null, ObjectStorageType storageType = ObjectStorageType.Transient)

Parameters

Type	Name	Description
ISearchConditionTargetQualifier	searchConditionTargetQualifier	Источник свойства.
int	operation	Операция.
IPropertyValueData	data	Значение.
int	options	Опции.
Guid?	id	Уникальный идентификатор.
ObjectStorageType	storageType	Тип хранения.

Returns

Type	Description
ISimpleCondition	Созданное простое условие.

CreateWideOperation()

Создает массовую операцию.

Declaration

IWideOperation CreateWideOperation()

Returns

Type	Description
IWideOperation	Массовая операция.

ExportMeasurementsToXml()

Экспортирует все единицы измерения в формат XML.

Declaration

string ExportMeasurementsToXml()

Returns

Type	Description
string	Строка XML с единицами измерения.

Get(ApiObjectIdentifier)

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

Declaration

IApiObject Get(ApiObjectIdentifier objectIdentifier)

Parameters

Type	Name	Description
ApiObjectIdentifier	objectIdentifier	Полный уникальный идентификатор объекта.

Returns

Type	Description
IApiObject	Объект (или null, если объект не найден).

GetActiveTransaction()

Возвращает активную транзакцию.

Declaration

ITransaction GetActiveTransaction()

Returns

Type	Description
ITransaction	Активная транзакция (или null, если активной транзакции нет).

GetByCode<T>(string)

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

Declaration

T GetByCode<T>(string code) where T : class, ICodeableApiObject

Parameters

Type	Name	Description
string	code	Код-идентификатор объекта.

Returns

Type	Description
T	Объект (или null, если объект не найден).

Type Parameters

Name	Description
T	Тип искомого объекта.

GetByUniqueId(string)

Возвращает элемент по заданному уникальному идентификатору.

Declaration

IElement GetByUniqueId(string uniqueId)

Parameters

Type	Name	Description
string	uniqueId	Уникальный идентификатор.

Returns

Type	Description
IElement	Объект (или null, если объект не найден).

GetKnownConcept(KnownConceptKind)

Возвращает известное системе понятие.

Declaration

IConcept GetKnownConcept(KnownConceptKind conceptKind)

Parameters

Type	Name	Description
KnownConceptKind	conceptKind	Вид известного понятия.

Returns

Type	Description
IConcept	Известное понятие.

GetKnownLinkDefinition(KnownLinkDefinitionKind)

Возвращает известное системе определение связи.

Declaration

ILinkDefinition GetKnownLinkDefinition(KnownLinkDefinitionKind linkKind)

Parameters

Type	Name	Description
KnownLinkDefinitionKind	linkKind	Вид известного определения связи.

Returns

Type	Description
ILinkDefinition	Известное определение связи.

GetKnownPermission(KnownPermissionKind)

Возвращает известное системе разрешение.

Declaration

IPermission GetKnownPermission(KnownPermissionKind permissionKind)

Parameters

Type	Name	Description
KnownPermissionKind	permissionKind	Вид известного разрешения.

Returns

Type	Description
IPermission	Известное разрешение.

GetKnownPropertyDefinition(KnownPropertyDefinitionKind)

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

Declaration

IPropertyDefinition GetKnownPropertyDefinition(KnownPropertyDefinitionKind definitionKind)

Parameters

Type	Name	Description
KnownPropertyDefinitionKind	definitionKind	Вид известного определения свойства.

Returns

Type	Description
IPropertyDefinition	Известное определение свойства.

GetKnownRole(KnownRoleKind)

Возвращает известную системе роль.

Declaration

IRole GetKnownRole(KnownRoleKind roleKind)

Parameters

Type	Name	Description
KnownRoleKind	roleKind	Вид известной роли.

Returns

Type	Description
IRole	Известная роль.

GetObjects(IEnumerable<ApiObjectIdentifier>)

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

Declaration

IReadOnlyList<IApiObject> GetObjects(IEnumerable<ApiObjectIdentifier> objectIdentifiers)

Parameters

Type	Name	Description
IEnumerable<ApiObjectIdentifier>	objectIdentifiers	Идентификаторы объектов.

Returns

Type	Description
IReadOnlyList<IApiObject>	Объекты (порядок может не совпадать со списком идентификаторов).

GetObjects<T>(IEnumerable<Guid>)

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

Declaration

IReadOnlyList<T> GetObjects<T>(IEnumerable<Guid> objectIds) where T : class, IAbleToHaveId

Parameters

Type	Name	Description
IEnumerable<Guid>	objectIds	Идентификаторы объектов.

Returns

Type	Description
IReadOnlyList<T>	Объекты (порядок может не совпадать со списком идентификаторов).

Type Parameters

Name	Description
T	Тип искомого объекта.

GetObjects<T>(IEnumerable<string>)

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

Declaration

IReadOnlyList<T> GetObjects<T>(IEnumerable<string> absoluteCodes) where T : class, IAbsoluteCodeableApiObject

Parameters

Type	Name	Description
IEnumerable<string>	absoluteCodes	Полные коды-идентификаторы объектов.

Returns

Type	Description
IReadOnlyList<T>	Объекты (порядок может не совпадать со списком идентификаторов).

Type Parameters

Name	Description
T	Тип искомого объекта.

GetPropertyValues(IEnumerable<IPropertyOwner>, IEnumerable<IPropertyQualifier>)

Возвращает значения заданных свойств для заданного множества владельцев свойств.

Declaration

IReadOnlyDictionary<IPropertyOwner, IReadOnlyDictionary<IPropertyQualifier, IPropertyValue>> GetPropertyValues(IEnumerable<IPropertyOwner> propertyOwners, IEnumerable<IPropertyQualifier> propertyQualifiers)

Parameters

Type	Name	Description
IEnumerable<IPropertyOwner>	propertyOwners	Множество владельцев свойств.
IEnumerable<IPropertyQualifier>	propertyQualifiers	Множество квалификаторов свойств.

Returns

Type	Description
IReadOnlyDictionary<IPropertyOwner, IReadOnlyDictionary<IPropertyQualifier, IPropertyValue>>	Словарь назначенных значений свойств.

Remarks

Параметр propertyQualifiers может быть равен null, в этом случае будут возвращены все назначенные на владельцев значения свойств.

GetScopeTrees(ScopeTreeOptions)

Возвращает коллекцию деревьев областей с заданными опциями.

Declaration

IReadOnlyList<IScopeTree> GetScopeTrees(ScopeTreeOptions options)

Parameters

Type	Name	Description
ScopeTreeOptions	options	Опции.

Returns

Type	Description
IReadOnlyList<IScopeTree>	Коллекция созданных деревьев.

GetSqlLogins()

Возвращает логины пользователей из SQL.

Declaration

IReadOnlyList<UserFromSqlData> GetSqlLogins()

Returns

Type	Description
IReadOnlyList<UserFromSqlData>	Логины пользователей из SQL.

Get<T>(ApiObjectIdentifier)

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

Declaration

T Get<T>(ApiObjectIdentifier objectIdenitifier) where T : class, IApiObject

Parameters

Type	Name	Description
ApiObjectIdentifier	objectIdenitifier	Идентификатор объекта.

Returns

Type	Description
T	Объект (или null, если объект не найден).

Type Parameters

Name	Description
T	Тип искомого объекта.

Get<T>(Guid)

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

Declaration

T Get<T>(Guid objectId) where T : class, IAbleToHaveId

Parameters

Type	Name	Description
Guid	objectId	Идентификатор объекта.

Returns

Type	Description
T	Объект (или null, если объект не найден).

Type Parameters

Name	Description
T	Тип искомого объекта.

Get<T>(string)

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

Declaration

T Get<T>(string absoluteCode) where T : class, IAbsoluteCodeableApiObject

Parameters

Type	Name	Description
string	absoluteCode	Полный код-идентификатор объекта.

Returns

Type	Description
T	Объект (или null, если объект не найден).

Type Parameters

Name	Description
T	Тип искомого объекта.

IsValidLocation(string)

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

Declaration

bool IsValidLocation(string location)

Parameters

Type	Name	Description
string	location	Строковое расположение объекта.

Returns

Type	Description
bool	true если строка является допустимым строковым расположением объекта; иначе, false.

Remarks

Проверяется только корректность описания, сам объект может отсутствовать.

Locate(string, LocateOptions)

Находит объект по его строковому расположению.

Declaration

ILocateableApiObject Locate(string location, LocateOptions options = LocateOptions.None)

Parameters

Type	Name	Description
string	location	Строковое расположение объекта.
LocateOptions	options	Опции поиска.

Returns

Type	Description
ILocateableApiObject	Объект (или null, если объект не найден).

Remarks

Для изделий СИ, отсутствующих в хранилище, будет поднято исключение "отсутствует в хранилище".

LocateObjects(IEnumerable<string>, LocateOptions)

Находит объект по его строковому расположению.

Declaration

IReadOnlyList<ILocateableApiObject> LocateObjects(IEnumerable<string> locations, LocateOptions options = LocateOptions.None)

Parameters

Type	Name	Description
IEnumerable<string>	locations	Строковые расположения объектов.
LocateOptions	options	Опции поиска.

Returns

Type	Description
IReadOnlyList<ILocateableApiObject>	Найденные объекты.

Remarks

Для изделий СИ, отсутствующих в хранилище, будет поднято исключение "отсутствует в хранилище".

PrepareSubscribe()

Подготовка к массовой подписке сущностей API.

Declaration

void PrepareSubscribe()

Remarks

Должна завершаться вызовом CompleteSubscribe.

Refresh()

Обновляет объекты.

Declaration

void Refresh()

RepairLocation(string)

Исправляет указанный локейшен.

Declaration

string RepairLocation(string location)

Parameters

Type	Name	Description
string	location	Строковое расположение объекта.

Returns

Type	Description
string	Исправленный локейшн.

Search(string)

Возвращает область элементов по поисковой строке (полнотекстовый поиск).

Declaration

IPropertyOwnerScope Search(string searchText)

Parameters

Type	Name	Description
string	searchText	Строка поиска.

Returns

Type	Description
IPropertyOwnerScope	Область элементов.

SplitTcsLocation(string)

Разбивает локейшн ТКР.

Declaration

string SplitTcsLocation(string location)

Parameters

Type	Name	Description
string	location	Локейшн ТКР.

Returns

Type	Description
string	Разбитый локейшн.

StartTransaction()

Начинает транзакцию.

Declaration

ITransaction StartTransaction()

Returns

Type	Description
ITransaction	Созданная транзакция.

ToCollectionFromEnumerable<T>(IEnumerable<T>)

Создает коллекцию по заданному перечислению.

Declaration

IApiReadOnlyCollection<T> ToCollectionFromEnumerable<T>(IEnumerable<T> enumerable) where T : class, IApiObject

Parameters

Type	Name	Description
IEnumerable<T>	enumerable	Перечисление.

Returns

Type	Description
IApiReadOnlyCollection<T>	Коллекция.

Type Parameters

Name	Description
T	Тип коллекции.

See Also

IApiObject