public interface ReleaseOperation
elements
on the server.Modifier and Type | Interface and Description |
---|---|
static interface |
ReleaseOperation.ReleaseResult
Interface representing the result of the
release operation . |
Modifier and Type | Field and Description |
---|---|
static OperationType<ReleaseOperation> |
TYPE
The operation's type.
|
Modifier and Type | Method and Description |
---|---|
ReleaseOperation |
checkOnly(boolean checkOnly)
Defines if an release should actually be accomplished or only checked.
|
ReleaseOperation |
dependentReleaseType(IDProvider.DependentReleaseType dependentReleaseType)
The dependent type specifying the behaviour for referenced elements of the given releaseStartNode (see
IDProvider.DependentReleaseType for details). |
ReleaseOperation |
ensureAccessibility(boolean ensureAccessibility)
If
true each element on the parent path of each element (except for datasets) will be released. |
ReleaseOperation.ReleaseResult |
perform(Collection<IDProvider> elements)
Performs the operation and releases the given
Collection of elements on the server. |
ReleaseOperation.ReleaseResult |
perform(IDProvider... elements)
Performs the operation and releases the given
elements on the server. |
ReleaseOperation |
recursive(boolean recursive)
If
true the subtree of each element (except for datasets) will be released recursive. |
ReleaseOperation |
withComment(String comment)
The release comment, may be
null . |
static final OperationType<ReleaseOperation> TYPE
@NotNull ReleaseOperation dependentReleaseType(@Nullable IDProvider.DependentReleaseType dependentReleaseType)
IDProvider.DependentReleaseType
for details).
If null
then IDProvider.DependentReleaseType.NO_DEPENDENT_RELEASE
is used.dependentReleaseType
- see IDProvider.DependentReleaseType
@NotNull ReleaseOperation ensureAccessibility(boolean ensureAccessibility)
true
each element on the parent path of each element (except for datasets) will be released.ensureAccessibility
- if true
each element on the parent path of each element (except for datasets) will be released.@NotNull ReleaseOperation recursive(boolean recursive)
true
the subtree of each element (except for datasets) will be released recursive.recursive
- if true
the subtree of each element (except for datasets) will be released recursive.@NotNull ReleaseOperation checkOnly(boolean checkOnly)
checkOnly
- if true
the release will only be checked@NotNull ReleaseOperation withComment(@Nullable String comment)
null
.comment
- the comment for this release@NotNull ReleaseOperation.ReleaseResult perform(@NotNull IDProvider... elements) throws Exception
elements
on the server. Note that at least one element
must be given and all elements must be != null.elements
- the elements
to be releasedIllegalArgumentException
- 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 execution@NotNull ReleaseOperation.ReleaseResult perform(@NotNull Collection<IDProvider> elements) throws Exception
Collection
of elements
on the server. Note that at least one element
must be given and all elements must be != null.elements
- the collection elements
to be releasedIllegalArgumentException
- 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