Package io.jmix.webdav.service

Interface WebdavDocumentVersionsManagementService

All Known Implementing Classes:
WebdavDocumentVersionsManagementServiceImpl
@NullMarked public interface WebdavDocumentVersionsManagementService
Service for working with document versions.

  • Method Details

    • retrieveFirstVersionByWebdavDocumentId

      @Nullable WebdavDocumentVersion retrieveFirstVersionByWebdavDocumentId(UUID documentId)
      Returns the first document version.
      Returns:
      null if a document version is not found

    • retrieveFirstVersionByWebdavDocumentIdNN

      WebdavDocumentVersion retrieveFirstVersionByWebdavDocumentIdNN(UUID documentId)
      Returns the first document version.
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveFirstVersionByWebdavDocumentId

      @Nullable WebdavDocumentVersion retrieveFirstVersionByWebdavDocumentId(UUID documentId, String fetchPlanName)
      Returns the first document version.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveFirstVersionByWebdavDocumentIdNN

      WebdavDocumentVersion retrieveFirstVersionByWebdavDocumentIdNN(UUID documentId, String fetchPlanName)
      Returns the first document version.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveFirstVersionByWebdavDocumentId

      @Nullable WebdavDocumentVersion retrieveFirstVersionByWebdavDocumentId(UUID documentId, FetchPlan fetchPlan)
      Returns the first document version.
      Parameters:
      fetchPlan - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveFirstVersionByWebdavDocumentIdNN

      WebdavDocumentVersion retrieveFirstVersionByWebdavDocumentIdNN(UUID documentId, FetchPlan fetchPlan)
      Returns the first document version.
      Parameters:
      fetchPlan - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveFirstVersionByWebdavDocument

      @Nullable WebdavDocumentVersion retrieveFirstVersionByWebdavDocument(WebdavDocument document)
      Returns the first document version.
      Returns:
      null if a document version is not found

    • retrieveFirstVersionByWebdavDocumentNN

      WebdavDocumentVersion retrieveFirstVersionByWebdavDocumentNN(WebdavDocument document)
      Returns the first document version.
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveFirstVersionByWebdavDocument

      @Nullable WebdavDocumentVersion retrieveFirstVersionByWebdavDocument(WebdavDocument document, String fetchPlanName)
      Returns the first document version.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveFirstVersionByWebdavDocumentNN

      WebdavDocumentVersion retrieveFirstVersionByWebdavDocumentNN(WebdavDocument document, String fetchPlanName)
      Returns the first document version.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveFirstVersionByWebdavDocument

      @Nullable WebdavDocumentVersion retrieveFirstVersionByWebdavDocument(WebdavDocument document, FetchPlan fetchPlan)
      Returns the first document version.
      Parameters:
      fetchPlan - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveFirstVersionByWebdavDocumentNN

      WebdavDocumentVersion retrieveFirstVersionByWebdavDocumentNN(WebdavDocument document, FetchPlan fetchPlan)
      Returns the first document version.
      Parameters:
      fetchPlan - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveLastVersionByWebdavDocumentId

      @Nullable WebdavDocumentVersion retrieveLastVersionByWebdavDocumentId(UUID documentId)
      Returns the last document version.
      Returns:
      document version with LOCAL fetch plan or null if document version not found

    • retrieveLastVersionByWebdavDocumentIdNN

      WebdavDocumentVersion retrieveLastVersionByWebdavDocumentIdNN(UUID documentId)
      Returns the last document version.
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveLastVersionByWebdavDocumentId

      @Nullable WebdavDocumentVersion retrieveLastVersionByWebdavDocumentId(UUID documentId, String fetchPlanName)
      Returns the last document version.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveLastVersionByWebdavDocumentIdNN

      WebdavDocumentVersion retrieveLastVersionByWebdavDocumentIdNN(UUID documentId, String fetchPlanName)
      Returns the last document version.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveLastVersionByWebdavDocumentId

      @Nullable WebdavDocumentVersion retrieveLastVersionByWebdavDocumentId(UUID documentId, FetchPlan fetchPlan)
      Returns the last document version.
      Parameters:
      fetchPlan - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveLastVersionByWebdavDocumentIdNN

      WebdavDocumentVersion retrieveLastVersionByWebdavDocumentIdNN(UUID documentId, FetchPlan fetchPlan)
      Returns the last document version.
      Parameters:
      fetchPlan - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveLastVersionByWebdavDocument

      @Nullable WebdavDocumentVersion retrieveLastVersionByWebdavDocument(WebdavDocument document)
      Returns the last document version.
      Returns:
      null if a document version is not found

    • retrieveLastVersionByWebdavDocumentNN

      WebdavDocumentVersion retrieveLastVersionByWebdavDocumentNN(WebdavDocument document)
      Returns the last document version.
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveLastVersionByWebdavDocument

      @Nullable WebdavDocumentVersion retrieveLastVersionByWebdavDocument(WebdavDocument document, String fetchPlanName)
      Returns the last document version.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveLastVersionByWebdavDocumentNN

      WebdavDocumentVersion retrieveLastVersionByWebdavDocumentNN(WebdavDocument document, String fetchPlanName)
      Returns the last document version.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveLastVersionByWebdavDocument

      @Nullable WebdavDocumentVersion retrieveLastVersionByWebdavDocument(WebdavDocument document, FetchPlan fetchPlan)
      Returns the last document version.
      Parameters:
      fetchPlan - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveLastVersionByWebdavDocumentNN

      WebdavDocumentVersion retrieveLastVersionByWebdavDocumentNN(WebdavDocument document, FetchPlan fetchPlan)
      Returns the last document version.
      Parameters:
      fetchPlan - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveLastVersionByWebdavDocumentVersionId

      @Nullable WebdavDocumentVersion retrieveLastVersionByWebdavDocumentVersionId(UUID documentVersionId)
      Returns the last document version. It finds related document and gets last version for it.
      Returns:
      null if a document version is not found

    • retrieveLastVersionByWebdavDocumentVersionIdNN

      WebdavDocumentVersion retrieveLastVersionByWebdavDocumentVersionIdNN(UUID documentVersionId)
      Returns the last document version. It finds related document and gets last version for it.
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveLastVersionByWebdavDocumentVersionId

      @Nullable WebdavDocumentVersion retrieveLastVersionByWebdavDocumentVersionId(UUID documentVersionId, String fetchPlanName)
      Returns the last document version by version id. It finds related document and gets last version for it.
      Parameters:
      fetchPlanName - a returned document version
      Returns:
      null if a document version is not found

    • retrieveLastVersionByWebdavDocumentVersionIdNN

      WebdavDocumentVersion retrieveLastVersionByWebdavDocumentVersionIdNN(UUID documentVersionId, String fetchPlanName)
      Returns the last document version. It finds related document and gets last version for it.
      Parameters:
      fetchPlanName - a returned document version
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveLastVersionByWebdavDocumentVersionId

      @Nullable WebdavDocumentVersion retrieveLastVersionByWebdavDocumentVersionId(UUID documentVersionId, FetchPlan fetchPlan)
      Returns the last document version. It finds related document and gets last version for it.
      Parameters:
      fetchPlan - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveLastVersionByWebdavDocumentVersionIdNN

      WebdavDocumentVersion retrieveLastVersionByWebdavDocumentVersionIdNN(UUID documentVersionId, FetchPlan fetchPlan)
      Returns the last document version. It finds related document and gets last version for it.
      Parameters:
      fetchPlan - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveLastVersionByWebdavDocumentVersion

      @Nullable WebdavDocumentVersion retrieveLastVersionByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)
      Returns the last document version. It finds related document and gets last version for it.
      Returns:
      null if a document version is not found

    • retrieveLastVersionByWebdavDocumentVersionNN

      WebdavDocumentVersion retrieveLastVersionByWebdavDocumentVersionNN(WebdavDocumentVersion documentVersion)
      Returns the last document version. It finds related document and gets last version for it.
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveLastVersionByWebdavDocumentVersion

      @Nullable WebdavDocumentVersion retrieveLastVersionByWebdavDocumentVersion(WebdavDocumentVersion documentVersion, String fetchPlanName)
      Returns the last document version. It finds related document and gets last version for it.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveLastVersionByWebdavDocumentVersionNN

      WebdavDocumentVersion retrieveLastVersionByWebdavDocumentVersionNN(WebdavDocumentVersion documentVersion, String fetchPlanName)
      Returns the last document version. It finds related document and gets last version for it.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document is version not found

    • retrieveLastVersionByWebdavDocumentVersion

      @Nullable WebdavDocumentVersion retrieveLastVersionByWebdavDocumentVersion(WebdavDocumentVersion documentVersion, FetchPlan fetchPlan)
      Returns the last document version. It finds related document and gets last version for it.
      Parameters:
      fetchPlan - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveLastVersionByWebdavDocumentVersionNN

      WebdavDocumentVersion retrieveLastVersionByWebdavDocumentVersionNN(WebdavDocumentVersion documentVersion, FetchPlan fetchPlan)
      Returns the last document version. It finds related document and gets last version for it.
      Parameters:
      fetchPlan - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document is version not found

    • retrieveConcreteVersionByWebdavDocumentVersionId

      @Nullable WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentVersionId(UUID documentVersionId)
      Returns concrete document version.
      Returns:
      null if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentVersionIdNN

      WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentVersionIdNN(UUID documentVersionId)
      Returns a concrete document version.
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentVersionId

      @Nullable WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentVersionId(UUID documentVersionId, String fetchPlanName)
      Returns a concrete document version.
      Parameters:
      fetchPlanName - a reloaded document fetch plan
      Returns:
      null if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentVersionIdNN

      WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentVersionIdNN(UUID documentVersionId, String fetchPlanName)
      Returns a concrete document version.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentVersionId

      @Nullable WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentVersionId(UUID documentVersionId, FetchPlan fetchPlan)
      Returns a concrete version.
      Returns:
      null if a document version not found

    • retrieveConcreteVersionByWebdavDocumentVersionIdNN

      WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentVersionIdNN(UUID documentVersionId, FetchPlan fetchPlan)
      Returns a concrete version.
      Parameters:
      fetchPlan - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentIdAndNaturalId

      @Nullable WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentIdAndNaturalId(UUID documentId, Long naturalIdentifier)
      Returns a concrete version by document id and natural version identifier.
      Returns:
      null if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentIdAndNaturalIdNN

      WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentIdAndNaturalIdNN(UUID documentId, Long naturalIdentifier)
      Returns a concrete version by document id and natural version identifier.
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentIdAndNaturalId

      @Nullable WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentIdAndNaturalId(UUID documentId, Long naturalIdentifier, String fetchPlanName)
      Returns a concrete version by document id and natural version identifier.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentIdAndNaturalIdNN

      WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentIdAndNaturalIdNN(UUID documentId, Long naturalIdentifier, String fetchPlanName)
      Returns a concrete version by a document id and natural version identifier.
      Parameters:
      fetchPlanName - a returned document fetch plan
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentIdAndNaturalId

      @Nullable WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentIdAndNaturalId(UUID documentId, Long naturalIdentifier, FetchPlan fetchPlan)
      Returns a concrete version by a document id and natural version identifier.
      Parameters:
      fetchPlan - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentIdAndNaturalIdNN

      WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentIdAndNaturalIdNN(UUID documentId, Long naturalIdentifier, FetchPlan fetchPlan)
      Returns a concrete version by a document id and natural version identifier.
      Parameters:
      fetchPlan - a returned document fetch plan
      Returns:
      null if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentAndNaturalId

      @Nullable WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentAndNaturalId(WebdavDocument document, Long naturalIdentifier)
      Returns a concrete version by a document and natural version identifier.
      Returns:
      null if a document version us not found

    • retrieveConcreteVersionByWebdavDocumentAndNaturalIdNN

      WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentAndNaturalIdNN(WebdavDocument document, Long naturalIdentifier)
      Returns a concrete document version by a document and natural version identifier.
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentAndNaturalId

      @Nullable WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentAndNaturalId(WebdavDocument document, Long naturalIdentifier, String fetchPlanName)
      Returns a concrete document version by a document and natural version identifier.
      Returns:
      null if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentAndNaturalIdNN

      WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentAndNaturalIdNN(WebdavDocument document, Long naturalIdentifier, String fetchPlanName)
      Returns a concrete document version by a document and natural version identifier.
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentAndNaturalId

      @Nullable WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentAndNaturalId(WebdavDocument document, Long naturalIdentifier, FetchPlan fetchPlan)
      Returns a concrete document version by a document and natural version identifier.
      Returns:
      null if a document version is not found

    • retrieveConcreteVersionByWebdavDocumentAndNaturalIdNN

      WebdavDocumentVersion retrieveConcreteVersionByWebdavDocumentAndNaturalIdNN(WebdavDocument document, Long naturalIdentifier, FetchPlan fetchPlan)
      Returns a concrete document version by a document and natural version identifier.
      Throws:
      WebdavDocumentNotFoundException - if a document version is not found

    • retrieveAllVersionsByWebdavDocumentId

      List<WebdavDocumentVersion> retrieveAllVersionsByWebdavDocumentId(UUID documentId)
      Returns all document versions.

    • retrieveAllVersionsByWebdavDocumentId

      List<WebdavDocumentVersion> retrieveAllVersionsByWebdavDocumentId(UUID documentId, String fetchPlanName)
      Returns all document versions.
      Parameters:
      fetchPlanName - a returned document fetch plan

    • retrieveAllVersionsByWebdavDocumentId

      List<WebdavDocumentVersion> retrieveAllVersionsByWebdavDocumentId(UUID documentId, FetchPlan fetchPlan)
      Returns all document versions.
      Parameters:
      fetchPlan - a returned document fetch plan

    • retrieveAllVersionsByWebdavDocument

      List<WebdavDocumentVersion> retrieveAllVersionsByWebdavDocument(WebdavDocument document)
      Returns all document versions.

    • retrieveAllVersionsByWebdavDocument

      List<WebdavDocumentVersion> retrieveAllVersionsByWebdavDocument(WebdavDocument document, String fetchPlanName)
      Returns all document versions.
      Parameters:
      fetchPlanName - a returned document fetch plan

    • retrieveAllVersionsByWebdavDocument

      List<WebdavDocumentVersion> retrieveAllVersionsByWebdavDocument(WebdavDocument document, FetchPlan fetchPlan)
      Returns all document versions.
      Parameters:
      fetchPlan - a returned document fetch plan

    • retrieveAllVersionsByWebdavDocumentVersionId

      List<WebdavDocumentVersion> retrieveAllVersionsByWebdavDocumentVersionId(UUID documentVersionId)
      Returns all document versions. It finds related document and gets list of versions for it.

    • retrieveAllVersionsByWebdavDocumentVersionId

      List<WebdavDocumentVersion> retrieveAllVersionsByWebdavDocumentVersionId(UUID documentVersionId, String fetchPlanName)
      Returns all document versions. It finds related document and gets list of versions for it.
      Parameters:
      fetchPlanName - a returned document fetch plan

    • retrieveAllVersionsByWebdavDocumentVersionId

      List<WebdavDocumentVersion> retrieveAllVersionsByWebdavDocumentVersionId(UUID documentVersionId, FetchPlan fetchPlan)
      Returns all document versions. It finds related document and gets list of versions for it.
      Parameters:
      fetchPlan - a returned document fetch plan

    • retrieveAllVersionsByWebdavDocumentVersion

      List<WebdavDocumentVersion> retrieveAllVersionsByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)
      Returns all document versions. It finds related document and gets list of versions for it.

    • retrieveAllVersionsByWebdavDocumentVersion

      List<WebdavDocumentVersion> retrieveAllVersionsByWebdavDocumentVersion(WebdavDocumentVersion documentVersion, String fetchPlanName)
      Returns all document versions. It finds related document and gets list of versions for it.
      Parameters:
      fetchPlanName - a returned document fetch plan

    • retrieveAllVersionsByWebdavDocumentVersion

      List<WebdavDocumentVersion> retrieveAllVersionsByWebdavDocumentVersion(WebdavDocumentVersion documentVersion, FetchPlan fetchPlan)
      Returns all document versions. It finds related document and gets list of versions for it.
      Parameters:
      fetchPlan - a returned document fetch plan

    • createVersionByFileRef

      WebdavDocumentVersion createVersionByFileRef(FileRef fileRef)
      Creates a document version by a file reference.
      Returns:
      a new document version without document and natural version identifier

    • createVersionBasedOnVersionId

      WebdavDocumentVersion createVersionBasedOnVersionId(UUID documentVersionId)
      Creates a document version by a file descriptor in base version. The base version is found by id.
      Returns:
      a new document version without document and natural version identifier

    • createVersionBasedOnVersion

      WebdavDocumentVersion createVersionBasedOnVersion(WebdavDocumentVersion documentVersion)
      Creates document version by a file reference in base version. The base version is found by version instance.
      Returns:
      a new document version without document and natural version identifier

    • createVersionBasedOnDocumentIdAndNaturalVersionId

      WebdavDocumentVersion createVersionBasedOnDocumentIdAndNaturalVersionId(UUID documentId, Long naturalIdentifier)
      Creates a document version by a file descriptor in base version. The base version is found by document id and natural version identifier.
      Returns:
      a new document version without document and natural version identifier

    • createVersionBasedOnDocumentAndNaturalVersionId

      WebdavDocumentVersion createVersionBasedOnDocumentAndNaturalVersionId(WebdavDocument document, Long naturalIdentifier)
      Creates a document version by a file descriptor in base version. The base version is found by document and natural version identifier.
      Returns:
      a new document version without document and natural version identifier

    • retrieveVersionsFollowingByWebdavDocumentVersion

      List<WebdavDocumentVersion> retrieveVersionsFollowingByWebdavDocumentVersion(UUID documentId, Long version)
      Returns document versions following the specific version number.

    • retrieveVersionsFollowingByWebdavDocumentVersion

      List<WebdavDocumentVersion> retrieveVersionsFollowingByWebdavDocumentVersion(UUID documentId, Long version, String fetchPlanName)
      Returns document versions following the specific version number.
      Parameters:
      fetchPlanName - a returned document fetch plan

    • retrieveVersionsFollowingByWebdavDocumentVersion

      List<WebdavDocumentVersion> retrieveVersionsFollowingByWebdavDocumentVersion(UUID documentId, Long version, FetchPlan fetchPlan)
      Returns document versions following the specific version number.
      Parameters:
      fetchPlan - a returned document fetch plan