IMetabase

Сборка: Metabase;

Пространство имен: Prognoz.Platform.Interop.Metabase;

Описание

Интерфейс IMetabase содержит свойства и методы коллекции объектов репозитория.

Иерархия наследования

          INamedEntityModel

          IMetabase

Комментарии

Данный интерфейс содержит основные свойства и методы для управления объектами репозитория, а также для доступа к различным инструментам продукта «Форсайт. Аналитическая платформа».

Если подключение к репозиторию осуществляется в прикладном коде, то метод IMetabaseDefinition.Open или IMetabaseDefinition.OpenDefault вернёт доступ к репозиторию. Для получения доступа к репозиторию, подключение к которому уже осуществлено из интерфейса настольного приложения используйте статическое свойство Active класса MetabaseClass.

Свойства

	Имя свойства	Краткое описание
	Cache	Свойство Cache возвращает содержимое кэша репозитория.
	CacheAutoClear	Свойство CacheAutoClear определяет, используется ли при работе в репозитории режим автоматической очистки кэша.
	Classes	Свойство Classes возвращает коллекцию классов объектов репозитория.
	CompileAssemblyOnly	Свойство CompileAssemblyOnly определяет признак возможности компиляции форм/модулей вне сборок.
	CurrentDomainSubjectAddState	Свойство CurrentDomainSubjectAddState определяет настройки добавления доменных субъектов безопасности.
	CurrentLocale	Свойство CurrentLocale определяет текущий язык репозитория.
	DefaultLocale	Свойство DefaultLocale определяет язык репозитория по умолчанию.
	DeferredLoading	Свойство DeferredLoading возвращает признак наличия включенной отложенной загрузки объектов репозитория.
	Definition	Свойство Definition возвращает описание текущего репозитория, хранящееся в менеджере репозиториев.
	ElementDependenciesDatabase	Свойство ElementDependenciesDatabase возвращает объект, предназначенный для работы с зависимостями объектов от элементов справочников НСИ.
	ElementDependentsDatabase	Свойство ElementDependentsDatabase возвращает ссылки элементов справочников на объекты репозитория.
	ExceptionHandler	Свойство ExceptionHandler определяет обработчик исключительных ситуаций, который будет использоваться при работе в репозитории.
	ExceptionMailAddress	Свойство ExceptionMailAddress определяет адрес электронной почты, который будет подставляться при отправке сообщений об ошибках платформы.
	IsScreenshotSupported	Свойство IsScreenshotSupported возвращает признак поддержки отображения объектов в виде огромных значков.
	IsShared	Свойство IsShared возвращает признак наличия настроек для работы с системой управления версиями.
	Item	Свойство Item возвращает описание объекта репозитория по ключу.
	ItemById	Свойство ItemById возвращает описание объекта репозитория по идентификатору.
	ItemByIdNamespace	Свойство ItemByIdNamespace возвращает описание объекта, содержащегося в каком-либо объекте-контейнере.
	LogonSession	Свойство LogonSession возвращает информацию о текущей сессии с репозиторием.
	Mode	Свойство Mode определяет, каким образом произошло подключение к репозиторию.
	PrivateFolder	Свойство PrivateFolder возвращает личную папку текущего пользователя.
	PrivateFolderRoot	Свойство PrivateFolderRoot возвращает корневую папку для личных папок пользователей.
	Profiles	Свойство Profiles возвращает коллекцию профилей пользователей репозитория.
	Root	Свойство Root возвращает описание корневой папки репозитория.
	Security	Свойство Security возвращает настройки менеджера безопасности текущего репозитория.
	SharePointDiscussionName	Свойство SharePointDiscussionName определяет группу обсуждения SharePoint.
	SharePointUrl	Свойство SharePointUrl определяет сайт SharePoint для обсуждения.
	SingleUserMode	Свойство SingleUserMode возвращает признак возможности работы в репозитории только под одной учетной записью.
	SpecialObject	Свойство SpecialObject определяет объект репозитория, который является специальным.
	SpecialObjects	Свойство SpecialObjects возвращает коллекцию специальных объектов репозитория.
	UseReservedKeys	Свойство UseReservedKeys определяет количество ключей, которые будут резервироваться для использования в платформе.

