Class DescendantControl
- 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
-
- com.ibm.wsspi.security.wim.model.DescendantControl
-
public class DescendantControl extends HierarchyControl
Java class for DescendantControl complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="DescendantControl"> <complexContent> <extension base="{http://www.ibm.com/websphere/wim}HierarchyControl"> </extension> </complexContent> </complexType>
The DescendantControl object extends the HierarchyControl object.
It is used in the input Root object of the get() API to request descendants of the entity. If the DescendantControl object is added to the Root object in a get() API call, this means the descendants of the entities under the Root object will be returned in the returning Root object.
Besides indicating whether or not to return descendants, DescendantControl can also be used for specifying the properties to be returned for descendants as well as the level of descendants to be returned.
- level
- 0: return all descendants
- 1: return only the children
- greater than 1: return the specified number of descendants. For example, a level set to 2 will return both the children and the granchildren.
Since DescendantControl is also extended from SearchControl, it is possible to specify other search properties like countLimit, and timeLimit in DescendantControl to only return the descendants which satisfies the search criteria. For example, adding the property expression with value: @xsi:type='Person' to only return the descendants which are of the Person entity type.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.ibm.wsspi.security.wim.model.PropertyControl
PropertyControl.ContextProperties
-
-
Constructor Summary
Constructors Constructor Description DescendantControl()
-
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.static java.util.List
getPropertyNames(java.lang.String entityTypeName)
Gets a list of all supported properties for this model object, DescendantControlstatic java.util.HashSet
getSubTypes()
Gets a set of any model objects which extend this model object, DescendantControljava.util.ArrayList
getSuperTypes()
Gets a list of any model objects which this model object, DescendantControl, is an extension of.java.lang.String
getTypeName()
Gets the name of this model object, DescendantControlboolean
isSet(java.lang.String propName)
Returns true if the requested 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.void
set(java.lang.String propName, java.lang.Object value)
Sets the value of the provided property to the provided value.java.lang.String
toString()
Returns this model object, DescendantControl, and its contents as a Stringvoid
unset(java.lang.String propName)
Sets the value of provided property to null.-
Methods inherited from class com.ibm.wsspi.security.wim.model.HierarchyControl
getLevel, isSetLevel, isSetTreeView, isTreeView, setLevel, setTreeView, unsetLevel, unsetTreeView
-
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
-
get
public java.lang.Object get(java.lang.String propName)
Gets the value of the requested property- Overrides:
get
in classHierarchyControl
- Parameters:
propName
- allowed object isString
- Returns:
- returned object is
Object
-
isSet
public boolean isSet(java.lang.String propName)
Returns true if the requested property is set; false, otherwise.- Overrides:
isSet
in classHierarchyControl
- 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 classHierarchyControl
- 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 classHierarchyControl
- Parameters:
propName
- allowed object isString
-
getTypeName
public java.lang.String getTypeName()
Gets the name of this model object, DescendantControl- Overrides:
getTypeName
in classHierarchyControl
- 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, DescendantControl- 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 classHierarchyControl
- 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, DescendantControl, is an extension of.- Overrides:
getSuperTypes
in classHierarchyControl
- 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 classHierarchyControl
- 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, DescendantControl- Returns:
- returned object is
HashSet
-
toString
public java.lang.String toString()
Returns this model object, DescendantControl, and its contents as a String- Overrides:
toString
in classHierarchyControl
- Returns:
- returned object is
String
-
-