dundas.entities.Hierarchy Class

Inheritance Hierarchy

Constructors

	Name	Description
	init	Initializes the Hierarchy. Called during construction.

Properties

	Name	Description
	allChildren	Gets a flat list of all files and folders in this folder and all its subfolders. Inherited from dundas.filesystem.FileSystemEntry.
	allFiles	Gets a flat list of all files in the folder and all its subfolders. Inherited from dundas.filesystem.FileSystemEntry.
	allFolders	Gets a flat list of all subfolders in the folder and all its subfolders. Inherited from dundas.filesystem.FileSystemEntry.
	allMember	Gets or sets the hierarchy all member.
	attributeHierarchies	Gets or sets the attribute hierarchies under this hierarchy, if any.
	caption	Gets or sets the caption.
	category	Gets or sets the element type.
	checkedOutTo	Gets the account info to which the object is checked out. Inherited from dundas.filesystem.File.
	childCount	Gets or sets the number of direct children contained in this folder or file. Inherited from dundas.filesystem.FileSystemEntry.
	children	Gets the files and folders under this entry. Inherited from dundas.filesystem.FileSystemEntry.
	compatibleUniqueName	Gets or sets the hierarchy compatible unique name.
	createdBy	Gets or sets the account of the user who created the folder or file. Inherited from dundas.filesystem.FileSystemEntry.
	createdTime	Gets or sets the time, in coordinated universal time (UTC), that the folder or file was created. Inherited from dundas.filesystem.FileSystemEntry.
	currentRevision	Gets a value indicating the current revision number. Inherited from dundas.filesystem.File.
	description	Gets or sets an optional description associated with the file or folder. Inherited from dundas.filesystem.FileSystemEntry.
	effectiveCallerPrivileges	Gets or sets the effective privileges for the current user. See dundas.filesystem.ObjectPrivilegeIds for the available values. Inherited from dundas.filesystem.FileSystemEntry.
	entityId	Gets or sets ID of the parent entity.
	files	Gets or sets the files contained in this folder. Inherited from dundas.filesystem.FileSystemEntry.
	folders	Gets or sets the subfolders of this folder. Inherited from dundas.filesystem.FileSystemEntry.
	friendlyFullName	Gets or sets the friendly full path of the entry. Inherited from dundas.filesystem.FileSystemEntry.
	friendlyLocation	Gets or sets the friendly location to the entry. Inherited from dundas.filesystem.FileSystemEntry.
	friendlyLocationElements	Gets or sets a list of distinct path elements which compose the FriendlyLocation. Inherited from dundas.filesystem.FileSystemEntry.
	friendlyName	Gets or sets the friendly name of the entry. Inherited from dundas.filesystem.FileSystemEntry.
	fullName	Gets or sets the full path of the folder or file. Inherited from dundas.filesystem.FileSystemEntry.
	hasAttributeHierarchies	Gets or sets a value indicating whether this hierarchy has attribute hierarchies in it.
	id	Gets or sets the unique identifier of the file or folder. Inherited from dundas.filesystem.FileSystemEntry.
	inheritedTags	Gets or sets the inherited tags associated with the file or folder. Inherited from dundas.filesystem.FileSystemEntry.
	isCheckedOut	Gets a value indicating whether the file is checked out. Inherited from dundas.filesystem.File.
	isCheckedOutToCaller	Gets a value indicating whether the file is checked out to this current user (session). Inherited from dundas.filesystem.File.
	isCustomLocalizationApplied	Gets the value of isCustomLocalizationApplied flag of this instance. Inherited from dundas.entities.EntityBase.
	isInactive	Gets the value indicating whether the file is inactive or active. Inherited from dundas.filesystem.File.
	isProtected	Gets or sets a value indicating whether this instance is protected. Inherited from dundas.filesystem.FileSystemEntry.
	isRecycled	Gets or sets a value indicating whether the entry is recycled. Inherited from dundas.filesystem.FileSystemEntry.
	isSubentry	Gets or sets a value indicating whether this instance is a child entry. Inherited from dundas.filesystem.FileSystemEntry.
	isTemporary	Gets or sets a value indicating whether the entry resides under a temporary folder. Inherited from dundas.filesystem.FileSystemEntry.
	isTimeHierarchy	Gets or sets a value indicating whether this hierarchy is a time hierarchy.
	isTransient	Gets a value indicating the whether or not this file is transient. Inherited from dundas.filesystem.File.
	lastCheckedInTime	Gets a value indicating the last time this file was checked in. This might be null if it was never checked in. Inherited from dundas.filesystem.File.
	lastModifiedTime	Gets or sets the time, in coordinated universal time (UTC), that the folder or file was last written to. Inherited from dundas.filesystem.FileSystemEntry.
	levels	Gets or sets the hierarchy levels.
	location	Gets or sets the location to the file or folder. Inherited from dundas.filesystem.FileSystemEntry.
	metadata	Gets or sets the meta data assigned to this file system entry Inherited from dundas.filesystem.FileSystemEntry.
	name	Gets or sets the name of the folder or file. Inherited from dundas.filesystem.FileSystemEntry.
	objectType	Gets or sets the type of the folder or file. Inherited from dundas.filesystem.FileSystemEntry.
	parameters	Gets or sets the hierarchy parameters.
	parentId	Gets or sets the ID of the folder in which the folder or file resides. Inherited from dundas.filesystem.FileSystemEntry.
	primaryEntryId	Gets the ID of the entity which contains this entry. Inherited from dundas.filesystem.FileSystemEntry.
	privilegeInheritanceBehavior	Gets or sets the privilege inheritance behavior on this file system entry. Inherited from dundas.filesystem.FileSystemEntry.
	privileges	Gets or sets the privileges assigned to this file system entry. Inherited from dundas.filesystem.FileSystemEntry.
	projectId	Gets or sets the ID of the project containing this folder or file. Inherited from dundas.filesystem.FileSystemEntry.
	revision	Gets the revision of this instance. Inherited from dundas.entities.EntityBase.
	sortPolicy	Gets the sorting behaviour defined for the hierarchy.
	subtype	Gets or sets the type-specific sub-type of this instance. Inherited from dundas.filesystem.FileSystemEntry.
	tags	Gets or sets the tags associated with the file or folder. Inherited from dundas.filesystem.FileSystemEntry.
	tenantId	Gets or sets a value indicating the tenant ID, if applicable. Inherited from dundas.filesystem.FileSystemEntry.
	undoContext	Gets the current undo context for this entity, if available. Inherited from dundas.entities.EntityBase.
	uniqueName	Gets or sets the unique name.
	warnings	Gets or sets any warnings that might have come from the entity. See Dundas.BI.WebApi.Models.DataWarningData for return structure. Inherited from dundas.filesystem.File.

