Skip to main content


abstract persistent class %DeepSee.UserLibrary.FolderItem extends %Library.Persistent, %XML.Adaptor, %CSP.Portal.AbstractPortalModel

SQL Table Name: %DeepSee_UserLibrary.FolderItem

This abstract class represents an item within a DeepSee folder.

Property Inventory

Method Inventory


parameter ICON = portal/window_24.png;
URL of icon for this item
parameter ITEMTYPE;
This is the extension returned by this type from the Finder.
parameter LARGEICON = portal/pie_chart_48.gif;
URL of large icon for this item
parameter LISTED = 1;
If true, then items of this type (class) are displayed in the user portal table.
parameter NAMESPACE =;
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 PUBLIC = 1;
Default value of public property for the class.
parameter XMLIGNORENULL = 1;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.


property bookCover as %String (MAXLEN = 20000, XMLPROJECTION = "attribute");
Specification string for the book cover associated with this folder item.
Property methods: bookCoverDisplayToLogical(), bookCoverGet(), bookCoverGetStored(), bookCoverIsValid(), bookCoverLogicalToDisplay(), bookCoverLogicalToOdbc(), bookCoverNormalize(), bookCoverSet()
property category as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Category used by the book cover view of this item.
Property methods: categoryDisplayToLogical(), categoryGet(), categoryGetStored(), categoryIsValid(), categoryLogicalToDisplay(), categoryLogicalToOdbc(), categoryNormalize(), categorySet()
property createdBy as %String (MAXLEN = 255, XMLPROJECTION = "attribute") [ InitialExpression = $UserName ];
Name of the user that originally created this item.
Property methods: createdByDisplayToLogical(), createdByGet(), createdByGetStored(), createdByIsValid(), createdByLogicalToDisplay(), createdByLogicalToOdbc(), createdByNormalize(), createdBySet()
property description as %String (MAXLEN = 2000, XMLPROJECTION = "attribute");
Optional description for this item.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionGetStored(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property documentName as %String (MAXLEN = 32000, XMLPROJECTION = "none") [ Calculated , Transient , ReadOnly ];
Name of this item used in document import/export and source control (including folder and type extension plus .DFI).
Property methods: documentNameCompute(), documentNameDisplayToLogical(), documentNameIsValid(), documentNameLogicalToDisplay(), documentNameLogicalToOdbc(), documentNameNormalize(), documentNameSQLCompute()
property folder as %DeepSee.UserLibrary.Folder (XMLPROJECTION = "none") [ ReadOnly ];
Folder this item belongs to.
Property methods: folderGet(), folderGetObject(), folderGetObjectId(), folderGetStored(), folderGetSwizzled(), folderIsValid(), folderNewObject(), folderSetObject(), folderSetObjectId(), folderUnSwizzle()
property folderName as %String (MAXLEN = 255, XMLPROJECTION = "attribute") [ Transient ];
Full name of the folder this item belongs to.
Property methods: folderNameCompute(), folderNameDisplayToLogical(), folderNameIsValid(), folderNameLogicalToDisplay(), folderNameLogicalToOdbc(), folderNameNormalize(), folderNameSQLCompute(), folderNameSet(), folderNameSetT()
property fullName as %String (MAXLEN = 32000, XMLPROJECTION = "none") [ Calculated , Transient ];
Full name of this item (including folder and type extension).
Property methods: fullNameCompute(), fullNameDisplayToLogical(), fullNameIsValid(), fullNameLogicalToDisplay(), fullNameLogicalToOdbc(), fullNameNormalize(), fullNameSQLCompute()
property keywords as %String (MAXLEN = 2000, XMLPROJECTION = "attribute");
Csv-list of keywords associated with the item.
Property methods: keywordsDisplayToLogical(), keywordsGet(), keywordsGetStored(), keywordsIsValid(), keywordsLogicalToDisplay(), keywordsLogicalToOdbc(), keywordsNormalize(), keywordsSet()
property lastAccessed as %TimeStamp (XMLPROJECTION = "attribute");
Time that this item was last accessed.
Property methods: lastAccessedDisplayToLogical(), lastAccessedGet(), lastAccessedGetStored(), lastAccessedIsValid(), lastAccessedLogicalToDisplay(), lastAccessedLogicalToXSD(), lastAccessedNormalize(), lastAccessedOdbcToLogical(), lastAccessedSet(), lastAccessedXSDToLogical()
property locked as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
If true, then users are not allowed to save modifications to this item without first unlocking it.
Property methods: lockedDisplayToLogical(), lockedGet(), lockedGetStored(), lockedIsValid(), lockedLogicalToDisplay(), lockedLogicalToXSD(), lockedNormalize(), lockedSet(), lockedXSDToLogical()
property name as %String (MAXLEN = 255, XMLPROJECTION = "attribute") [ Required ];
Name of this item.
Property methods: nameDisplayToLogical(), nameGet(), nameGetStored(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property owner as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
User name of the owner of this item.
Property methods: ownerDisplayToLogical(), ownerGet(), ownerGetStored(), ownerIsValid(), ownerLogicalToDisplay(), ownerLogicalToOdbc(), ownerNormalize(), ownerSet()
property public as %Boolean (XMLPROJECTION = "attribute") [ SqlFieldName = ispublic , InitialExpression = ..#PUBLIC ];
If true, this this item is listed in the user portal (if the user has permission to see it).
Property methods: publicDisplayToLogical(), publicGet(), publicGetStored(), publicIsValid(), publicLogicalToDisplay(), publicLogicalToXSD(), publicNormalize(), publicSet(), publicXSDToLogical()
property resource as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
The resource needed to view or edit this item:
If defined and the current user holds the USE privilege on this resource, then the user may view this item.
If defined and the current user holds the WRITE privilege on this resource, then the user may modify this item.
Property methods: resourceDisplayToLogical(), resourceGet(), resourceGetStored(), resourceIsValid(), resourceLogicalToDisplay(), resourceLogicalToOdbc(), resourceNormalize(), resourceSet()
property shared as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
If true, then anyone with permission can view this item, otherwise only the owner can view this item.
Property methods: sharedDisplayToLogical(), sharedGet(), sharedGetStored(), sharedIsValid(), sharedLogicalToDisplay(), sharedLogicalToXSD(), sharedNormalize(), sharedSet(), sharedXSDToLogical()
property timeCreated as %TimeStamp (XMLPROJECTION = "attribute") [ InitialExpression = $ZDT($ZTS,3,,3) ];
Time that this item was originally created.
Property methods: timeCreatedDisplayToLogical(), timeCreatedGet(), timeCreatedGetStored(), timeCreatedIsValid(), timeCreatedLogicalToDisplay(), timeCreatedLogicalToXSD(), timeCreatedNormalize(), timeCreatedOdbcToLogical(), timeCreatedSet(), timeCreatedXSDToLogical()
property timeModified as %TimeStamp (XMLPROJECTION = "none");
Time that this item was last saved.
Property methods: timeModifiedDisplayToLogical(), timeModifiedGet(), timeModifiedGetStored(), timeModifiedIsValid(), timeModifiedLogicalToDisplay(), timeModifiedLogicalToXSD(), timeModifiedNormalize(), timeModifiedOdbcToLogical(), timeModifiedSet(), timeModifiedXSDToLogical()
property title as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Option title displayed for this item.
Property methods: titleDisplayToLogical(), titleGet(), titleGetStored(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()


method %CheckResource(pPrivilege As %String = "USE") as %Boolean
Test if the current user has access to this item.
method %Dump() as %Status
Diagnostic method: display contents of this folder item to the console. This can be extended by subclasses.
method %GetCoverSpec() as %String
Return the book cover spec for this folder item.
method %GetDependencies(pList As %String) as %Status
Return a list of all other folder items (including cubes or kpis) that this item depends upon. Returns a list of the form:
pList(itemName) = ""
This is extended by subclasses.
method %GetIcon() as %String
Return the icon for this item.
method %GetLargeIcon() as %String
Return the large icon for this item.
method %GetResource(Output pOrigin As %String) as %String
Get the resource value for this item. Also return the name of the folder that defines the resource or "" if it originates here.
method %GetTypeName() as %String
Return the localized type name for this item.
method %GetURL() as %String
Return the URL for this item.
method %OnAfterImport(pNewName As %String) as %Status
Notification that this item has just been imported.
classmethod %ParseFullName(pFullName As %String, Output pFolderName As %String, Output pName As %String, Output pExtension As %String) as %Status
Split the given full name for this item into its parts.
method documentNameGet() as %String
Getter method for document name that can be imported/exported
method folderNameGet() as %String
Getter method for folder name.
method folderNameSet(%val As %String) as %Status
Setter method for folder name.
classmethod fullNameFromDocumentName(pDocName As %String) as %String
method fullNameGet() as %String
Getter method for full name.
method fullNameSet(%val) as %Status
Setter method for full name.


index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (key on folder,name);
Index methods: keyExists(), keywordsDisplayToLogical(), keywordsGet(), keywordsGetStored(), keywordsIsValid(), keywordsLogicalToDisplay(), keywordsLogicalToOdbc(), keywordsNormalize(), keywordsSet()

Inherited Members

Inherited Properties

Inherited Methods


Storage Model: Storage (%DeepSee.UserLibrary.FolderItem)



FeedbackOpens in a new tab