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

Inheritance diagram for Utils:

[legend]

Collaboration diagram for Utils:

[legend]

Static Private Member Functions
_.Library.Status	AddFavorite (_.Library.String pName)
	Add item to favorites list.

_.Library.Boolean	CanWriteToFolder (_.Library.String pFolderName)
	Does the current user have "WRITE" access to a folder?

_.Library.Status	DeleteFolderContents (_.Library.String pFolderName)
	Delete all the items within the given folder.

_.Library.Status	DeleteFolderItem (_.Library.String pFullName, _.Library.Integer pCount)
	Delete the folder item with the given full name. More...

_.Library.Status	Dump (_.Library.String pFolderItemName)
	Diagnostic method. More...

_.Library.Status	Export (_.Library.String pFullName, _.Library.String pFile, _.Library.Boolean pVerbose, _.Library.String pXMLName)
	Export FolderItem or Folder information to an XML file.

_.Library.Status	ExportContainer (_.Library.String pItemList, _.Library.String pFileName, _.Library.String pContainerClassName, _.Library.Boolean pVerbose)
	Export the items in the list to a container.

_.DeepSee.UserLibrary.Folder	FindFolder (_.Library.String pName, _.Library.Boolean pCreate, _.Library.Status pSC, _.DeepSee.UserLibrary.Folder pParent)
	Find the folder with the given full name. More...

_.Library.Integer	FolderItemExists (_.Library.String pFullName, _.Library.String pID)
	Check if a there is a folder item with the given name. More...

_.Library.Status	GetCategoryList (pList)
	Return an array of all categories that have been assigned to Folder Items. More...

_.Library.Status	GetFavoriteList (_.Library.String pList)
	Get list of favorite items for user. More...

_.Library.Status	GetFolderItemClasses (pList)
	Return a list of all folder item classes. More...

_.Library.Status	GetFolderItemList (_.Library.String pList, _.Library.String pFolderName, _.Library.Boolean pShowAll, _.Library.String pFolderClass)
	Return an array of all folder items visible to the current user within the given folder. More...

_.Library.Status	GetFolderList (_.Library.String pList, _.Library.String pFolderName)
	Return an array of all folders visible to the current user within the given folder. More...

_.Library.Status	GetRecentItemList (_.Library.String pList, _.Library.String pType)
	Get list of recent items for user. More...

_.Library.Status	GetRelatedItems (_.Library.String pItem, pRelItems, _.Library.Boolean pVerbose)
	Get the related DeepSee items for a dashboard or pivot table. More...

_.Library.Status	GetRelatedItemsForCube (_.Library.String pCubeName, pRelItems, _.Library.Boolean pVerbose)
	Get the related DeepSee items for a cube/subject area.

_.Library.Status	GetRelatedItemsForDashboard (_.Library.String pItem, pRelItems, _.Library.Boolean pVerbose)
	Get the related DeepSee items for a dashboard.

_.Library.Status	GetRelatedItemsForPivot (_.Library.String pItem, pRelItems, _.Library.Boolean pVerbose)
	Get the related DeepSee items for a pivot table.

_.Library.Status	Import (_.Library.String pFile, _.Library.Boolean pReplace, _.Library.Boolean pVerbose, _.Library.Boolean pKill, _.Library.String pForceItemName, _.Library.String pItemsLoaded)
	Import a folder item definition from an XML file. More...

_.Library.Status	ImportContainer (_.Library.String pFileName, _.Library.Boolean pReplace, _.Library.Boolean pVerbose)
	This method may be called to import a container class from an xml file. More...

_.Library.Status	KillFolders ()
	Deletes all folders and folder items in the current namespace.

_.Library.Status	KillUserPreferences ()
	Deletes all user preference info in the current namespace.

_.DeepSee.UserLibrary.FolderItem	OpenFolderItem (_.Library.String pFullName, _.Library.Status pStatus)
	Open the folder item with the given full name.

_.Library.Status	ProcessContainer (_.Library.String pClass, _.Library.Boolean pReplace, _.Library.Boolean pVerbose, _.Library.Boolean pSuppressForCaller)
	Import a folder item definition from the Contents XData block of the given class. More...

