Dictionary

Namespace: PP.Rds

Inheritance Hierarchy

PP.Object

Descriptor

PP.Mb.Object

Dictionary

Description

The Dictionary class implements MDM dictionary.

Syntax

PP.initClass(PP.Rds.Dictionary, PP.Mb.Object, "PP.Rds.Dictionary");

Constructor

	Constructor name	Brief description
	Dictionary	The Dictionary constructor creates an instance of MDM dictionary object.

Properties

	Property name	Brief description
	Attribute	The Attribute property determines an MDM dictionary attribute.
	ChildEls	The ChildEls property determines an array of MDM dictionary child elements.
	EditOdId	The EditOdId method determines an MDM dictionary moniker for editing dictionary structure.
	ExportSchema	The ExportSchema property determines an array of MDM dictionary export schemas.
	Filter	The Filter property sets filter for MDM dictionary elements.
	ImportSchema	The ImportSchema property determines an array of MDM dictionary import schemas.
	Link	The Link property determines a link between MDM dictionaries.
	OpenArg	The OpenArg property determines parameters that are used to open MDM dictionary.
	Parameter	The Parameter property determines an MDM dictionary parameter.
	ShowHidden	The ShowHidden property determines whether hidden elements should be displayed in an MDM dictionary.
	TotalsCount	The TotalsCount property determines total number of MDM dictionary elements.
	Translation	The Translation property determines available translation for an MDM dictionary.
	Type	The Type property determines an MDM dictionary type.

Methods

	Method name	Brief description
	clearAll	The clearAll method clears MDM dictionary data.
	clearElemsData	The clearElemsData method clears MDM dictionary elements.
	getAttributes	The getAttributes method returns an array of MDM dictionary attributes.
	getBlankElement	The getBlankElement method returns an empty element. The number and order of element attributes correspond to MDM dictionary structure.
	getDefaultTranslation	The getDefaultTranslation method returns settings of default translation for a dictionary.
	getElem	The getElem method returns MDM dictionary element by its key.
	getFilledAttributes	The getFilledAttributes method returns the array of attributes that can be viewed or edited by the user.
	getFilterChildEls	The getFilterChildEls method returns filtered child elements by key of the parent element of MDM dictionary.
	getLocales	The getLocales method returns an array of available MDM dictionary locales.
	getParameters	The getParameters method returns an array of MDM dictionary parameters in metadata format.
	hasHidden	The hasHidden method determines whether a dictionary can have hidden elements.
	hasVisibleParams	The hasVisibleParams method determines whether an MDM dictionary contains visible parameters.
	isHistorical	The isHistorical method determines whether an MDM dictionary is a version one.
	IsMultilingual	The isMultilingual method determines whether an MDM dictionary is multilingual.
	isPlain	The isPlain method determines whether an MDM dictionary element has child elements.
	moveElem	The moveItems method moves a dictionary element relative to the specified element.
	removeElements	The removeItems method removes the specified elements from MDM dictionary.
	setElement	The setElement method adds or changes an element in an MDM dictionary.

Properties inherited from the class Descriptor

	Property name	Brief description
	Class	The Class property determines a repository object objects class.
	HasChildren	The HasChildren property returns whether there are children objects.
	Id	The Id property determines repository object identifier.
	IsLink	The IsLink property returns whether this object is in another repository.
	IsShortcut	The IsShortcut property returns whether this object is a shortcut to other repository object.
	Key	The Key property determines a repository object key.
	Metadata	The Metadata property determines object metadata.
	Name	The Name property determines object name.
	ParentKey	The ParentKey property determines parent object key.
	TimeStamp	The TimeStamp property determines date and time of the last changing of the repository object.
	Visible	The Visible property returns whether a repository object is visible.

Methods inherited from the class Descriptor

	Method name	Brief description
	getClass	The getClass method returns class of repository object.
	getHasChildren	The getHasChildren method determines whether an object has child objects.
	getIsShortcut	The getIsShortcut method indicates whether an object is a shortcut.
	getParentKey	The getParentKey method returns key of the parent object.
	getState	The getState method returns object descriptor metadata: values of all properties of the Descriptor class.

Properties inherited from the class PP.Mb.Object

	Property name	Brief description
	Metabase	The Metabase property determines a repository that stores the object.
	Names	The Names property determines a collection of the object names for different languages.
	OdId	The OdId property determines a string of repository object moniker.
	Params	The Params property determines a collection of the parameters for the repository object.
	PPService	The PPService property determines a service for working with a repository object.
	ReadOnly	The ReadOnly property determines whether it is possible to edit repository object.
	ShareUrl	The ShareUrl property determines URL of repository object.

Methods inherited from the class PP.Mb.Object

	Method name	Brief description
	getReadOnly	The getReadOnly method determines whether an object is available for editing.

Properties inherited from the class Object

	Property name	Brief description
	Data	The Data property associates a random object with this component.
	Id	The Id property sets component identifier.
	Settings	The Settings property sets the component parameters.

Methods inherited from the class Object

	Method name	Brief description
	clone	The clone method creates a copy of object. It is not implemented in PP.Ui.Control.
	dispose	The dispose method deletes the component.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.

See also:

PP.Rds