Class AncestorControl
- 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.AncestorControl
 
 
 
 
 
- 
 public class AncestorControl extends HierarchyControl 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.PropertyControlPropertyControl.ContextProperties
 
- 
 - 
Constructor SummaryConstructors Constructor Description AncestorControl()
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Objectget(java.lang.String propName)Gets the value of the requested property.java.lang.StringgetDataType(java.lang.String propName)Gets the Java type of the value of the provided property.static java.util.ListgetPropertyNames(java.lang.String entityTypeName)Gets a list of all supported properties for this model object, AncestorControlstatic java.util.HashSetgetSubTypes()Gets a set of any model objects which extend this model object, AncestorControljava.util.ArrayListgetSuperTypes()Gets a list of any model objects which this model object, AncestorControl, is an extension of.java.lang.StringgetTypeName()Gets the name of this model object, AncestorControlbooleanisSet(java.lang.String propName)Returns true if the requested property is set; false, otherwise.booleanisSubType(java.lang.String superTypeName)Returns a true if the provided model object is one that this model object extends; false, otherwise.voidset(java.lang.String propName, java.lang.Object value)Sets the value of the provided property to the provided value.java.lang.StringtoString()Returns this model object, AncestorControl, and its contents as a Stringvoidunset(java.lang.String propName)Sets the value of the provided property to null.- 
Methods inherited from class com.ibm.wsspi.security.wim.model.HierarchyControlgetLevel, isSetLevel, isSetTreeView, isTreeView, setLevel, setTreeView, unsetLevel, unsetTreeView
 - 
Methods inherited from class com.ibm.wsspi.security.wim.model.SearchControlgetCountLimit, 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.PropertyControlgetContextProperties, getProperties, isSetContextProperties, isSetProperties, unsetContextProperties, unsetProperties
 
- 
 
- 
- 
- 
Method Detail- 
getpublic java.lang.Object get(java.lang.String propName) Gets the value of the requested property.- Overrides:
- getin class- HierarchyControl
- Parameters:
- propName- allowed object is- String
- Returns:
- returned object is Object
 
 - 
isSetpublic boolean isSet(java.lang.String propName) Returns true if the requested property is set; false, otherwise.- Overrides:
- isSetin class- HierarchyControl
- Parameters:
- propName- allowed object is- String
- Returns:
- returned object is boolean
 
 - 
setpublic void set(java.lang.String propName, java.lang.Object value)Sets the value of the provided property to the provided value.- Overrides:
- setin class- HierarchyControl
- Parameters:
- propName- allowed object is- String
- value- allowed object is- Object
 
 - 
unsetpublic void unset(java.lang.String propName) Sets the value of the provided property to null.- Overrides:
- unsetin class- HierarchyControl
- Parameters:
- propName- allowed object is- String
 
 - 
getTypeNamepublic java.lang.String getTypeName() Gets the name of this model object, AncestorControl- Overrides:
- getTypeNamein class- HierarchyControl
- Returns:
- returned object is String
 
 - 
getPropertyNamespublic static java.util.List getPropertyNames(java.lang.String entityTypeName) Gets a list of all supported properties for this model object, AncestorControl- Parameters:
- entityTypeName- allowed object is- String
- Returns:
- returned object is List
 
 - 
getDataTypepublic java.lang.String getDataType(java.lang.String propName) Gets the Java type of the value of the provided property. For example: String, List- Overrides:
- getDataTypein class- HierarchyControl
- Parameters:
- propName- allowed object is- String
- Returns:
- returned object is String
 
 - 
getSuperTypespublic java.util.ArrayList getSuperTypes() Gets a list of any model objects which this model object, AncestorControl, is an extension of.- Overrides:
- getSuperTypesin class- HierarchyControl
- Returns:
- returned object is ArrayList
 
 - 
isSubTypepublic boolean isSubType(java.lang.String superTypeName) Returns a true if the provided model object is one that this model object extends; false, otherwise.- Overrides:
- isSubTypein class- HierarchyControl
- Parameters:
- superTypeName- allowed object is- String
- Returns:
- returned object is boolean
 
 - 
getSubTypespublic static java.util.HashSet getSubTypes() Gets a set of any model objects which extend this model object, AncestorControl- Returns:
- returned object is HashSet
 
 - 
toStringpublic java.lang.String toString() Returns this model object, AncestorControl, and its contents as a String- Overrides:
- toStringin class- HierarchyControl
- Returns:
- returned object is String
 
 
- 
 
-