Class AncestorControl
Java class for AncestorControl complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="AncestorControl">
<complexContent>
<extension base="{http://www.ibm.com/websphere/wim}HierarchyControl">
</extension>
</complexContent>
</complexType>
The AncestorControl object extends the HierarchyControl object.
AncestorControl is used in the input Root object of the get() API to request ancestors of the entity. If AncestorControl is added to the Root object in the get() operation, this means the ancestors of the entities under the Root object will be returned in the returning Root object.
Besides indicating whether or not to return ancestors, AncestorControl can also be used for specifying the properties returned for ancestors as well as the level of ancestor to be returned.
- 0 - return all ancestors
- 1 - return only the parent
- 2 - return the parent and grandparent
- Any level greater than 2 will return that specified number of ancestors
Since AncestorControl is also extended from SearchControl, it is possible to specify other search properties such as countLimit, and timeLimit in AncestorControl to only return the ancestors which satisfies the search criteria.
-
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 property.getDataType(String propName) Gets the Java type of the value of the provided property.static ListgetPropertyNames(String entityTypeName) Gets a list of all supported properties for this model object, AncestorControlstatic HashSetGets a set of any model objects which extend this model object, AncestorControlGets a list of any model objects which this model object, AncestorControl, is an extension of.Gets the name of this model object, AncestorControlbooleanReturns true if the requested property is set; false, otherwise.booleanReturns a true if the provided model object is one that this model object extends; false, otherwise.voidSets the value of the provided property to the provided value.toString()Returns this model object, AncestorControl, and its contents as a StringvoidSets the value of the provided property to null.Methods inherited from class com.ibm.wsspi.security.wim.model.HierarchyControl
getLevel, isSetLevel, isSetTreeView, isTreeView, setLevel, setTreeView, unsetLevel, unsetTreeViewMethods 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
-
AncestorControl
public AncestorControl()
-
-
Method Details
-
get
Gets the value of the requested property.- Overrides:
getin classHierarchyControl- Parameters:
propName- allowed object isString- Returns:
- returned object is
Object
-
isSet
Returns true if the requested property is set; false, otherwise.- Overrides:
isSetin classHierarchyControl- Parameters:
propName- allowed object isString- Returns:
- returned object is
boolean
-
set
Sets the value of the provided property to the provided value.- Overrides:
setin classHierarchyControl- Parameters:
propName- allowed object isStringvalue- allowed object isObject
-
unset
Sets the value of the provided property to null.- Overrides:
unsetin classHierarchyControl- Parameters:
propName- allowed object isString
-
getTypeName
Gets the name of this model object, AncestorControl- Overrides:
getTypeNamein classHierarchyControl- Returns:
- returned object is
String
-
getPropertyNames
Gets a list of all supported properties for this model object, AncestorControl -
getDataType
Gets the Java type of the value of the provided property. For example: String, List- Overrides:
getDataTypein classHierarchyControl- Parameters:
propName- allowed object isString- Returns:
- returned object is
String
-
getSuperTypes
Gets a list of any model objects which this model object, AncestorControl, is an extension of.- Overrides:
getSuperTypesin classHierarchyControl- 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 classHierarchyControl- Parameters:
superTypeName- allowed object isString- Returns:
- returned object is
boolean
-
getSubTypes
Gets a set of any model objects which extend this model object, AncestorControl- Returns:
- returned object is
HashSet
-
toString
Returns this model object, AncestorControl, and its contents as a String- Overrides:
toStringin classHierarchyControl- Returns:
- returned object is
String
-