IMetabaseObjectDescriptor

Assembly: Metabase;

Namespace: Prognoz.Platform.Interop.Metabase;

Description

The IMetabaseObjectDescriptor interface contains properties and methods of the repository object description.

Inheritance Hierarchy

          IMetabaseObjectDescriptor

Properties

  Property name Brief description

Attributes

The Attributes property returns system and custom attributes of repository object.

Cache

The Cache property returns a collection of the records of the repository object cache.

Children

The Children property returns a collection of descriptions of the repository child objects.

ClassId

The ClassId property returns an identifier of the object class.

CommonClassName

The CommonClassName property returns a name of the repository object class in the specified case.

Dependencies

The Dependencies property returns a collection of descriptions of the objects on which the given object depends.

Dependents

The Dependents property returns a collection of descriptions of the objects that depend on the given object.

Description

The Description property determines description (comment) of the object.

ElementDependencies

The ElementDependencies property returns information about the dependencies of this object on the elements of the MDM dictionaries.

ElementDependenciesTrackingType

The ElementDependenciesTrackingType property determines a type of the connections tracking.

ElementDependents

The ElementDependents property returns links to repository objects.

FullUrl

The FullUrl property returns the full URL address, by which the object on SharePoint Web page is published.

IconIndex

The IconIndex property returns an index of the repository object icon.

Id

The Id property determines the object's identifier.

IsCheckedOut

The IsCheckedOut property indicates whether the object is locked for editing.

IsDeferred

The IsDeferred property returns whether the object uses deferred description loading.

IsEdited

The IsEdited property returns whether the object description was edited.

IsInternal

The IsInternal property returns whether the object is the inner repository object.

IsLink

The IsLink property returns whether this object is in another repository.

IsPermanent

The IsPermanent property returns whether the repository object is permanent.

IsShared

The IsShared property returns whether the object is present in the version control system.

IsSharingSupported

The IsSharingSupported property returns whether it is possible to add the object into the version control system.

IsShortcut

The IsShortcut property returns whether this object is a shortcut to other repository object.

IsSpecial

The IsSpecial property indicates whether the object belongs to special repository objects.

Key

The Key property returns the object key.

Link

The Link property determines connection of this object with the object that has "Repository Connection" type.

LocalCheckedOutFileNames

The LocalCheckedOutFileNames property returns the string array containing a list of local files that store changed object data.

LocalFileName

The LocalFileName property returns a name, that is used to form names of the local files, in which the object data are stored.

LocalFileNames

The LocalFileNames property returns a string array that contains a list of the local files in which the object data are stored.

LocalFolderName

The LocalFolderName property returns a path to the folder on the disk in which the local files of the object, added to the version control system, are stored.

Metabase

The Metabase property returns a repository where the current object is created.

Name

The Name property determines a name of the object for the current repository language.

Names

The Names property returns a collection of the object names for different languages.

Namespace_

The Namespace_ property returns description of the object-container where the current object is stored.

Params

The Params property returns a collection of the parameters for the repository object.

Parent

The Parent property returns description of the object-owner.

ParentAllowed

The ParentAllowed property returns whether the current object can be set as the child object for the specified object.

Screenshot

The Screenshot property determines the image used on previewing repository object.

SecurityDescriptor

The SecurityDescriptor property returns the control parameters of access to the current object.

Shortcut

The Shortcut property determines description of the object to which the shortcut refers.

SourceParams

The SourceParams property returns a collection of parameters of the object to which this object refers.

Timestamp

The Timestamp property returns date and time of the last saving of the repository object.

TrackElementDependencies

The TrackElementDependencies property indicates whether the object dependencies on the MDM dictionary elements are tracked.

TrackElementDependents

The TrackElementDependents property indicates whether the objects that depend on the current object elements are tracked.

Url

The Url property defines the URL to publish the object to the SharePoint website.

VcsFileName

The VcsFileName property returns a name that is used to build names of the files, in which the object data is stored, on the versions control server.

VcsFolderName

The VcsFolderName property returns a path to the folder on the version control server in which the object files added into the version control system are stored.

Methods

  Method name Brief description

Bind

The Bind method returns an object for which the given description fits.

CheckAndAudit

The CheckAndAudit method checks the access permissions of the current user for the specified operations and writes the record into the access protocol with the specified comment.

CheckAndAuditLabel

The CheckAndAuditLabel method checks the access permissions of the current user for the specified operations and writes the record into the access protocol with the specified comment and also calculates parameters of the security label that is used when printing and exporting the repository objects.

CheckAndAuditOperation

The CheckAndAuditOperation method checks the access permissions of the current user for the specified operations and traces the result in accordance with the chosen variant of the audit.

CheckAndAuditOperationLabel

The CheckAndAuditOperationLabel method checks access permissions of the current user to execute the specified operations and writes a protocol of check result according to selected audit option and calculates parameters of security label used on printing and exporting repository objects.

CheckIn

The CheckIn method removes a lock for editing from object.

CheckInEx

The CheckInEx method publishes the changes of the object.

CheckOut

The CheckOut method locks the object for editing.

Edit

The Edit method implements editing.

EditDescriptor

The EditDescriptor method edits description of the object.

EditTemporary

The EditTemporary method opens the object for temporary change of properties.

FetchChildren

The FetchChildren method returns a collection of descriptions of the child objects taking into account the objects with deferred description loading.

FetchDependencies

The FetchDependencies method returns a collection of descriptions of the objects on which the given object depends, taking into account the objects with deferred description loading.

FetchDependents

The FetchDependents method returns a collection of descriptions of the objects that are depended on the given object, taking into account the objects with deferred description loading.

FindNext

The FindNext method searches the next object that satisfies the search conditions.

GetChangesHistory

The GetChangesHistory method returns a collection of access protocol records containing information about actions with objects during specified period of time.

GetCheckOutInfo

The GetCheckOutInfo method returns information about the object lockings.

GetExternalOpenXml

The GetExternalOpenXml method generates the XML structure containing parameters of opening object.

GetHistory

The GetHistory method returns a history of changing the object.

GetLatestVCS

The GetLatestVCS method gets information about the object from the version control system and in accordance with it updates the object in the repository.

GetSecurity

The GetSecurity method gets the access policy of the object.

HasAccess

The HasAccess method checks whether the current user has permissions to execute specified operations with object.

HasChildren

The HasChildren method returns the sign of existence of the child objects of the current objects.

HistoryVCS

The HistoryVCS method activates a viewport of the object publications history in the version control system.

IsCheckedOut

The IsCheckedOut method returns whether the object is locked for editing.

LoadChildScreenshots

The LoadChildScreenshots method caches images used on preview for all children objects.

MoveTo

The MoveTo method moves one repository object into another.

Open

The Open method opens the object and returns its data.

OpenWithParam

The OpenWithParam method opens the object with one parameter and returns its data.

SaveDescriptor

The SaveDescriptor method saves the changes of the object description.

SetIdNoCheck

The SetIdNoCheck method changes an identifier of the object without checking it against the specified format of identifiers.

Share

The Share method puts the object into the version control system.

SharePointShare

The SharePointShare share method creates the discussion on SharePoint Web page.

UndoCheckOut

The UndoCheckOut method cancels the changes and removes locking from object.

UndoCheckOutEx

The UndoCheckOutEx method cancels the changes and returns the previous version of the object.

UnShare

The method is under development.

UpdateTimestamp

The UpdateTimestamp method updates timestamp of dictionary.

See also:

Metabase Assembly Interfaces