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

Class DeleteControl

java.lang.Object
com.ibm.wsspi.security.wim.model.Control
com.ibm.wsspi.security.wim.model.DeleteControl
public class DeleteControl extends Control

Java class for DeleteControl complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="DeleteControl">
 <complexContent>
 <extension base="{http://www.ibm.com/websphere/wim}Control">
 <attribute name="deleteDescendants" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
 <attribute name="returnDeleted" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
 </extension>
 </complexContent>
 </complexType>

The DeleteControl object extends the Control object.

DeleteControl is used for specifying whether or not to delete descendants if the entity to be deleted has descendants. It contains two properties: deleteDescendants and returnDeleted.

  • deleteDescendants: indicates whether or not delete the descendants of the entity if it has descendants.
    • true: the entity and all of its descendants will be deleted. This is the default value.
    • false: an exception will be thrown if the entity has any descendants.
  • returnDeleted: indicates whether or not to return the entities which are actually deleted in the output Root object. The default value is false, which means no output Root object is returned.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DeleteControl()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    get(String propName)
    Gets the value of the requested property
    String
    getDataType(String propName)
    Gets the Java type of the value of the provided property.
    static List
    getPropertyNames(String entityTypeName)
    Gets a list of all supported properties for this model object, DeleteControl
    static HashSet
    getSubTypes()
    Gets a set of any model objects which extend this model object, DeleteControl
    ArrayList
    getSuperTypes()
    Gets a list of any model objects which this model object, DeleteControl, is an extension of.
    String
    getTypeName()
    Gets the name of this model object, DeleteControl
    boolean
    isDeleteDescendants()
    Gets the value of the deleteDescendants property.
    boolean
    isReturnDeleted()
    Gets the value of the returnDeleted property.
    boolean
    isSet(String propName)
    Returns true if the requested property is set; false, otherwise.
    boolean
    isSetDeleteDescendants()
    Returns true if the deleteDescendants property is set; false, otherwise.
    boolean
    isSetReturnDeleted()
    Returns true if the returnDeleted property is set; false, otherwise.
    boolean
    isSubType(String superTypeName)
    Returns a true if the provided model object is one that this model object extends; false, otherwise.
    void
    set(String propName, Object value)
    Sets the value of the provided property to the provided value.
    void
    setDeleteDescendants(boolean value)
    Sets the value of the deleteDescendants property.
    void
    setReturnDeleted(boolean value)
    Sets the value of the returnDeleted property.
    String
    toString()
    Returns this model object, DeleteControl, and its contents as a String
    void
    unset(String propName)
    Sets the value of provided property to null.
    void
    unsetDeleteDescendants()
    Resets the deleteDescendants property to null.
    void
    unsetReturnDeleted()
    Resets the returnDeleted property to null.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • DeleteControl

      public DeleteControl()

  • Method Details

    • isDeleteDescendants

      public boolean isDeleteDescendants()
      Gets the value of the deleteDescendants property.
      Returns:
      possible object is Boolean

    • setDeleteDescendants

      public void setDeleteDescendants(boolean value)
      Sets the value of the deleteDescendants property.
      Parameters:
      value - allowed object is Boolean

    • isSetDeleteDescendants

      public boolean isSetDeleteDescendants()
      Returns true if the deleteDescendants property is set; false, otherwise.
      Returns:
      returned object is boolean

    • unsetDeleteDescendants

      public void unsetDeleteDescendants()
      Resets the deleteDescendants property to null.

    • isReturnDeleted

      public boolean isReturnDeleted()
      Gets the value of the returnDeleted property.
      Returns:
      possible object is Boolean

    • setReturnDeleted

      public void setReturnDeleted(boolean value)
      Sets the value of the returnDeleted property.
      Parameters:
      value - allowed object is Boolean

    • isSetReturnDeleted

      public boolean isSetReturnDeleted()
      Returns true if the returnDeleted property is set; false, otherwise.
      Returns:
      returned object is boolean

    • unsetReturnDeleted

      public void unsetReturnDeleted()
      Resets the returnDeleted property to null.

    • get

      public Object get(String propName)
      Gets the value of the requested property
      Overrides:
      get in class Control
      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 Control
      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 Control
      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 Control
      Parameters:
      propName - allowed object is String

    • getTypeName

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

    • getPropertyNames

      public static List getPropertyNames(String entityTypeName)
      Gets a list of all supported properties for this model object, DeleteControl
      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 Control
      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, DeleteControl, is an extension of.
      Overrides:
      getSuperTypes in class Control
      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 Control
      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, DeleteControl
      Returns:
      returned object is HashSet

    • toString

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