Home > Class Reference > ENSLIB namespace > %DeepSee.UserLibrary.Utils

%DeepSee.UserLibrary.Utils

abstract class %DeepSee.UserLibrary.Utils extends %Library.RegisteredObject

This class contains API method for the DeepSee User Component library.

Method Inventory (Including Private)

Methods (Including Private)

classmethod %AddFavorite(pName As %String) as %Status
Add item to favorites list.
classmethod %CanWriteToFolder(pFolderName As %String) as %Boolean
Does the current user have "WRITE" access to a folder?
classmethod %DeleteFolderContents(pFolderName As %String) as %Status
Delete all the items within the given folder.
classmethod %DeleteFolderItem(pFullName As %String, Output pCount As %Integer) as %Status
Delete the folder item with the given full name. pCount returns the number of items actually deleted.
classmethod %Dump(pFolderItemName As %String = "") as %Status
Diagnostic method. Display the contents of a folder item to the console.
classmethod %ExpandItemList(ByRef pItemList As %String, pVerbose As %Boolean = 1) as %Status
classmethod %Export(pFullName As %String, pFile As %String = "", pVerbose As %Boolean = 1, Output pXMLName As %String) as %Status
Export FolderItem or Folder information to an XML file.
classmethod %ExportContainer(ByRef pItemList As %String, pFileName As %String, pContainerClassName As %String = "", pVerbose As %Boolean = 1) as %Status
Export the items in the list to a container
classmethod %FindFolder(pName As %String, pCreate As %Boolean = 0, Output pSC As %Status, pParent As Folder = "") as Folder
Find the folder with the given full name. If pCreate is true, then create the folder if it does not exist.
classmethod %FolderItemExists(pFullName As %String, Output pID As %String) as %Integer
Check if a there is a folder item with the given name.
Returns 0 if the item does not exist; returns 1 if it exists and is visible to the current user; returns 2 if it exists but is not visible to the current user.
Return its id by reference as a convenience.
classmethod %GetCategoryList(Output pList) as %Status
Return an array of all categories that have been assigned to Folder Items. This list is in the form:
pList(n) = category
classmethod %GetFavoriteList(Output pList As %String) as %Status
Get list of favorite items for user. This takes the form:
pList(name) = time
classmethod %GetFolderItemClasses(Output pList) as %Status
Return a list of all folder item classes.
pList(n) = $LB(classname,xmlname)
classmethod %GetFolderItemList(Output pList As %String, pFolderName As %String = "", pShowAll As %Boolean = 0, pFolderClass As %String = "") as %Status
Return an array of all folder items visible to the current user within the given folder. This list is in the form:
pList(n) = id
If pShowAll is true, list items for all users.
If pFolderClass is provided, only list items of the given type.
classmethod %GetFolderList(Output pList As %String, pFolderName As %String = "") as %Status
Return an array of all folders visible to the current user within the given folder. This list is in the form:
pList(n) = name
classmethod %GetItemsForType(pType, ByRef pItemList, pVerbose As %Boolean = 1)
classmethod %GetRecentItemList(Output pList As %String, pType As %String = "") as %Status
Get list of recent items for user. This takes the form:
pList(time) = name
If pType is missing, list all types. pType can contain a csv list of types.
classmethod %GetRelatedItems(pItem As %String, ByRef pRelItems, pVerbose As %Boolean = 1) as %Status
Get the related DeepSee items for a dashboard or pivot table. All items related to the target item pItem will be returned in the pRelItems array. Related items are returned indexed by a single "all" node and by type:
pRelItems("all",pItem)=""
pRelItems("type","itemType",pItem)=""
classmethod %GetRelatedItemsForCube(pCubeName As %String, ByRef pRelItems, pVerbose As %Boolean = 1) as %Status
Get the related DeepSee items for a cube/subject area.
classmethod %GetRelatedItemsForDashboard(pItem As %String, ByRef pRelItems, pVerbose As %Boolean = 1) as