What is significance of boolean argument in Cluster.Datagrid.CacheLoadParent() catalog function?

What is significance of boolean argument in Cluster.Datagrid.CacheLoadParent() catalog function?

book

Article ID: KB0078774

calendar_today

Updated On:

Products Versions
TIBCO BusinessEvents Enterprise Edition 5.x

Description

The catalog function Cluster.DataGrid.CacheLoadParent() can be used to load a parent by passing child concept instance as argument. But, there is a second argument of type boolean that this function takes that is not clarified in tool tip or documentation. 
 
Function:Cluster.DataGrid.CacheLoadParent
Signature:void CacheLoadParent(Concept cept, boolean recursive)
Description:Loads from cache the parent concepts of the given concept.

Issue/Introduction

What is significance of boolean argument in Cluster.Datagrid.CacheLoadParent() catalog function?

Environment

All Supported Platforms

Resolution

The boolean argument of the CacheLoadParent() call determines if only the immediate parent is loaded or all the parents of the child in question are loaded. So, when argument is set to false only full immediate parent is loaded, when set to true all parents of object in question are loaded.

For instance the boolean really affects the behavior when you have multi-level concept hierarchy (Bike --> contains Wheel Array --> contains Spoke Array). Imagine you called CacheLoadParent(spoke[0],true) this will load complete Bike with all wheels and spokes into working memory. Now imagine the call CacheLoadParent(spoke[0],false) this will only load immediate parent which is wheel with all the spokes.