%DeepSee.UserLibrary.Folder
persistent class %DeepSee.UserLibrary.Folder extends %Library.Persistent, %XML.Adaptor
SQL Table Name: %DeepSee_UserLibrary.Folder
This persistent class represents a folder within the DeepSee User Portal. Folders are used to group dashboards, saved pivots, and other user-defined elements.Property Inventory
Method Inventory
Parameters
parameter NAMESPACE = http://www.intersystems.com/deepsee/library;
Inherited description: 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;
Inherited description: 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.
Property methods: %exportNameDisplayToLogical(), %exportNameGet(), %exportNameIsValid(), %exportNameLogicalToDisplay(), %exportNameLogicalToOdbc(), %exportNameNormalize(), %exportNameSet()
relationship folder as %DeepSee.UserLibrary.Folder [ Inverse = items , Cardinality = one ];
Parent folder this item belongs to, if any.
Property methods: folderGet(), folderGetObject(), folderGetObjectId(), folderGetStored(), folderGetSwizzled(), folderIsValid(), folderNewObject(), folderOnDelete(), folderRClose(), folderRExec(), folderRFetch(), folderRelate(), folderSQLCompute(), folderSet(), folderSetObject(), folderSetObjectId(), folderUnRelate(), folderUnSwizzle()
property fullName as %String (MAXLEN = 32000, XMLPROJECTION = "none") [ Calculated , Transient ];
Full-name (including parent folders) of the folder.
Property methods: fullNameCompute(), fullNameDisplayToLogical(), fullNameGet(), fullNameIsValid(), fullNameLogicalToDisplay(), fullNameLogicalToOdbc(), fullNameNormalize(), fullNameSQLCompute()
relationship items as array of %DeepSee.UserLibrary.Folder [ InitialExpression = $listbuild("%DeepSee.UserLibrary.Folder","folder",+$this,"many",1,1) , Transient , Inverse = folder , Cardinality = many ];
Subfolders within this folder, if any.
Property methods: itemsGet(), itemsGetObject(), itemsGetObjectId(), itemsGetSwizzled(), itemsIsEmpty(), itemsIsValid(), itemsNewObject(), itemsRClose(), itemsRExec(), itemsRFetch(), itemsRelate(), itemsSQLCompute(), itemsSet(), itemsUnRelate()
property name as %String (MAXLEN = 255, XMLPROJECTION = "none");
User-specified (local) name of the folder.
Property methods: nameDisplayToLogical(), nameGet(), nameGetStored(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
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.
Property methods: resourceDisplayToLogical(), resourceGet(), resourceGetStored(), resourceIsValid(), resourceLogicalToDisplay(), resourceLogicalToOdbc(), resourceNormalize(), resourceSet()
Methods
Get the resource value for this folder.
Also return the name of the folder that defines the resource.
Indexes
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (name on folder,name) [Unique];
Index methods: nameCheck(), nameCheckUnique(), nameDelete(), nameDisplayToLogical(), nameExists(), nameGet(), nameGetStored(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameOpen(), nameSQLCheckUnique(), nameSQLExists(), nameSQLFindPKeyByConstraint(), nameSQLFindRowIDByConstraint(), nameSet()
Inherited Members
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %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()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Storage Model: Storage (%DeepSee.UserLibrary.Folder)
^DeepSee.FolderD(ID) |
= | %%CLASSNAME
name
folder
resource
|