abstract class %DeepSee.UserLibrary.Utils
extends %RegisteredObject
This class contains API method for the DeepSee User Component library.
Parameters
|
Properties
|
Methods
|
Queries
|
Indices
|
ForeignKeys
|
Triggers
|
|
|
20
|
|
|
|
|
classmethod %AddFavorite(pName As %String)
as %Status
Add item to favorites list.
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 %Export(pFullName As %String, pFile As %String = "", pVerbose As %Boolean = 1)
as %Status
Export FolderItem or Folder information to an XML file.
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 %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 %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 %Import(pFile As %String = "", pReplace As %Boolean = 0, pVerbose As %Boolean = 1, pKill As %Boolean = 0, pForceItemName As %String = "")
as %Status
Import a folder item definition from an XML file.
If pReplace is true, replace an existing item with the same name.
If pVerbose is true, write status to the console.
If pKill is true, then delete all existing items before import!
If pForceItemName is given, import the item using that name.
If type-extension is not present in pForceItemName supply it automatically
classmethod %ImportContainer(pClass As %String = "", pReplace As %Boolean = 0, pVerbose As %Boolean = 1)
as %Status
Import a folder item definition from the Contents XData block of the given class.
If pReplace is true, replace an existing item with the same name.
If pVerbose is true, write status to the console.
classmethod %KillFolders()
as %Status
Deletes all folders and folder items in the current namespace.
classmethod %KillUserPreferences()
as %Status
Deletes all user preference info in the current namespace.
classmethod %OpenFolderItem(pFullName As %String, Output pStatus As %Status)
as FolderItem
Open the folder item with the given full name.
classmethod %RegisterRecentItem(pType As %String, pName As %String)
as %Status
Make note that the given item was accessed recently.
classmethod %RemoveFavorite(pName As %String)
as %Status
Remove item from favorites list.
classmethod %RemoveRecentItem(pName As %String)
as %Status
Remove item from recent items list.