IRdsDictionary

Assembly: Rds;

Namespace: Prognoz.Platform.Interop.Rds;

Description

The IRdsDictionary interface contains properties and methods of the MDM dictionary repository object.

Inheritance hierarchy

IRdsDictionary

Comments

IRdsDictionary is also used to work with the repository object Table MDM dictionary. Table MDM dictionary uses a separate table to store information. It is created automatically on dictionary creating. The table fields correspond to the dictionary attributes.

It is prohibited to execute the following applied operations with the system Dependent objects of a table MDM dictionary (main MDM table, procedures): manually add or remove fields in the database table, and so on. Such operations may influence a table MDM dictionary feature. Applied operations with child objects of table MDM dictionary prevent the dictionary from working, and it is no longer supported.

MDM dictionaries support element keys in the range 0-2 billion.

Table MDM dictionary constraints

Interfaces available for working with a table MDM dictionary

When a new MDM dictionary is created, it works from the start and is ready to use.

When a new table MDM dictionary is created, it may require to specify the database, in which a dictionary table will be created, in the Database property. By default, a database is sued that is set for the repository as default database.

Various properties of the IRdsDictionary interface enable the user to expand functionality of created dictionaries.

Properties

	Property name	Brief description
	AbacSecured	The AbacSecured property determines whether table MDM dictionary elements have attribute-based access permissions.
	Attributes	The Attributes property returns a collection of MDM dictionary attributes.
	Compound	The Compound property returns whether MDM dictionary is composite.
	Database	The Database property determines a database that stores dictionary data.
	DatabaseInstance	The DatabaseInstance property returns contents of the database that stores MDM dictionary data.
	DefaultElementKey	The DefaultElementKey property determines a default element by its key.
	DerivedFrom	The property is under development.
	Distributed	The Distributed property determines whether an attribute that contains a unique identifier of elements in the MDM dictionary is available.
	DynamicDimInstance	The DynamicDimInstance property determines whether dynamic loading of the MDM dictionary elements is used.
	EditElementCallbackFore	The EditElementCallbackFore property sets a method to replace standard view of the Dictionary Element Properties dialog box with the custom one in the desktop application.
	EditElementCallbackJS	The EditElementCallbackJS property sets JS function to replace standard view of the Dictionary Element Properties dialog box with the custom one in the web application.
	ExportSchemas	The ExportSchemas property returns a collection of export schemes of the MDM dictionary.
	HasDimMultipleValues	The HasDimMultipleValues property determines whether multiple values are loaded to IDimAttributeInstance.
	HasMandatoryAccess	The HasMandatoryAccess property determines whether mandatory access control is used for elements of the MDM dictionary.
	Hierarchical	The Hierarchical property determines whether the dictionary is hierarchical.
	ImportSchema	The ImportSchema property returns the first import scheme from a collection.
	ImportSchemas	The ImportSchemas property returns a collection of MDM dictionary import schemes.
	IsBigDictionary	The IsBigDictionary property determines whether the dictionary supports a large number of elements.
	Levels	The Levels property returns a collection of MDM dictionary levels.
	Links	The Links property returns a collection of MDM dictionary links.
	ManageVisibility	The ManageVisibility property determines whether MDM dictionary elements are hidden.
	NonUniqueKeys	The NonUniqueKeys property returns a collection of MDM dictionary non-unique keys.
	Params	The Params property returns a collection of MDM dictionary parameters.
	RdsDatabaseInstance	The RdsDatabaseInstance property returns data of the MDM repository that stores a dictionary.
	Secured	The Secured property determines whether access permissions to MDM dictionary elements are controlled.
	Segments	The Segments property returns a collection of MDM dictionary segments.
	TableName	The TableName property determines name of the table that stores dictionary data.
	TimeDependency	The TimeDependency property determines a mode, in which elements actual period is formed.
	TimeDependent	The TimeDependent property determines whether dictionary elements are changed in time.
	Translations	The Translations property returns a collection of settings that contain translation parameters of the MDM dictionary into different languages.
	Type	The Type property returns a type of the MDM dictionary.
	UniqueKeys	The UniqueKeys property returns a collection of MDM dictionary unique keys.

Methods

	Method name	Brief description
	AssignStructure	The AssignStructure method assigns MDM dictionary structure in accordance with specified dictionary structure.
	HasDefaultElement	The HasDefaultElement method determines whether there is a default element in MDM dictionary.
	Open	The Open method opens an MDM dictionary.
	ResetDefaultElement	The ResetDefaultElement method resets setting of default element.
	UpdateElementDependencies	The UpdateElementDependencies method updates a link to the Link element by the key.
	UpdateElementsDependencies	The UpdateElementsDependencies method updates all links to the Link element.
	UpdateSequence	The UpdateSequence method updates sequence.

See also:

Rds Assembly Interfaces | MDM Dictionaries