Methods

	Name	Description
	fromJObject	Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
	getChildLevelByDepth	Gets the level that has the next largest depth to levelDepth.
	getId	Gets the ID of this hierarchy, which may be the analysis structure ID, the entity ID, or if this is a user hierarchy, then just the ID itself. If none is found, null will be returned.
	getLevel	Gets the level based on the unique name given.
	getLevelByDepth	Gets the level with the specified level depth.
	getParentLevelByDepth	Gets the level that has the next smallest depth to levelDepth.
	getTooltipText	Gets the tooltip text for this file system entry. Inherited from dundas.filesystem.FileSystemEntry.
	hasEffectiveCallerPrivilege	Checks if the file has the specified effective caller privilege or not. Inherited from dundas.filesystem.FileSystemEntry.
	isFile	Returns whether this file system entry is a file or not. Inherited from dundas.filesystem.FileSystemEntry.
	isFolder	Returns whether this file system entry is a folder or not. Inherited from dundas.filesystem.FileSystemEntry.
	isProject	Returns whether this file system entry is a project or not. Inherited from dundas.filesystem.FileSystemEntry.
	isRelationshipsSupported	Returns whether this file system entry supports creating relationships to it. Inherited from dundas.filesystem.FileSystemEntry.
	isRootFolder	Returns whether this file system entry is a root folder or not. Inherited from dundas.filesystem.FileSystemEntry.
	isRootFolderWithSharedItems	Returns whether this file system entry is a root folder that can have shared items or not. Inherited from dundas.filesystem.FileSystemEntry.
	tagsFromString	Converts the given comma-separated string into an array and sets it on the tags. This will also trim the whitespace. Inherited from dundas.filesystem.FileSystemEntry.
	tagsToString	Gets the tags as comma-separated string. Inherited from dundas.filesystem.FileSystemEntry.
	toJSON	Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.