public interface DeleteOperation
elements
on the server.Modifier and Type | Interface and Description |
---|---|
static interface |
DeleteOperation.Result
Interface representing the result of the
delete operation . |
Modifier and Type | Field and Description |
---|---|
static OperationType<DeleteOperation> |
TYPE
The operation's type.
|
Modifier and Type | Method and Description |
---|---|
DeleteOperation |
ignoreIncomingReferences(boolean ignoreIncomingReferences)
Sets whether incoming references should be ignored when deleting elements or not.
|
DeleteOperation.Result |
perform(IDProvider... elements)
Performs the operation and deletes the given elements on the server.
|
static final OperationType<DeleteOperation> TYPE
@NotNull DeleteOperation ignoreIncomingReferences(boolean ignoreIncomingReferences)
false
, incoming references will be checked and trying to delete elements with incoming references will fail. Those elements will be contained in DeleteOperation.Result.getReferencedElements()
.true
, incoming references will be ignored during the deletion process.
default: false = do NOT ignore references
@NotNull DeleteOperation.Result perform(@NotNull IDProvider... elements) throws Exception
IllegalArgumentException
- if the amount of given elements is 0NullPointerException
- if one of the given elements is nullException
- if any server side error occurred during the operations executionCopyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210