Class: CategorySearchDetails

tibco.objectapi.bds.CategorySearchDetails

new CategorySearchDetails()

Parameters for searching for category(s). Constructs a new CategorySearchDetails.

The following features are supported:

Members

childDepth :number

Number of levels of child categories to get beneath the matching category(s). -1 for unlimited depth. Omit to get no children. This property holds the value of the 'Child Depth' attribute.
Type:
  • number

childrenOnly :boolean

In conjunction with childDepth, if set true, this omits the category itself and only obtains children. This property holds the value of the 'Children Only' attribute.
Type:
  • boolean

name :string

Slash-separated path to the category in the hierarchy. If omitted, will match all top-level categories This property holds the value of the 'Name' attribute.
Type:
  • string