Class HierarchyControl
- Direct Known Subclasses:
AncestorControl,DescendantControl,GroupControl
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.ibm.wsspi.security.wim.model.PropertyControl
PropertyControl.ContextProperties -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the requested propertygetDataType(String propName) Gets the Java type of the value of the provided property.intgetLevel()Gets the value of the level property.static ListgetPropertyNames(String entityTypeName) Gets a list of all supported properties for this model object, HierarchyControlstatic HashSetGets a set of any model objects which extend this model object, HierarchyControlGets a list of any model objects which this model object, HierarchyControl, is an extension of.Gets the name of this model object, HierarchyControlbooleanReturns true if the requested property is set; false, otherwise.booleanReturns true if the level property is set; false, otherwise.booleanReturns true if the treeView property is set; false, otherwise.booleanReturns a true if the provided model object is one that this model object extends; false, otherwise.booleanGets the value of the treeView property.voidSets the value of the provided property to the provided value.voidsetLevel(int value) Sets the value of the level property.voidsetTreeView(boolean value) Sets the value of the treeView property.toString()Returns this model object, HierarchyControl, and its contents as a StringvoidSets the value of provided property to null.voidResets the level property to null.voidResets the treeView property to null.Methods inherited from class com.ibm.wsspi.security.wim.model.SearchControl
getCountLimit, getExpression, getSearchBases, getSearchLimit, getTimeLimit, isReturnSubType, isSetCountLimit, isSetExpression, isSetReturnSubType, isSetSearchBases, isSetSearchLimit, isSetTimeLimit, setCountLimit, setExpression, setReturnSubType, setSearchLimit, setTimeLimit, unsetCountLimit, unsetReturnSubType, unsetSearchBases, unsetSearchLimit, unsetTimeLimitMethods inherited from class com.ibm.wsspi.security.wim.model.PropertyControl
getContextProperties, getProperties, isSetContextProperties, isSetProperties, unsetContextProperties, unsetProperties
-
Constructor Details
-
HierarchyControl
public HierarchyControl()
-
-
Method Details
-
getLevel
public int getLevel()Gets the value of the level property.- Returns:
- possible object is
Integer
-
setLevel
public void setLevel(int value) Sets the value of the level property.- Parameters:
value- allowed object isInteger
-
isSetLevel
public boolean isSetLevel()Returns true if the level property is set; false, otherwise.- Returns:
- returned object is
boolean
-
unsetLevel
public void unsetLevel()Resets the level property to null. -
isTreeView
public boolean isTreeView()Gets the value of the treeView property.- Returns:
- possible object is
Boolean
-
setTreeView
public void setTreeView(boolean value) Sets the value of the treeView property.- Parameters:
value- allowed object isBoolean
-
isSetTreeView
public boolean isSetTreeView()Returns true if the treeView property is set; false, otherwise.- Returns:
- returned object is
boolean
-
unsetTreeView
public void unsetTreeView()Resets the treeView property to null. -
get
Gets the value of the requested property- Overrides:
getin classSearchControl- Parameters:
propName- allowed object isString- Returns:
- returned object is
Object
-
isSet
Description copied from class:ControlReturns true if the requested property is set; false, otherwise.- Overrides:
isSetin classSearchControl- Returns:
- returned object is
boolean
-
set
Sets the value of the provided property to the provided value.- Overrides:
setin classSearchControl- Parameters:
propName- allowed object isStringvalue- allowed object isObject
-
unset
Sets the value of provided property to null.- Overrides:
unsetin classSearchControl- Parameters:
propName- allowed object isString
-
getTypeName
Gets the name of this model object, HierarchyControl- Overrides:
getTypeNamein classSearchControl- Returns:
- returned object is
String
-
getPropertyNames
Gets a list of all supported properties for this model object, HierarchyControl -
getDataType
Gets the Java type of the value of the provided property. For example: String, List- Overrides:
getDataTypein classSearchControl- Parameters:
propName- allowed object isString- Returns:
- returned object is
String
-
getSuperTypes
Gets a list of any model objects which this model object, HierarchyControl, is an extension of.- Overrides:
getSuperTypesin classSearchControl- Returns:
- returned object is
ArrayList
-
isSubType
Returns a true if the provided model object is one that this model object extends; false, otherwise.- Overrides:
isSubTypein classSearchControl- Parameters:
superTypeName- allowed object isString- Returns:
- returned object is
boolean
-
getSubTypes
Gets a set of any model objects which extend this model object, HierarchyControl- Returns:
- returned object is
HashSet
-
toString
Returns this model object, HierarchyControl, and its contents as a String- Overrides:
toStringin classSearchControl- Returns:
- returned object is
String
-