Class HierarchyControl
- java.lang.Object
-
- com.ibm.wsspi.security.wim.model.Control
-
- com.ibm.wsspi.security.wim.model.PropertyControl
-
- com.ibm.wsspi.security.wim.model.SearchControl
-
- com.ibm.wsspi.security.wim.model.HierarchyControl
-
- Direct Known Subclasses:
AncestorControl
,DescendantControl
,GroupControl
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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.ibm.wsspi.security.wim.model.PropertyControl
PropertyControl.ContextProperties
-
-
Constructor Summary
Constructors Constructor Description HierarchyControl()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
get(java.lang.String propName)
Gets the value of the requested propertyjava.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, HierarchyControlstatic java.util.HashSet
getSubTypes()
Gets a set of any model objects which extend this model object, HierarchyControljava.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, HierarchyControlboolean
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 Stringvoid
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.-
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, unsetTimeLimit
-
Methods inherited from class com.ibm.wsspi.security.wim.model.PropertyControl
getContextProperties, getProperties, isSetContextProperties, isSetProperties, unsetContextProperties, unsetProperties
-
-
-
-
Method Detail
-
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
public java.lang.Object get(java.lang.String propName)
Gets the value of the requested property- Overrides:
get
in classSearchControl
- Parameters:
propName
- allowed object isString
- Returns:
- returned object is
Object
-
isSet
public boolean isSet(java.lang.String propName)
Description copied from class:Control
Returns true if the requested property is set; false, otherwise.- Overrides:
isSet
in classSearchControl
- Returns:
- returned object is
boolean
-
set
public void set(java.lang.String propName, java.lang.Object value)
Sets the value of the provided property to the provided value.- Overrides:
set
in classSearchControl
- Parameters:
propName
- allowed object isString
value
- allowed object isObject
-
unset
public void unset(java.lang.String propName)
Sets the value of provided property to null.- Overrides:
unset
in classSearchControl
- Parameters:
propName
- allowed object isString
-
getTypeName
public java.lang.String getTypeName()
Gets the name of this model object, HierarchyControl- Overrides:
getTypeName
in classSearchControl
- Returns:
- returned object is
String
-
getPropertyNames
public static java.util.List getPropertyNames(java.lang.String entityTypeName)
Gets a list of all supported properties for this model object, HierarchyControl- Parameters:
entityTypeName
- allowed object isString
- Returns:
- returned object is
List
-
getDataType
public java.lang.String getDataType(java.lang.String propName)
Gets the Java type of the value of the provided property. For example: String, List- Overrides:
getDataType
in classSearchControl
- Parameters:
propName
- allowed object isString
- Returns:
- returned object is
String
-
getSuperTypes
public java.util.ArrayList getSuperTypes()
Gets a list of any model objects which this model object, HierarchyControl, is an extension of.- Overrides:
getSuperTypes
in classSearchControl
- Returns:
- returned object is
ArrayList
-
isSubType
public boolean isSubType(java.lang.String superTypeName)
Returns a true if the provided model object is one that this model object extends; false, otherwise.- Overrides:
isSubType
in classSearchControl
- Parameters:
superTypeName
- allowed object isString
- Returns:
- returned object is
boolean
-
getSubTypes
public static java.util.HashSet getSubTypes()
Gets a set of any model objects which extend this model object, HierarchyControl- Returns:
- returned object is
HashSet
-
toString
public java.lang.String toString()
Returns this model object, HierarchyControl, and its contents as a String- Overrides:
toString
in classSearchControl
- Returns:
- returned object is
String
-
-