_.Library.Status	RegisterRecentItem (_.Library.String pType, _.Library.String pName)
	Make note that the given item was accessed recently.

_.Library.Status	RemoveFavorite (_.Library.String pName)
	Remove item from favorites list.

_.Library.Status	RemoveRecentItem (_.Library.String pName)
	Remove item from recent items list.

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

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

Member Function Documentation

◆ DeleteFolderItem()

_.Library.Status DeleteFolderItem	(	_.Library.String	pFullName,
		_.Library.Integer	pCount
	)

staticprivate

Delete the folder item with the given full name.

pCount returns the number of items actually deleted.

◆ Dump()

_.Library.Status Dump ( _.Library.String pFolderItemName )

staticprivate

Diagnostic method.

Display the contents of a folder item to the console.

◆ FindFolder()

_.DeepSee.UserLibrary.Folder FindFolder	(	_.Library.String	pName,
		_.Library.Boolean	pCreate,
		_.Library.Status	pSC,
		_.DeepSee.UserLibrary.Folder	pParent
	)

staticprivate

Find the folder with the given full name.

If pCreate is true, then create the folder if it does not exist.

◆ FolderItemExists()

_.Library.Integer FolderItemExists	(	_.Library.String	pFullName,
		_.Library.String	pID
	)

staticprivate

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.

◆ GetCategoryList()

_.Library.Status GetCategoryList ( pList )

staticprivate

Return an array of all categories that have been assigned to Folder Items.

This list is in the form:
pList(n) = category

◆ GetFavoriteList()

_.Library.Status GetFavoriteList ( _.Library.String pList )

staticprivate

Get list of favorite items for user.

This takes the form:
pList(name) = time

◆ GetFolderItemClasses()

_.Library.Status GetFolderItemClasses ( pList )

staticprivate

Return a list of all folder item classes.

pList(n) = $LB(classname,xmlname)

◆ GetFolderItemList()

_.Library.Status GetFolderItemList	(	_.Library.String	pList,
		_.Library.String	pFolderName,
		_.Library.Boolean	pShowAll,
		_.Library.String	pFolderClass
	)

staticprivate

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.

◆ GetFolderList()

_.Library.Status GetFolderList	(	_.Library.String	pList,
		_.Library.String	pFolderName
	)

staticprivate

Return an array of all folders visible to the current user within the given folder.

This list is in the form:
pList(n) = name

◆ GetRecentItemList()

_.Library.Status GetRecentItemList	(	_.Library.String	pList,
		_.Library.String	pType
	)

staticprivate

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.

◆ GetRelatedItems()

_.Library.Status GetRelatedItems	(	_.Library.String	pItem,
			pRelItems,
		_.Library.Boolean	pVerbose
	)

staticprivate

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)=""

◆ Import()

_.Library.Status Import	(	_.Library.String	pFile,
		_.Library.Boolean	pReplace,
		_.Library.Boolean	pVerbose,
		_.Library.Boolean	pKill,
		_.Library.String	pForceItemName,
		_.Library.String	pItemsLoaded
	)

staticprivate

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

◆ ImportContainer()

_.Library.Status ImportContainer	(	_.Library.String	pFileName,
		_.Library.Boolean	pReplace,
		_.Library.Boolean	pVerbose
	)

staticprivate

This method may be called to import a container class from an xml file.

This will execute

the <method>OnLoad method if it is defined in the container class.
The pReplace parameter is deprecated in this method but remains for compatibility purposes.

◆ ProcessContainer()

_.Library.Status ProcessContainer	(	_.Library.String	pClass,
		_.Library.Boolean	pReplace,
		_.Library.Boolean	pVerbose,
		_.Library.Boolean	pSuppressForCaller
	)

staticprivate

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.

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteFolderItem()

◆ Dump()

◆ FindFolder()

◆ FolderItemExists()

◆ GetCategoryList()

◆ GetFavoriteList()

◆ GetFolderItemClasses()

◆ GetFolderItemList()

◆ GetFolderList()

◆ GetRecentItemList()

◆ GetRelatedItems()

◆ Import()

◆ ImportContainer()

◆ ProcessContainer()