getHierChildProps()

Retrieves all child properties for the hierarchical connector configuration property.

Syntax

public CWProperty[] getHierChildProps();

Parameters

None.

Return values

A reference to an array of CWProperty objects, each of which represents one connector property in the hierarchical connector property. If the hierarchical connector property does not contain any child properties, the method returns null.

Exceptions

None.

Notes

The getHierChildProps() method retrieves all child properties for the hierarchical connector configuration property. The retrieved properties are only those of the children of the current hierarchical property; they do not include any grandchildren, great-grandchildren, and so on. To retrieve child properties at lower levels in the hierarchy, you must first obtain the connector-property object for a property at a particular level and then use a method such as getHierChildProps() or getHierChildProp() to retrieve its children.

Note:
You can use the getHierProp() to retrieve a specified child, grandchild, and so on down the property hierarchy.

Before a call to getHierChildProps(), you can use the hasChildren() method to verify that the hierarchical connector property has child properties. To retrieve a specified child property, use the getHierChildProp() method. To retrieve all child properties with a specified prefix, you can use the getChildPropsWithPrefix() method. To retrieve all string values, use the getStringValues() method.

See also

getChildPropsWithPrefix(),, getHierChildProp(),, getHierProp(),, getStringValues(),, hasChildren(),, setValues()

Copyright IBM Corporation 1997, 2004. All Rights Reserved.