Utility methods for DeepSee Dashboards. More...

Inheritance diagram for Utils:

[legend]

Collaboration diagram for Utils:

[legend]

Static Private Member Functions
_.Library.Integer	DashboardExists (_.Library.String pFullName, _.Library.String pID)
	Check if a there is a dashboard definition with the given name. More...

_.Library.Boolean	DeleteDashboard (_.Library.String pFullName)
	Delete the dashboard definition with the given full name.

_.Library.Status	DeleteTheme (_.Library.String pThemeName)
	Delete the given "theme".

_.Library.Status	DoesFilterSupportRange (_.Library.String pDataSource, _.Library.String pFilter, _.Library.Boolean pSupportsRange)
	Tests if a given filter supports range selection (used by the searchBox control).

_.Library.Status	GetCaptionForTargetProperty (_.Library.String pDataSource, _.Library.String pTarget, _.Library.String pCaption)
	Return the caption for the given target property within the given data source. More...

_.Library.Status	GetDashboardActionList (_.Library.String pAction, _.Library.String pDataSource)
	Return list of possible dashboard actions. More...

_.Library.Status	GetFiltersForDataSource (_.Library.String pDataSource, _.Library.List pFilters, pVisited, _.Library.String pParent, _.Library.String pSearchKey, _.Library.Integer pMaxDepth, _.Library.Integer pLevel)
	Return list of possible filters for a given dashboard data source. More...

_.Library.String	GetKpiFilterCaption (pKPIName, pSpec)
	Lookup a filter caption for a KPI.

_.Library.Status	GetListingsForDataSource (_.Library.String pDataSource, _.Library.List pListings, _.Library.String pType)
	Return list of possible listings for a given dashboard data source. More...

_.Library.Status	GetMemberDimensionType (_.Library.String pDataSource, _.Library.String pFilter, _.Library.String pType, _.Library.String pMemberClass, _.Library.String pOtherInfo)
	Find the dimension type for a given dashboard data source and filter. More...

_.Library.Status	GetMembersForFilter (_.Library.String pDataSource, _.Library.String pFilter, _.Library.List pMembers, _.Library.String pDefaultValue, _.Library.String pSearchKey, pRelatedFilters, _.Library.Boolean pCalcOnly, _.Library.Boolean pRangeMode, _.Library.String pPreSelected)
	Return list of possible filter member values for a given dashboard data source and filter. More...

_.Library.Status	GetPivotVariablesForDataSource (_.Library.String pDataSource, _.Library.List pVariables)
	Return list of possible pivot variables for a given dashboard data source. More...

_.Library.Status	GetPropertiesForDataSource (_.Library.String pDataSource, _.Library.List pProperties)
	Return list of possible data properties for a given dashboard data source. More...

_.Library.Status	GetThemeList (_.Library.String pList, _.Library.Integer pCount, _.Library.Integer pMaxItems)
	Return an array of saved themes visible to the current user. More...

_.Library.String	GetWidgetClass (_.Library.String pWidgetType)
	Find the class name for the given widget type.

_.Library.Status	GetWidgetClasses (_.Library.String pInfo)
	Return an array of all available widget types. More...

_.Library.Status	GetWidgetTemplateList (_.Library.String pList, _.Library.Integer pCount, _.Library.Integer pMaxItems)
	Return an array of widget templates visible to the current user. More...

_.DeepSee.Dashboard.Definition	OpenDashboard (_.Library.String pFullName, _.Library.Status pStatus)
	Open the dashboard definition with the given full name.

_.Library.Status	SaveTheme (_.Library.String pThemeName, _.ZEN.proxyObject pOverrides)
	Save a set of style overrides to the given "theme".

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

Utility methods for DeepSee Dashboards.

Member Function Documentation

◆ DashboardExists()

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

staticprivate

Check if a there is a dashboard definition 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.

◆ GetCaptionForTargetProperty()

_.Library.Status GetCaptionForTargetProperty	(	_.Library.String	pDataSource,
		_.Library.String	pTarget,
		_.Library.String	pCaption
	)

staticprivate

Return the caption for the given target property within the given data source.

This is used to translate the logical name for a filter to its display value.

◆ GetDashboardActionList()

_.Library.Status GetDashboardActionList	(	_.Library.String	pAction,
		_.Library.String	pDataSource
	)

staticprivate

Return list of possible dashboard actions.

This takes the form:
pAction(n)=$LB(name,caption,tooltip,type)
type specifies the data associated with the action (if any). This value is passed along as the targetProperty of the action.
"filter", the action controls the given filter.
"url", the action requires a url.
"dashboard", the action requires a dashboard.

