Home > Class Reference > %SYS namespace > %DeepSee.UserLibrary.Folder
Private   Storage    

%DeepSee.UserLibrary.Folder

persistent class %DeepSee.UserLibrary.Folder extends %Persistent, %XML.Adaptor

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 6 1 1

Summary

Properties
%exportName folder fullName items name
resource
Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %BuildIndicesAsync
%BuildIndicesAsyncResponse %CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion
%ClassName %ComposeOid %ConstructClone %Delete
%DeleteExtent %DeleteId %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Exists %ExistsId %Extends
%GUID %GUIDSet %GetLock %GetParameter
%GetResource %GetSwizzleObject %Id %InsertBatch
%IsA %IsModified %IsNull %KillExtent
%KillExtentData %LoadFromMemory %LockExtent %LockId
%New %NormalizeObject %ObjectIsNull %ObjectModified
%Oid %OnBeforeAddToSync %OnDetermineClass %Open
%OpenId %OriginalNamespace %PackageName %PhysicalAddress
%PurgeIndices %Reload %RemoveFromSaveSet %ResolveConcurrencyConflict
%RollBack %Save %SaveDirect %SaveIndices
%SerializeObject %SetModified %SortBegin %SortEnd
%SyncObjectIn %SyncTransport %UnlockExtent %UnlockId
%ValidateIndices %ValidateObject XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType

Parameters

parameter NAMESPACE = "http://www.intersystems.com/deepsee/library";
NAMESPACE specifies the XML namespace to be used when projecting the class to XML. If NAMESPACE = "", the default namespace is used for the XML schema is used as the namespace for his class.
parameter XMLNAME = "folder";
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

property %exportName as %String(MAXLEN=32000,XMLNAME="name",XMLPROJECTION="attribute") [ Transient ];
Full name used for xml import/export.
relationship folder as %DeepSee.UserLibrary.Folder [ Inverse = items,Cardinality = one ];
Parent folder this item belongs to, if any.
property fullName as %String(MAXLEN=32000,XMLPROJECTION="none") [ Calculated,Transient ];
Full-name (including parent folders) of the folder.
relationship items as %DeepSee.UserLibrary.Folder [ Inverse = folder,Cardinality = many ];
Subfolders within this folder, if any.
property name as %String(MAXLEN=255,XMLPROJECTION="none");
User-specified (local) name of the folder.
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

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.

Indices

•index (name on folder,name) [Unique];