MetaSrv

Namespace: PP.Ufe;

Inheritance hierarchy

Object

PPService

MetaSrv

Description

The MetaSrv class is used to work with metadata tree service.

Syntax

PP.initClass(PP.Ufe.MetaSrv, [PP.Mb.PPService, PP.Mb.PPSrvMixin], "PP.Ufe.MetaSrv", [PP.Mb.IElService]);

Constructor

	Constructor name	Brief description
	MetaSrv	The MetaSrv constructor creates an instance of the MetaSrv class.

Methods

	Method name	Brief description
	beginBatch	The beginBatch method enables batch mode of sending queries.
	endBatch	The endBatch method disables batch mode of sending queries and sends a formed batch.
	getAllElements	The getAllElements method returns all dimension elements.
	getChildren	The getChildren method returns child elements according to passed parameters.
	getEls	The getEls method returns dimension elements.
	getIsBatchMode	The getIsBatchMode method returns whether batch mode of sending queries is enabled.
	getMetadata	The getMetadata method returns dimension metadata.
	getPathToKey	The getPathToKey method returns hierarchy to the element with the specified key.
	getSpecialImageListUrl	The getSpecialImageListUrl method returns the URL to the icons file for metadata tree.
	send	The send method requests the service of working with metadata tree.

Events

	Event name	Brief description
	ChildLoaded	The ChildLoaded event occurs after loading of child elements to tree.
	DimCleared	The DimCleared event occurs after removing elements from dimension.
	DimClosed	The DimClosed event occurs after closing dimension connection.
	DimGetMetadataComplete	The DimGetMetadataComplete event occurs after getting of metadata is completed.
	DimOpened	The DimOpened event occurs after opening dimension connection.
	SelectionChanged	The SelectionChanged event occurs after changing dimension element selection.

Properties inherited from the class PPService

	Property name	Brief description
	PPServiceUrl	The PPServiceUrl property sets URL of Web service requests handler.

Methods inherited from the class PPService

	Method name	Brief description
	addCallbackToLastRqt	The addCallbackToLastRqt adds a handler to the last request in the queue.
	beginSyncXHR	The beginSyncXHR method enables the mode of synchronous requests for an instance of the PPService class.
	clearRequests	The clearRequests method clears the list of queued requests and removes the current request.
	endSyncXHR	The endSyncXHR method disables the mode of synchronous requests for an instance of the PPService class.
	getCurrentRequest	The getCurrentRequest method returns the current service request.
	sendRequest	The sendRequest method sends a request to web service.

Events inherited from the class PPService

	Event name	Brief description
	EndRequest	The EndRequest event occurs on finishing the repository connection.
	Error	The Error event occurs if an error occurs during repository connection.
	Executed	The Executed event occurs after executing a request to server.
	StartRequest	The StartRequest event occurs when the system starts executing a request to repository.

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.Ufe