DimSrv

Namespace: PP.Mb;

Inheritance hierarchy

PP.Object

PP.Mb.PPService

PP.Mb.DimSrv

Description

The DimSrv class is used to work with a service for working with dictionaries.

Syntax

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

Constructor

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

Methods

  Method name Brief description
assignSelection The assignSelection method selects dictionary elements by the specified moniker.
beginBatch The beginBatch method enables batch mode of sending queries.
close The close method closes a dictionary.
copyInstance The copyInstance method copies a dictionary.
endBatch The endBatch method disables batch mode of sending queries and sends a formed batch.
execCommand The execCommand method changes selection of dictionary elements.
getAllElements The getAllElements method loads all dictionary elements.
getAllSelectedEls The getAllSelectedEls method loads all selected dictionary elements.
getChildren The getChildren method loads child elements by specified parameters.
getEls The getEls method is used to get dictionary elements by passed parameters.
getIsBatchMode The getIsBatchMode method returns whether batch mode of sending queries is enabled.
getMetadata The getMetadata method requests dictionary metadata and saves it in a model.
getPathToKey The getPathToKey method loads paths of elements with the specified keys.
getSpecialImageListUrl The getSpecialImageListUrl method returns URL to icons file.
open The open method opens a dictionary.
selectByKeys The selectByKeys method selects elements by keys.
selectGroup The selectGroup method selects group elements.
selectLevel The selectLevel method selects elements on the specified level.
send The send method requests a service for working with a metadata tree.
setCalendarPeriod The setCalendarPeriod method sets a calendar period for a dictionary.
setElementsGroup The setElementsGroup method adds an element group to dictionary metadata.
setHierarchy The setHierarchy method sets alternative dictionary hierarchy.
setSchema The setSchema method sets selection schema for dictionary.
updateStateData The updateStateData method refreshes dictionary element states.

Events

   Event name Brief description
ChildLoaded The ChildLoaded event occurs after loading dictionary children.
DimCleared The DimCleared event is occurs after clearing a dictionary.
DimClosed The DimClosed event occurs on closing a dictionary.
DimGetMetadataComplete The DimGetMetadataComplete event occurs after completing dictionary metadata loading.
DimOpened The DimOpened event occurs on opening a dictionary.
SelectionChanged The SelectionChanged event occurs after changing dictionary elements selection.

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

Id

The Id property determines a repository object identifier.

Methods inherited from the class Object

  Method name Brief description
clone The clone method creates an object copy.
dispose The dispose method deletes the component.
getHashCode The getHashCode method returns hash code of repository object.
getId The getId method returns repository object identifier.
getSettings The getSettings method returns repository object settings.
getTypeName The getTypeName method returns the name of the object type without the namespace, to which it belongs.
isEqual The isEqual method determines whether the specified object is equal to the current repository object.
isLive The isLive method determines validity of repository object.
removeAllEvents The removeAllEvents method removes all object event handlers by the specified context.
setId The setId method determines a repository object identifier.
setSettings The setSettings method determines repository object settings.
defineProps The defineProps method creates get and set methods from name array for the specified class.
keys The keys method returns array of methods and properties names for the specified object.

See also:

PP.Mb