Package com.flower.docs.service.api.component.convert

Interface ConvertService

  • public interface ConvertService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.flower.docs.domain.folder.Folder convert​(com.flower.docs.domain.component.ComponentReference reference, boolean recursive, boolean flatten)
      Get component content as archive from a ComponentReference
      com.flower.docs.domain.folder.Folder convert​(com.flower.docs.domain.search.Search search, boolean recursive, boolean flatten)
      Get found components content as archive from a search
      com.flower.docs.domain.folder.Folder convert​(java.util.List<com.flower.docs.domain.component.ComponentReference> references, boolean recursive, boolean flatten)
      Get component content as archive from a ComponentReference

    • Method Detail

      • convert

        com.flower.docs.domain.folder.Folder convert​(com.flower.docs.domain.component.ComponentReference reference,
                                             boolean recursive,
                                             boolean flatten)
                                      throws com.flower.docs.domain.exception.FunctionalException,
                                             com.flower.docs.domain.exception.TechnicalException
        Get component content as archive from a ComponentReference
        Parameters:
        reference - The ComponentReference
        recursive - If true, get component content recursively, otherwise keep only its children. (by default:false)
        flatten - If true, keep component data structure, otherwise flatten it. (by default:false)
        Throws:
        com.flower.docs.domain.exception.FunctionalException - If a functional error occurred
        com.flower.docs.domain.exception.TechnicalException - If a technical error occurred

      • convert

        com.flower.docs.domain.folder.Folder convert​(java.util.List<com.flower.docs.domain.component.ComponentReference> references,
                                             boolean recursive,
                                             boolean flatten)
                                      throws com.flower.docs.domain.exception.FunctionalException,
                                             com.flower.docs.domain.exception.TechnicalException
        Get component content as archive from a ComponentReference
        Parameters:
        reference - The ComponentReference
        recursive - If true, get component content recursively, otherwise keep only its children. (by default:false)
        flatten - If true, keep component data structure, otherwise flatten it. (by default:false)
        Throws:
        com.flower.docs.domain.exception.FunctionalException - If a functional error occurred
        com.flower.docs.domain.exception.TechnicalException - If a technical error occurred

      • convert

        com.flower.docs.domain.folder.Folder convert​(com.flower.docs.domain.search.Search search,
                                             boolean recursive,
                                             boolean flatten)
                                      throws com.flower.docs.domain.exception.FunctionalException,
                                             com.flower.docs.domain.exception.TechnicalException
        Get found components content as archive from a search
        Parameters:
        search - The search to find components
        recursive - If true, get found components content recursively, otherwise keep only found components. (by default:false)
        flatten - If true, keep component data structure, otherwise flatten it. (by default:false)
        Throws:
        com.flower.docs.domain.exception.FunctionalException - If a functional error occurred
        com.flower.docs.domain.exception.TechnicalException - If a technical error occurred