Das Datenobjekt "DeleteControl" gibt an, ob eventuell vorhandene untergeordnete Elemente einer gelöschten Entität gelöscht werden sollen.
Mit "DeleteControl" wird angegeben, ob gegebenenfalls vorhandene untergeordnete Elemente einer Entität, die gerade gelöscht wird, ebenfalls gelöscht werden sollen.
Die Struktur des Datenobjekts "DeleteControl" hat folgende Bestandteile:
- deleteDescendants
- Gibt an, ob die untergeordneten Elemente der betreffenden Entität gelöscht werden sollen, sofern vorhanden. Wenn dieses Merkmal auf "true" (wahr) gesetzt wird, werden die Entität und sämtliche untergeordneten Elemente gelöscht. Wenn das Merkmal auf "false" (falsch) gesetzt wird, wird eine Ausnahmebedingung ausgelöst, wenn die Entität untergeordnete Elemente hat.
Der Standardwert ist "false".
- returnDeleted
- Gibt an, ob die eigentlich gelöschten Entitäten im Ausgabedatenobjekt zurückgegeben werden sollen. Der Standardwert ist auf "false" gesetzt, was bedeutet, dass kein Ausgabedatenobjekt zurückgegeben wird.
XML-Schemadefinition
Nachfolgend finden Sie die XML-Schemadefinition für das Datenobjekt "DeleteControl":
<xsd:complexType name="DeleteControl">
<xsd:complexContent>
<xsd:extension base="Control">
<xsd:attribute name="deleteDescendants" type="xsd:boolean" default="true"/>
<xsd:attribute name="returnDeleted" type="xsd:boolean" default="false"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Beispieldatenobjekt
Unten sehen Sie ein Beispiel für ein Datenobjekt "DeleteControl", für das das Merkmal "deleteDescendants" nicht definiert wurde. Da der Standardwert auf "true" gesetzt ist, wird dieses Datenobjekt in der API "delete" verwendet, um Entitäten und all ihre untergeordnten Elemente zu löschen:
<wim:Root>
<wim:entities>
<wim:identifier uniqueName="o=Sales,cn=users,dc=yourco,dc=com"/>
</wim:entities>
<wim:controls xsi:type="wim:DeleteControl" />
</wim:Root>