UserHierarchy Class

Represents a user-defined categorical hierarchy.
Inheritance Hierarchy

Namespace:  Dundas.BI.Entities.UserHierarchies
Assembly:  Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.2.0.1000)
Syntax
public sealed class UserHierarchy : EntityBase, 
	IAggregatableElement, IDataCubeHierarchy, IHierarchy, IAnalysisElement, IElement, 
	IUniqueName, IDataWarnings, ISupportsAttributeHierarchies

The UserHierarchy type exposes the following members.

Constructors
  NameDescription
Public methodUserHierarchy
Initializes a new instance of the UserHierarchy class.
Top
Properties
  NameDescription
Public propertyAllChildren
Gets a flat list of all files and folders in the entry and all of the entry's descendants.
(Inherited from FileSystemEntry.)
Public propertyAllChildrenAndSelf
Gets the entry and all of its descendants.
(Inherited from FileSystemEntry.)
Public propertyAllFiles
Gets a flat list of all files in the entry and all of the entry's descendants.
(Inherited from FileSystemEntry.)
Public propertyAllFilesAndSelf
Gets the file and all of its child files.
(Inherited from File.)
Public propertyAllFolders
Gets a flat list of all folders in the entry and all of the entry's descendants.
(Inherited from FileSystemEntry.)
Public propertyAllMember
Gets the "All Values Grouped" member when the hierarchy is aggregatable; otherwise it return .
Public propertyAllMemberCaption
Gets or sets the override for "All" member caption.
Public propertyAnalysisStructure
Gets the parent analysis structure.
Public propertyAttributeHierarchies
Gets the supported attribute hierarchies for the current instance.
Public propertyCaption
Gets or sets the caption.
Public propertyCategory
Gets the potential analysis category for the current instance.
Public propertyCheckedOutTo
Gets information about the account to which the object is checked out.
(Inherited from File.)
Public propertyChildCount
Gets the number of direct children contained in the entry.
(Inherited from FileSystemEntry.)
Public propertyChildren
Gets the files and subfolders contained in the entry.
(Inherited from FileSystemEntry.)
Public propertyCompatibleUniqueName
Gets the compatible unique name. This property allows grouping together compatible hierarchies across multiple IAnalysisStructures.
Public propertyContainers
Gets the container objects used alter the presentation of the elements using a folder-like approach.
Public propertyCreatedBy
Gets the account information for the user which created the entry.
(Inherited from FileSystemEntry.)
Public propertyCreatedTime
Gets the time, in coordinated universal time (UTC), at which the entry was created.
(Inherited from FileSystemEntry.)
Public propertyCurrentRevision
Gets the highest revision number associated with this file.
(Inherited from File.)
Public propertyDataCube
Gets the data cube the hierarchy is attached to.
Public propertyDescription
Gets or sets the description.
Public propertyEntityId
Gets the parent entity ID.
Public propertyEntitySaveOptions
Gets or sets the entity save options.
(Inherited from EntityBase.)
Public propertyFiles
Gets the files contained in the entry.
(Inherited from FileSystemEntry.)
Public propertyFingerprint
Gets the fingerprint of the revision.
(Inherited from EntityBase.)
Public propertyFolders
Gets the folders contained in the entry.
(Inherited from FileSystemEntry.)
Public propertyFriendlyFullName
Gets the full path of the entry (friendly).
(Inherited from FileSystemEntry.)
Public propertyFriendlyLocation
Gets the location of the entry (friendly representation).
(Inherited from FileSystemEntry.)
Public propertyFriendlyLocationElements
Gets a read-only list of distinct path elements which compose FriendlyLocation.
(Inherited from FileSystemEntry.)
Public propertyFriendlyName
Gets the name of the entry (friendly representation).
(Inherited from FileSystemEntry.)
Public propertyFullName
Gets the full path of the entry.
(Inherited from FileSystemEntry.)
Public propertyHasAttributeHierarchies
Gets a value indicating whether this instance has attribute hierarchies defined within.
Public propertyHasWarnings
Gets a value indicating whether this instance,or one of its dependencies, has warnings.
Public propertyHierarchyCategory
Gets the current instance hierarchy category.
Public propertyId
Gets the unique identifier of the entry.
(Inherited from FileSystemEntry.)
Public propertyIsAnonymized
Gets a value indicating whether the hierarchy members are to be anonymized during data retrieval operations, for legal or security reasons.
Public propertyIsCheckedOut
Gets a value indicating whether the file is checked out.
(Inherited from File.)
Public propertyIsCheckedOutToCaller
Gets a value indicating whether the file is checked out to caller.
(Inherited from File.)
Public propertyIsCustomLocalizationApplied
Gets or sets a value indicating whether a custom localization applied on this entity.
(Inherited from EntityBase.)
Public propertyIsFolder
Gets a value indicating whether the entry is a folder.
(Inherited from FileSystemEntry.)
Public propertyIsHidden
Gets a value indicating whether this instance is hidden and therefore not present in the parent cube hierarchy collection.
Public propertyIsInactive
Gets a value indicating whether the file is inactive.
(Inherited from File.)
Public propertyIsProtected
Gets a value indicating whether the entry is protected.
(Inherited from FileSystemEntry.)
Public propertyIsRecycled
Gets a value indicating whether the entry is recycled.
(Inherited from FileSystemEntry.)
Public propertyIsRecycledDirectly
Gets a value indicating whether the entry is recycled directly and not as a part of parent entry recycling.
(Inherited from FileSystemEntry.)
Public propertyIsSubentry
Gets a value indicating whether the entry is contained by a File.
(Inherited from FileSystemEntry.)
Public propertyIsTemporary
Gets a value indicating whether the entry resides under a temporary folder.
(Inherited from FileSystemEntry.)
Public propertyIsTransient
Gets a value indicating whether the file is transient.
(Inherited from File.)
Public propertyIsValid
Gets a value indicating whether this hierarchy is valid.
Public propertyLastCheckedInTime
Gets the time when the file was last checked in.
(Inherited from File.)
Public propertyLastModifiedTime
Gets the time, in coordinated universal time (UTC), at which the entry was last modified.
(Inherited from FileSystemEntry.)
Public propertyLevels
Gets the hierarchy levels.
Public propertyLinks
Gets the links between the hierarchy entity and the DataCube output connector elements.
Public propertyLocation
Gets the location of the entry.
(Inherited from FileSystemEntry.)
Public propertyMetadata
Gets arbitrary metadata associated with the entry.
(Inherited from FileSystemEntry.)
Public propertyName
Gets the name of the entry.
(Inherited from FileSystemEntry.)
Public propertyObjectType
Gets the type of the entry.
(Inherited from FileSystemEntry.)
Public propertyParameters
Gets the public parameter collection, if the hierarchy either exposes inherited parameters or if it allows parameter definition.
Public propertyParentId
Gets the ID of the item's parent.
(Inherited from FileSystemEntry.)
Public propertyPrimaryEntryId
Gets the ID of the primary object which contains the entry.
(Inherited from FileSystemEntry.)
Public propertyPrivilegeInheritanceBehavior
Gets the privilege inheritance behavior.
(Inherited from FileSystemEntry.)
Public propertyPrivileges
Gets the entry's privilege assignments.
(Inherited from FileSystemEntry.)
Public propertyProjectId
Gets the ID of the project containing the entry.
(Inherited from FileSystemEntry.)
Public propertyProperties
Gets the various uncategorized properties.
Public propertyReferences
Gets information about which other entities are directly referenced by this instance.
(Inherited from EntityBase.)
Public propertyRevision
Gets the revision of this instance.
(Inherited from EntityBase.)
Public propertyRevisionComment
Gets the check-in comment associated with the revision.
(Inherited from EntityBase.)
Public propertyRevisionCreatedBy
Gets information about the account which checked-in (or created) the revision.
(Inherited from EntityBase.)
Public propertyRevisionCreatedTime
Gets the time when the revision was checked in (or created).
(Inherited from EntityBase.)
Public propertySecurityAttributeId
Gets the security attribute ID, if one is associated with the current hierarchy.
Public propertySortPolicy
Gets the sorting behavior defined for the hierarchy.
Public propertySubtype
Gets or sets the type-specific sub-type of the entry.
(Inherited from FileSystemEntry.)
Public propertySupportedAggregators
Gets or sets the supported aggregators.
Public propertyTags
Gets a collection of explicit tags associated with the entry.
(Inherited from FileSystemEntry.)
Public propertyTenantId
Gets the ID of the tenant associated with the entry.
(Inherited from FileSystemEntry.)
Public propertyUniqueName
Gets the object unique name.
Public propertyVersionCode
Gets a number representing the current version of the file system entry's database record.
(Inherited from FileSystemEntry.)
Public propertyWarnings
Gets the warnings for the current instance, as well as for any dependency objects.
Top
Methods
  NameDescription
Public methodGetLevel
Gets the level by its unique name.
Public methodGetMember(String)
Gets the member by the member unique name.
Public methodGetMember(MemberValue)
Gets the member by the member value.
Public methodIsCompatibleWith
Checks if the current instance is compatible with the specified hierarchy.
Public methodMemberQuery(MemberRetrievalOptions, IHierarchyMember, NullableInt32)
Enumerates hierarchy members. This is a flat list of members potentially on different hierarchy levels.
Public methodMemberQuery(MemberRetrievalOptions, ICollectionMemberValue, NullableInt32, MemberValue)
Enumerates hierarchy members. This is a flat list of members potentially on different hierarchy levels.
Public methodRemoveLevel
Removes the specified hierarchy level.
Public methodToString
Returns a string that represents the current object.
(Inherited from FileSystemEntry.)
Top
See Also