The control for each action is determined by the CreateControls method in the DashboardViewer class.
The actions are dispatched to widget by the dashboardEventHandler method in the DashboardViewer class.

◆ GetFiltersForDataSource()

_.Library.Status GetFiltersForDataSource	(	_.Library.String	pDataSource,
		_.Library.List	pFilters,
			pVisited,
		_.Library.String	pParent,
		_.Library.String	pSearchKey,
		_.Library.Integer	pMaxDepth,
		_.Library.Integer	pLevel
	)

staticprivate

Return list of possible filters for a given dashboard data source.

This takes the form:
pFilters(n)=$LB(caption,value,type)
type is the dimension type: "" (data),"year","month","day", etc.
pVisited is used to prevent cycles when visiting related cubes.
pMaxDepth is maximum depth of relations to follow. A value of 0 means there is no limit to the depth of relationships.

◆ GetListingsForDataSource()

_.Library.Status GetListingsForDataSource	(	_.Library.String	pDataSource,
		_.Library.List	pListings,
		_.Library.String	pType
	)

staticprivate

Return list of possible listings for a given dashboard data source.

This takes the form:
pListings(n)=$LB(caption,value,type)

◆ GetMemberDimensionType()

_.Library.Status GetMemberDimensionType	(	_.Library.String	pDataSource,
		_.Library.String	pFilter,
		_.Library.String	pType,
		_.Library.String	pMemberClass,
		_.Library.String	pOtherInfo
	)

staticprivate

Find the dimension type for a given dashboard data source and filter.

Also returns the member class.

◆ GetMembersForFilter()

_.Library.Status GetMembersForFilter	(	_.Library.String	pDataSource,
		_.Library.String	pFilter,
		_.Library.List	pMembers,
		_.Library.String	pDefaultValue,
		_.Library.String	pSearchKey,
			pRelatedFilters,
		_.Library.Boolean	pCalcOnly,
		_.Library.Boolean	pRangeMode,
		_.Library.String	pPreSelected
	)

staticprivate

Return list of possible filter member values for a given dashboard data source and filter.

This takes the form:
pMembers(n)=$LB(text,value,[description])
If pSearchKey is provided, then only return members that match the search key. If pRelatedFilters is provided, it is an array of other filter values to use to restrict the set of members. It takes the form:
pRelatedFilters(spec) = key
If pCalcOnly is true, then only return calculated members.
If pRangeMode is true, then only return members that are valid for range selection (used by searchBox).
If pPreSelected is a list of selected values; always display these items.

◆ GetPivotVariablesForDataSource()

_.Library.Status GetPivotVariablesForDataSource	(	_.Library.String	pDataSource,
		_.Library.List	pVariables
	)

staticprivate

Return list of possible pivot variables for a given dashboard data source.

This takes the form:
pVariables(n) = $LB(name,caption,defValue,context)

◆ GetPropertiesForDataSource()

_.Library.Status GetPropertiesForDataSource	(	_.Library.String	pDataSource,
		_.Library.List	pProperties
	)

staticprivate

Return list of possible data properties for a given dashboard data source.

This takes the form:
pProperties(n)=name

◆ GetThemeList()

_.Library.Status GetThemeList	(	_.Library.String	pList,
		_.Library.Integer	pCount,
		_.Library.Integer	pMaxItems
	)

staticprivate

Return an array of saved themes visible to the current user.

This list is in the form:
pList(n) = $LG(id,fullName,name)

◆ GetWidgetClasses()

_.Library.Status GetWidgetClasses ( _.Library.String pInfo )

staticprivate

Return an array of all available widget types.

pInfo(n) = $LB(name,caption,class,icon)

◆ GetWidgetTemplateList()

_.Library.Status GetWidgetTemplateList	(	_.Library.String	pList,
		_.Library.Integer	pCount,
		_.Library.Integer	pMaxItems
	)

staticprivate

Return an array of widget templates visible to the current user.

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

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DashboardExists()

◆ GetCaptionForTargetProperty()

◆ GetDashboardActionList()

◆ GetFiltersForDataSource()

◆ GetListingsForDataSource()

◆ GetMemberDimensionType()

◆ GetMembersForFilter()

◆ GetPivotVariablesForDataSource()

◆ GetPropertiesForDataSource()

◆ GetThemeList()

◆ GetWidgetClasses()

◆ GetWidgetTemplateList()