Свойства, унаследованные от INamedEntityModel

	Имя свойства	Краткое описание
	Id	Свойство Id возвращает идентификатор объекта.
	Key	Свойство Key возвращает ключ объекта.
	Name	Свойство Name возвращает наименование объекта.

Методы

	Имя метода	Краткое описание
	Bind	Метод Bind возвращает структуру объекта репозитория.
	CheckInEx	Метод CheckInEx осуществляет публикацию изменений группы объектов.
	CopyObject	Метод CopyObject осуществляет копирование указанного объекта.
	CreateCheckList	Метод CreateCheckList создает список, используемый для расчета и проверки контрольных сумм объектов репозитория.
	CreateCodeBlock	Метод CreateCodeBlock возвращает объект, содержащий код на Fore.
	CreateCopyInfo	Метод CreateCopyInfo позволяет создать объект для осуществления копирования по определенным параметрам.
	CreateCreateInfo	Метод CreateCreateInfo создает информацию для нового объекта.
	CreateFindInfo	Метод CreateFindInfo позволяет создать объект для осуществления поиска объектов репозитория.
	CreateObject	Метод CreateObject создает новый объект.
	CreateUpdate	Метод CreateUpdate осуществляет создание объекта обновления.
	DeleteObject	Метод DeleteObject осуществляет удаление объекта по ключу.
	DeleteObjectO	Метод DeleteObjectO осуществляет удаление ссылок на объекты репозитория.
	FetchItem	Метод FetchItem возвращает описание объекта или объекта, для которого установлен признак отложенной загрузки описания, по ключу.
	FetchItemById	Метод FetchItemByld возвращает описание объекта или объекта, для которого установлен признак отложенной загрузки описания, по идентификатору.
	FetchItems	Метод FetchItems возвращает описания объектов или объектов, для которых установлен признак отложенной загрузки описания, по ключам.
	FetchItemsById	Метод FetchItemsByld возвращает описание указанной коллекции объектов, а также загружает описания указанных связанных объектов.
	Find	Метод Find производит поиск объекта (объектов), удовлетворяющего (удовлетворяющих) условиям поиска.
	GenerateId	Метод GenerateId генерирует уникальный идентификатор в рамках текущего репозитория.
	GenerateKey	Метод GenerateKey генерирует уникальный ключ в рамках текущего репозитория.
	GetConnectedUsers	Метод GetConnectedUsers позволяет получить информацию о пользователях, подключенных к репозиторию.
	GetConnectedUsersEx	Метод GetConnectedUsersEx позволяет получить информацию об активных пользователях, подключенных к репозиторию.
	GetCurrentStamp	Метод GetCurrentStamp возвращает текущую дату и время.
	GetItems	Метод GetItems возвращает коллекцию описаний объектов по ключам.
	GetObjectKeyById	Метод GetObjectKeyById возвращает уникальный ключ объекта по его идентификатору.
	GetObjectKeyByIdNamespace	Метод GetObjectKeyByIdNamespace возвращает ключ объекта, расположенного в указанном контейнере, по его идентификатору.
	GetPendingChangesVCS	Метод GetPendingChangesVCS возвращает коллекцию объектов, извлеченных для редактирования в системе управления версиями.
	GetPendingCheckins	Метод GetPendingCheckins возвращает описание всех объектов репозитория, которые захвачены для редактирования.
	IsDisconnected	Метод IsDisconnected возвращает признак отсутствия соединения с сервером БД.
	MoveObject	Метод MoveObject осуществляет перемещение указанного объекта.
	Refresh	Метод Refresh осуществляет обновление дерева объектов текущего репозитория.
	RefreshO	Метод RefreshO осуществляет обновление репозитория по заданным параметрам.
	RequestLicense	Метод RequestLicense возвращает единицу лицензирования.
	ReserveKeys	Метод ReserveKeys резервирует указанное количество ключей для использования в аналитическом платформе.
	UndoCheckOutEx	Метод UndoCheckOutEx осуществляет отмену изменений и возвращает предыдущую версию объектов.

См. также:

Интерфейсы сборки Metabase