Package de.espirit.firstspirit.store.operations

Interface ReleaseOperation

public interface ReleaseOperation
Operation providing means to release elements on the server.
Since:
5.2.180606, 5.2.180702

  • Field Details

  • Method Details

    • dependentReleaseType

      @NotNull @NotNull ReleaseOperation dependentReleaseType(@Nullable IDProvider.DependentReleaseType dependentReleaseType)
      The dependent type specifying the behaviour for referenced elements of the given releaseStartNode (see IDProvider.DependentReleaseType for details). If null then IDProvider.DependentReleaseType.NO_DEPENDENT_RELEASE is used.
      Parameters:
      dependentReleaseType - see IDProvider.DependentReleaseType
      Returns:
      the current ReleaseOperation object
      Since:
      5.2.180606, 5.2.180702

    • ensureAccessibility

      @NotNull @NotNull ReleaseOperation ensureAccessibility(boolean ensureAccessibility)
      If true each element on the parent path of each element (except for datasets) will be released.
      Parameters:
      ensureAccessibility - if true each element on the parent path of each element (except for datasets) will be released.
      Returns:
      the current ReleaseOperation object
      Since:
      5.2.180606, 5.2.180702

    • recursive

      @NotNull @NotNull ReleaseOperation recursive(boolean recursive)
      If true the subtree of each element (except for datasets) will be released recursive.
      Parameters:
      recursive - if true the subtree of each element (except for datasets) will be released recursive.
      Returns:
      the current ReleaseOperation object
      Since:
      5.2.180606, 5.2.180702

    • checkOnly

      @NotNull @NotNull ReleaseOperation checkOnly(boolean checkOnly)
      Defines if an release should actually be accomplished or only checked.
      Parameters:
      checkOnly - if true the release will only be checked
      Returns:
      the current ReleaseOperation object
      Since:
      5.2.180606, 5.2.180702

    • withComment

      @NotNull @NotNull ReleaseOperation withComment(@Nullable @Nullable String comment)
      The release comment, may be null.
      Parameters:
      comment - the comment for this release
      Returns:
      the current ReleaseOperation object
      Since:
      5.2.180606, 5.2.180702

    • languages

      @Experimental ReleaseOperation languages(@NotNull @NotNull Language... languages)
      Set of languages the release operation should be valid for. If not set or empty, the release operation is valid for all languages.
      Parameters:
      languages - The languages this release operation is valid for, or empty if the release operation is valid for all languages
      Returns:
      the current ReleaseOperation object
      Since:
      5.2.250102

    • perform

      @NotNull @NotNull ReleaseOperation.ReleaseResult perform(@NotNull @NotNull IDProvider... elements) throws Exception
      Performs the operation and releases the given elements on the server. Note that at least one element must be given and all elements must be != null.
      Parameters:
      elements - the elements to be released
      Returns:
      the result of this release operation
      Throws:
      IllegalArgumentException - if the amount of given elements is 0
      NullPointerException - if one of the given elements is null
      Exception - if any server side error occurred during the operations execution
      Since:
      5.2.180606, 5.2.180702

    • perform

      @NotNull @NotNull ReleaseOperation.ReleaseResult perform(@NotNull @NotNull Collection<IDProvider> elements) throws Exception
      Performs the operation and releases the given Collection of elements on the server. Note that at least one element must be given and all elements must be != null.
      Parameters:
      elements - the collection elements to be released
      Returns:
      the result of this release operation
      Throws:
      IllegalArgumentException - if the amount of given elements is 0
      NullPointerException - if one of the given elements is null
      Exception - if any server side error occurred during the operations execution
      Since:
      5.2.180606, 5.2.180702