O objeto de dados DeleteControl especifica se exclui os descendentes, se eles
existirem, de uma entidade excluída.
DeleteControl é utilizado para especificar se deve-se excluir qualquer
descendente existente de uma entidade que está sendo excluída.
A estrutura de um objeto de dados DeleteControl consiste em:
- deleteDescendants
- é utilizado para indicar se deve-se ou não excluir os descendentes da entidade,
se ela tiver descendentes. Se essa propriedade estiver definida como true, a
entidade e todos os seus descendentes serão excluídos. Se essa propriedade
estiver definida como false, será emitida uma exceção se a entidade tiver
qualquer descendente.
O valor padrão é false.
- returnDeleted
- é utilizado para indicar se deve-se retornar as entidades que estão realmente excluídas no objeto de dados de saída. O valor padrão é false, o que significa que nenhum objeto de dados de saída será retornado.
Definição de Esquema XML
A seguir, está a definição de esquema XML para o objeto de dados 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>
Objeto de Dados de Amostra
A seguir, um DeleteControl DataObject de amostra, que não tem a propriedade
deleteDescendants definida. Porque o valor padrão é true, esse objeto de dados
é utilizado na API de exclusão para excluir entidades e todos os seus
descendentes:
<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>