Package com.ibm.wsspi.security.wim.model

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.

  • Constructor Details

    • DescendantControl

      public DescendantControl()

  • Method Details

    • get

      public Object get(String propName)
      Gets the value of the requested property
      Overrides:
      get in class HierarchyControl
      Parameters:
      propName - allowed object is String
      Returns:
      returned object is Object

    • isSet

      public boolean isSet(String propName)
      Returns true if the requested property is set; false, otherwise.
      Overrides:
      isSet in class HierarchyControl
      Returns:
      returned object is boolean

    • set

      public void set(String propName, Object value)
      Sets the value of the provided property to the provided value.
      Overrides:
      set in class HierarchyControl
      Parameters:
      propName - allowed object is String
      value - allowed object is Object

    • unset

      public void unset(String propName)
      Sets the value of provided property to null.
      Overrides:
      unset in class HierarchyControl
      Parameters:
      propName - allowed object is String

    • getTypeName

      public String getTypeName()
      Gets the name of this model object, DescendantControl
      Overrides:
      getTypeName in class HierarchyControl
      Returns:
      returned object is String

    • getPropertyNames

      public static List getPropertyNames(String entityTypeName)
      Gets a list of all supported properties for this model object, DescendantControl
      Parameters:
      entityTypeName - allowed object is String
      Returns:
      returned object is List

    • getDataType

      public String getDataType(String propName)
      Gets the Java type of the value of the provided property. For example: String, List
      Overrides:
      getDataType in class HierarchyControl
      Parameters:
      propName - allowed object is String
      Returns:
      returned object is String

    • getSuperTypes

      public ArrayList getSuperTypes()
      Gets a list of any model objects which this model object, DescendantControl, is an extension of.
      Overrides:
      getSuperTypes in class HierarchyControl
      Returns:
      returned object is ArrayList

    • isSubType

      public boolean isSubType(String superTypeName)
      Returns a true if the provided model object is one that this model object extends; false, otherwise.
      Overrides:
      isSubType in class HierarchyControl
      Parameters:
      superTypeName - allowed object is String
      Returns:
      returned object is boolean

    • getSubTypes

      public static HashSet getSubTypes()
      Gets a set of any model objects which extend this model object, DescendantControl
      Returns:
      returned object is HashSet

    • toString

      public String toString()
      Returns this model object, DescendantControl, and its contents as a String
      Overrides:
      toString in class HierarchyControl
      Returns:
      returned object is String