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.
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.
PropertyControl.ContextProperties
Constructor and Description |
---|
AncestorControl() |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
get(java.lang.String propName)
Gets the value of the requested property.
|
java.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, AncestorControl
|
static java.util.HashSet |
getSubTypes()
Gets a set of any model objects which extend this model object, AncestorControl
|
java.util.ArrayList |
getSuperTypes()
Gets a list of any model objects which this model object, AncestorControl,
is an extension of.
|
java.lang.String |
getTypeName()
Gets the name of this model object, AncestorControl
|
boolean |
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, AncestorControl, and its contents as a String
|
void |
unset(java.lang.String propName)
Sets the value of the provided property to null.
|
getLevel, isSetLevel, isSetTreeView, isTreeView, setLevel, setTreeView, unsetLevel, unsetTreeView
getCountLimit, getExpression, getSearchBases, getSearchLimit, getTimeLimit, isReturnSubType, isSetCountLimit, isSetExpression, isSetReturnSubType, isSetSearchBases, isSetSearchLimit, isSetTimeLimit, setCountLimit, setExpression, setReturnSubType, setSearchLimit, setTimeLimit, unsetCountLimit, unsetReturnSubType, unsetSearchBases, unsetSearchLimit, unsetTimeLimit
getContextProperties, getProperties, isSetContextProperties, isSetProperties, unsetContextProperties, unsetProperties
public java.lang.Object get(java.lang.String propName)
get
in class HierarchyControl
propName
- allowed object is String
Object
public boolean isSet(java.lang.String propName)
isSet
in class HierarchyControl
propName
- allowed object is String
boolean
public void set(java.lang.String propName, java.lang.Object value)
set
in class HierarchyControl
propName
- allowed object is String
value
- allowed object is Object
public void unset(java.lang.String propName)
unset
in class HierarchyControl
propName
- allowed object is String
public java.lang.String getTypeName()
getTypeName
in class HierarchyControl
String
public static java.util.List getPropertyNames(java.lang.String entityTypeName)
entityTypeName
- allowed object is String
List
public java.lang.String getDataType(java.lang.String propName)
getDataType
in class HierarchyControl
propName
- allowed object is String
String
public java.util.ArrayList getSuperTypes()
getSuperTypes
in class HierarchyControl
ArrayList
public boolean isSubType(java.lang.String superTypeName)
isSubType
in class HierarchyControl
superTypeName
- allowed object is String
boolean
public static java.util.HashSet getSubTypes()
HashSet
public java.lang.String toString()
toString
in class HierarchyControl
String