%DeepSee.UserLibrary.Utils
abstract class %DeepSee.UserLibrary.Utils extends %Library.RegisteredObject
This class contains API method for the DeepSee User Component library.Method Inventory
- %AddFavorite()
- %CanWriteToFolder()
- %DeleteFolderContents()
- %DeleteFolderItem()
- %Dump()
- %ExpandItemList()
- %Export()
- %ExportContainer()
- %FindFolder()
- %FolderItemExists()
- %GetCategoryList()
- %GetFavoriteList()
- %GetFolderItemClasses()
- %GetFolderItemList()
- %GetFolderList()
- %GetItemsForType()
- %GetRecentItemList()
- %GetRelatedItems()
- %GetRelatedItemsForCube()
- %GetRelatedItemsForDashboard()
- %GetRelatedItemsForPivot()
- %GetSubFolderList()
- %GetXMLNamesForClasses()
- %Import()
- %ImportContainer()
- %IsNotFolderItem()
- %KillAutosaveFolders()
- %KillFolders()
- %KillUserPreferences()
- %OpenFolderItem()
- %OpenItem()
- %ProcessContainer()
- %RegisterRecentItem()
- %RemoveFavorite()
- %RemoveRecentItem()
- %ValidateItemType()
Methods
Add item to favorites list.
Does the current user have "WRITE" access to a folder?
Delete all the items within the given folder.
Delete the folder item with the given full name.
pCount returns the number of items actually deleted.
Diagnostic method. Display the contents of a folder item to the console.
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.
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; returns 3 if the pivot is locked.
Return its id by reference as a convenience.
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; returns 3 if the pivot is locked.
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
pList(n) = category
Get list of favorite items for user.
This takes the form:
pList(name) = time
pList(name) = time
classmethod %GetFolderItemClasses(Output pList) as %Status
Return a list of all folder item classes.
pList(n) = $LB(classname,xmlname)
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.
pList(n) = id
If pShowAll is true, list items for all users.
If pFolderClass is provided, only list items of the given type.
Return an array of all folders visible to the current user within the given folder.
This list is in the form:
pList(n) = name
pList(n) = name
classmethod %GetItemsForType(pType, ByRef pItemList, pVerbose As %Boolean = 1)
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.
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)=""
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 %Status
Get the related DeepSee items for a dashboard.
classmethod %GetRelatedItemsForPivot(pItem As %String, ByRef pRelItems, pVerbose As %Boolean = 1) as %Status
Get the related DeepSee items for a pivot table.
classmethod %GetXMLNamesForClasses(Output pList, Output pNonFolderItem) as %Status
classmethod %Import(pFile As %String = "", pReplace As %Boolean = 0, pVerbose As %Boolean = 1, pKill As %Boolean = 0, pForceItemName As %String = "", ByRef pItemsLoaded 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
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(pFileName As %String = "", pReplace As %Boolean = 1, pVerbose As %Boolean = 1) as %Status
This method may be called to import a container class from an xml file. This will execute
the %OnLoad() method if it is defined in the container class.
The pReplace parameter is deprecated in this method but remains for compatibility purposes.
The pReplace parameter is deprecated in this method but remains for compatibility purposes.
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 %ProcessContainer(pClass As %String = "", pReplace As %Boolean = 0, pVerbose As %Boolean = 1, pSuppressForCaller As %Boolean = 0) 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.
If pReplace is true, replace an existing item with the same name.
If pVerbose is true, write status to the console.
Make note that the given item was accessed recently.
Remove item from favorites list.
Remove item from recent items list.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()