A Sandcastle Documented Class Library

# HierarchyEntityData Class

The data contract class for UserHierarchy class.
Inheritance Hierarchy
System
Object
Dundas.BI.WebApi.Models
BaseDataContract
Dundas.BI.WebApi.Models
FileData
Dundas.BI.WebApi.Models
EntityBaseData
Dundas.BI.WebApi.Models
HierarchyEntityData
Dundas.BI.WebApi.Models
RaggedHierarchyEntityData

Namespace: Dundas.BI.WebApi.Models
Assembly: Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    [DataContractAttribute]
    public class HierarchyEntityData : EntityBaseData

    <DataContractAttribute>
    Public Class HierarchyEntityData
    	Inherits EntityBaseData

    [DataContractAttribute]
    public ref class HierarchyEntityData : public EntityBaseData

    [<DataContractAttribute>]
    type HierarchyEntityData =
        class
            inherit EntityBaseData
        end

The HierarchyEntityData type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| HierarchyEntityData | Initializes a new instance of the HierarchyEntityData class.

Top
Properties

| Name | Description
--- | --- | ---
| AllMember | Gets the "All Values Grouped" member when the hierarchy is aggregatable; otherwise it return .
| AttributeHierarchies | Gets the supported attribute hierarchies for the current instance.
| Caption | Gets or sets the caption.
| Category | Gets the potential analysis category for the current instance.
| CheckedOutTo | Gets information about the account to which the object is checked out. (Inherited from FileData.)
| ChildCount | Gets the number of direct children contained in the entry. (Inherited from FileData.)
| CompatibleUniqueName | Gets the compatible unique name. This property allows grouping together compatible hierarchies across multiple IAnalysisStructures.
| CreatedBy | Gets the account information for the user which created the entry. (Inherited from FileData.)
| CreatedTime | Gets the time, in coordinated universal time (UTC), at which the entry was created. (Inherited from FileData.)
| CurrentRevision | Gets the highest revision number associated with this file. (Inherited from FileData.)
| Description | Gets an optional description associated with the entry. (Inherited from FileData.)
| EffectiveCallerPrivileges | Gets the effective caller privileges so the UI can do checks based on this. (Inherited from FileData.)
| EntityId | Gets the parent entity ID.
| Files | Gets the files contained in the entry. (Inherited from FileData.)
| Folders | Gets the folders contained in the entry. (Inherited from FileData.)
| FriendlyFullName | Gets the full path of the entry (friendly). (Inherited from FileData.)
| FriendlyLocation | Gets the location of the entry (friendly representation). (Inherited from FileData.)
| FriendlyLocationElements | Gets a read-only list of distinct path elements which compose FriendlyLocation. (Inherited from FileData.)
| FriendlyName | Gets the name of the entry (friendly representation). (Inherited from FileData.)
| FullName | Gets the full path of the entry. (Inherited from FileData.)
| HasAttributeHierarchies | Gets a value indicating whether this instance has attribute hierarchies defined within.
| Id | Gets the unique identifier of the entry. (Inherited from FileData.)
| InheritedTags | Gets the inherited tags, if there are any. (Inherited from FileData.)
| IsCheckedOut | Gets a value indicating whether the file is checked out. (Inherited from FileData.)
| IsCheckedOutToCaller | Gets a value indicating whether the file is checked out to caller. (Inherited from FileData.)
| IsInactive | Gets a value indicating whether the file is inactive. (Inherited from FileData.)
| IsProtected | Gets a value indicating whether the entry is protected. (Inherited from FileData.)
| IsRecycled | Gets a value indicating whether the entry is recycled. (Inherited from FileData.)
| IsSubentry | Gets a value indicating whether the entry is contained by a File. (Inherited from FileData.)
| IsTimeHierarchy | Gets a value indicating whether this instance is a time hierarchy.
| IsTransient | Gets a value indicating whether the file is transient. (Inherited from FileData.)
| LastCheckedInTime | Gets the time when the file was last checked in. (Inherited from FileData.)
| LastModifiedTime | Gets the time, in coordinated universal time (UTC), at which the entry was last modified. (Inherited from FileData.)
| Levels | Gets the hierarchy levels.
| Location | Gets the location of the entry. (Inherited from FileData.)
| Metadata | Gets arbitrary metadata associated with the entry. (Inherited from FileData.)
| Name | Gets the name of the entry. (Inherited from FileData.)
| ObjectType | Gets the type of the entry. (Inherited from FileData.)
| Overwrite | Gets or sets a value indicating whether the file should be overwritten if the file was already created. (Inherited from FileData.)
| Parameters | Gets the public parameter collection, if the hierarchy either exposes inherited parameters or if it allows parameter definition.
| ParentId | Gets the ID of the item's parent. (Inherited from FileData.)
| PrimaryEntryId | Gets the ID of the primary object which contains the entry. (Inherited from FileData.)
| PrivilegeInheritanceBehavior | Gets the privilege inheritance behavior. (Inherited from FileData.)
| Privileges | Gets the entry's privilege assignments. (Inherited from FileData.)
| ProjectId | Gets the ID of the project containing the entry. (Inherited from FileData.)
| Revision | Gets the revision of this instance. (Inherited from EntityBaseData.)
| SortPolicy | Gets the sorting behavior defined for the hierarchy.
| Subtype | Gets or sets the type-specific sub-type of the entry. (Inherited from FileData.)
| Tags | Gets a collection of explicit tags associated with the entry. (Inherited from FileData.)
| TenantId | Gets the ID of the tenant associated with the entry. (Inherited from FileData.)
| UIClassName | Gets or sets the name of the UI class (used for auto de-serialization). (Inherited from BaseDataContract.)
| UndoContext | If available, the current undo context for the entity. (Inherited from EntityBaseData.)
| UniqueName | Gets the object unique name.
| Warnings | Gets the warnings for the current instance, as well as for any dependency objects. (Inherited from FileData.)

Top
Methods

| Name | Description
--- | --- | ---
| ToDataContractMappings | The mapping between the business object and the DTO.

Top
Extension Methods

| Name | Description
--- | --- | ---
| SetUIClassName | Sets the name of the file data UI class. (Defined by ModelDataExtensions.)

Top
See Also

#### Reference

Dundas.BI.WebApi.Models Namespace