public class HierarchyControl extends SearchControl
Java class for HierarchyControl complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="HierarchyControl"> <complexContent> <extension base="{http://www.ibm.com/websphere/wim}SearchControl"> <attribute name="level" type="{http://www.w3.org/2001/XMLSchema}int" default="1" /> <attribute name="treeView" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" /> </extension> </complexContent> </complexType>
The HierarchyControl object extends the SearchControl object.
It is an abstract control, which means it is not directly used in the Root object. Instead, its descendants: AncestorControl, DescendantControl, GroupMemberControl and GroupMembershipControl are used in the Root object.
HierarchyControl contains all of properties of SearchControl. Additionally, it contains the following properties: level and treeView.
The property level is used to indicate the level of the hierarchy to be returned. It has different meaning in the different descendants of HierarchyControl. As examples, in DescendantControl, it indicates the level of descendants. In GroupMembershipControl, level indicates the level of nested groups.
The property treeView is used to indicate whether or not to return the hierarchy structure in the output Root object. It also has different meaning in the different descendants of HierarchyControl. For example, in GroupMembershipControl, if treeView is set to true, the output Root object will contain the tree structure of the nested groups. If it is set to false, all groups (including immediate groups and nested groups) are added to the groups properties of the entity in a flat structure. The default value for treeView is set to false.
PropertyControl.ContextProperties
Constructor and Description |
---|
HierarchyControl() |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
get(java.lang.String propName)
Gets the value of the requested property
|
java.lang.String |
getDataType(java.lang.String propName)
Gets the Java type of the value of the provided property.
|
int |
getLevel()
Gets the value of the level property.
|
static java.util.List |
getPropertyNames(java.lang.String entityTypeName)
Gets a list of all supported properties for this model object, HierarchyControl
|
static java.util.HashSet |
getSubTypes()
Gets a set of any model objects which extend this model object, HierarchyControl
|
java.util.ArrayList |
getSuperTypes()
Gets a list of any model objects which this model object, HierarchyControl, is
an extension of.
|
java.lang.String |
getTypeName()
Gets the name of this model object, HierarchyControl
|
boolean |
isSet(java.lang.String propName)
Returns true if the requested property is set; false, otherwise.
|
boolean |
isSetLevel()
Returns true if the level property is set; false, otherwise.
|
boolean |
isSetTreeView()
Returns true if the treeView property is set; false, otherwise.
|
boolean |
isSubType(java.lang.String superTypeName)
Returns a true if the provided model object is one that this
model object extends; false, otherwise.
|
boolean |
isTreeView()
Gets the value of the treeView property.
|
void |
set(java.lang.String propName,
java.lang.Object value)
Sets the value of the provided property to the provided value.
|
void |
setLevel(int value)
Sets the value of the level property.
|
void |
setTreeView(boolean value)
Sets the value of the treeView property.
|
java.lang.String |
toString()
Returns this model object, HierarchyControl, and its contents as a String
|
void |
unset(java.lang.String propName)
Sets the value of provided property to null.
|
void |
unsetLevel()
Resets the level property to null.
|
void |
unsetTreeView()
Resets the treeView property to null.
|
getCountLimit, getExpression, getSearchBases, getSearchLimit, getTimeLimit, isReturnSubType, isSetCountLimit, isSetExpression, isSetReturnSubType, isSetSearchBases, isSetSearchLimit, isSetTimeLimit, setCountLimit, setExpression, setReturnSubType, setSearchLimit, setTimeLimit, unsetCountLimit, unsetReturnSubType, unsetSearchBases, unsetSearchLimit, unsetTimeLimit
getContextProperties, getProperties, isSetContextProperties, isSetProperties, unsetContextProperties, unsetProperties
public int getLevel()
Integer
public void setLevel(int value)
value
- allowed object is Integer
public boolean isSetLevel()
boolean
public void unsetLevel()
public boolean isTreeView()
Boolean
public void setTreeView(boolean value)
value
- allowed object is Boolean
public boolean isSetTreeView()
boolean
public void unsetTreeView()
public java.lang.Object get(java.lang.String propName)
get
in class SearchControl
propName
- allowed object is String
Object
public boolean isSet(java.lang.String propName)
Control
isSet
in class SearchControl
boolean
public void set(java.lang.String propName, java.lang.Object value)
set
in class SearchControl
propName
- allowed object is String
value
- allowed object is Object
public void unset(java.lang.String propName)
unset
in class SearchControl
propName
- allowed object is String
public java.lang.String getTypeName()
getTypeName
in class SearchControl
String
public static java.util.List getPropertyNames(java.lang.String entityTypeName)
entityTypeName
- allowed object is String
List
public java.lang.String getDataType(java.lang.String propName)
getDataType
in class SearchControl
propName
- allowed object is String
String
public java.util.ArrayList getSuperTypes()
getSuperTypes
in class SearchControl
ArrayList
public boolean isSubType(java.lang.String superTypeName)
isSubType
in class SearchControl
superTypeName
- allowed object is String
boolean
public static java.util.HashSet getSubTypes()
HashSet
public java.lang.String toString()
toString
in class SearchControl
String