public interface SaveOperation
store element
with defined options.
The common way to use this operation is to:
Modifier and Type | Field and Description |
---|---|
static OperationType<SaveOperation> |
TYPE
Operation to save a
store element with defined options. |
Modifier and Type | Method and Description |
---|---|
void |
perform(StoreElement element)
Performs this operation on the given element.
|
void |
setComment(String comment)
Defines the comment to be used for saving.
|
void |
setRecursionEnabled(boolean enable)
Defines, whether child elements should be saved, too.
|
void |
setValidationEnabled(boolean enable)
Defines, whether validation shall be performed on the element's data.
|
static final OperationType<SaveOperation> TYPE
store element
with defined options.void setComment(@Nullable String comment)
null
.comment
- The comment to be set.void setRecursionEnabled(boolean enable)
false
.enable
- if true
, child elements of the given element will be saved as well.void setValidationEnabled(boolean enable)
true
.enable
- if true
, data will be validated before saving the element.void perform(@NotNull StoreElement element) throws ElementValidationReportsException, IllegalArgumentException
locked
.element
- The element to be saved.ElementValidationReportsException
- If validating failed.IllegalArgumentException
- If the given element type is not supported.IllegalStateException
- If the given element is not locked.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210