Skip to main content

%DeepSee.UserLibrary.FolderItem

Class %DeepSee.UserLibrary.FolderItem Extends (%Persistent, %XML.Adaptor, %CSP.Portal.AbstractPortalModel) [ Abstract, System = 4 ]

This abstract class represents an item within a DeepSee folder.

Parameters​

NAMESPACE​

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

XMLIGNORENULL​

Parameter XMLIGNORENULL = 1;

ITEMTYPE​

Parameter ITEMTYPE As STRING;

This is the extension returned by this type from the Finder.

LISTED​

Parameter LISTED As BOOLEAN = 1;

If true, then items of this type (class) are displayed in the user portal table.

PUBLIC​

Parameter PUBLIC As BOOLEAN = 1;

Default value of public property for the class.

ICON​

Parameter ICON As STRING = "portal/window_24.png";

URL of icon for this item

LARGEICON​

Parameter LARGEICON As STRING = "portal/pie_chart_48.gif";

URL of large icon for this item

Properties​

name​

Property name As %String(MAXLEN = 255, XMLPROJECTION = "attribute") [ Required ];

Name of this item.

folder​

Property folder As %DeepSee.UserLibrary.Folder(XMLPROJECTION = "none") [ ReadOnly ];

Folder this item belongs to.

folderName​

Property folderName As %String(MAXLEN = 255, XMLPROJECTION = "attribute") [ SqlComputeCode = {Set {folderName}=##class(%DeepSee.UserLibrary.Folder).%GetFullName({folder})}, SqlComputed, Transient ];

Full name of the folder this item belongs to.

fullName​

Property fullName As %String(MAXLEN = 32000, XMLPROJECTION = "none") [ Calculated, SqlComputeCode = {Set {fullName}=##class(%DeepSee.UserLibrary.Folder).%GetFullName({folder}), {fullName}={fullName}_$S({fullName}="":"",1:"/")_{name}, {fullName}={fullName}_$S({fullName}=""||($$$comMemberKeyGet($P({x__classname},"~",2),$$$cCLASSparameter,"ITEMTYPE",$$$cPARAMdefault)=""):"", 1:"."_$$$comMemberKeyGet($P({x__classname},"~",2),$$$cCLASSparameter,"ITEMTYPE",$$$cPARAMdefault))}, SqlComputed, Transient ];

Full name of this item (including folder and type extension).

documentName​

Property documentName As %String(MAXLEN = 32000, XMLPROJECTION = "none") [ Calculated, ReadOnly, SqlComputeCode = {Set {documentName}=##class(%DeepSee.UserLibrary.Folder).%GetFullName({folder}), {documentName}={documentName}_$S({documentName}="":"",1:"-")_{name}, {documentName}={documentName}_$S({documentName}=""||($$$comMemberKeyGet($P({x__classname},"~",2),$$$cCLASSparameter,"ITEMTYPE",$$$cPARAMdefault)=""):"", 1:"."_$$$comMemberKeyGet($P({x__classname},"~",2),$$$cCLASSparameter,"ITEMTYPE",$$$cPARAMdefault)_".DFI")}, SqlComputed, Transient ];

Name of this item used in document import/export and source control (including folder and type extension plus .DFI).

title​

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

Option title displayed for this item.

description​

Property description As %String(MAXLEN = 2000, XMLPROJECTION = "attribute");

Optional description for this item.

keywords​

Property keywords As %String(MAXLEN = 2000, XMLPROJECTION = "attribute");

Csv-list of keywords associated with the item.

owner​

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

User name of the owner of this item.

shared​

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.

public​

Property public As %Boolean(XMLPROJECTION = "attribute") [ InitialExpression = {..#PUBLIC}, SqlFieldName = ispublic ];

If true, this this item is listed in the user portal (if the user has permission to see it).

locked​

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.

resource​

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.

timeCreated​

Property timeCreated As %TimeStamp(XMLPROJECTION = "attribute") [ InitialExpression = {$ZDT($ZTS,3,,3)} ];

Time that this item was originally created.

timeModified​

Property timeModified As %TimeStamp(XMLPROJECTION = "none");

Time that this item was last saved.

createdBy​

Property createdBy As %String(MAXLEN = 255, XMLPROJECTION = "attribute") [ InitialExpression = {$UserName} ];

Name of the user that originally created this item.

category​

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

Category used by the book cover view of this item.

bookCover​

Property bookCover As %String(MAXLEN = 20000, XMLPROJECTION = "attribute");

Specification string for the book cover associated with this folder item.

lastAccessed​

Property lastAccessed As %TimeStamp(XMLPROJECTION = "attribute");

Time that this item was last accessed.

Methods​

fullNameGet​

Method fullNameGet() As %String

Getter method for full name.

fullNameSet​

Method fullNameSet(%val) As %Status

Setter method for full name.

documentNameGet​

Method documentNameGet() As %String

Getter method for document name that can be imported/exported

fullNameFromDocumentName​

ClassMethod fullNameFromDocumentName(pDocName As %String) As %String

folderNameGet​

Method folderNameGet() As %String

Getter method for folder name.

folderNameSet​

Method folderNameSet(%val As %String) As %Status

Setter method for folder name.

%OnBeforeSave​

Method %OnBeforeSave(insert As %Boolean) As %Status [ Private, ServerOnly = 1 ]

%ParseFullName​

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.

%CheckResource​

Method %CheckResource(pPrivilege As %String = "USE") As %Boolean

Test if the current user has access to this item.

%GetResource​

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.

%IsVisibleToPortal​

Method %IsVisibleToPortal() As %Boolean [ Internal ]

Test if this item is visible to the user portal.

%GetURL​

Method %GetURL() As %String

Return the URL for this item.

%GetIcon​

Method %GetIcon() As %String

Return the icon for this item.

%GetLargeIcon​

Method %GetLargeIcon() As %String

Return the large icon for this item.

%GetTypeName​

Method %GetTypeName() As %String

Return the localized type name for this item.

%CopyToComponent​

Method %CopyToComponent(pPivot As %DeepSee.Component.pivotTable) As %Status [ Internal ]

Copy the contents of this definition to pivot table pPivot.

%CopyFromComponent​

Method %CopyFromComponent(pPivot As %DeepSee.Component.pivotTable) As %Status [ Internal ]

Set the contents of this definition from pivot table pPivot.

%GetDependencies​

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.

%Dump​

Method %Dump() As %Status

Diagnostic method: display contents of this folder item to the console. This can be extended by subclasses.

%OnAfterImport​

Method %OnAfterImport(pNewName As %String) As %Status

Notification that this item has just been imported.

%GetCoverSpec​

Method %GetCoverSpec() As %String

Return the book cover spec for this folder item.