Skip to main content

%DeepSee.UserLibrary.Folder

Class %DeepSee.UserLibrary.Folder Extends (%Persistent, %XML.Adaptor) [ System = 4 ]

This persistent class represents a folder within the DeepSee User Portal. Folders are used to group dashboards, saved pivots, and other user-defined elements.

Parameters​

NAMESPACE​

Parameter NAMESPACE = "http://www.intersystems.com/deepsee/library";

XMLNAME​

Parameter XMLNAME = "folder";

Properties​

%exportName​

Property %exportName As %String(MAXLEN = 32000, XMLNAME = "name", XMLPROJECTION = "attribute") [ Transient ];

Full name used for xml import/export.

fullName​

Property fullName As %String(MAXLEN = 32000, XMLPROJECTION = "none") [ Calculated, SqlComputeCode = {Set {fullName}=##class(%DeepSee.UserLibrary.Folder).%GetFullName({ID})}, SqlComputed, Transient ];

Full-name (including parent folders) of the folder.

name​

Property name As %String(MAXLEN = 255, XMLPROJECTION = "none");

User-specified (local) name of the folder.

folder​

Relationship folder As %DeepSee.UserLibrary.Folder [ Cardinality = one, Inverse = items ];

Parent folder this item belongs to, if any.

items​

Relationship items As %DeepSee.UserLibrary.Folder [ Cardinality = many, Inverse = folder ];

Subfolders within this folder, if any.

resource​

Property resource As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Default resource applied to items within this folder. Any items within this folder that do not supply a resource will use this value.

Methods​

%GetFullName​

ClassMethod %GetFullName(pID As %String) As %String [ Internal ]

Compute the full name of this folder.

%GetResource​

Method %GetResource(Output pOrigin As %String) As %String

Get the resource value for this folder. Also return the name of the folder that defines the resource.

%OnDelete​

ClassMethod %OnDelete(oid As %ObjectIdentity) As %Status [ Private, ServerOnly = 1 ]

Folder is being deleted.