Package com.adobe.aem.formsndocuments.service

Interface FMCRUDService

  • public interface FMCRUDService
    Exposes FM CRUD related operations. Operation other than Delete will be added later.

    • Method Detail

      • deleteCRXResource

        void deleteCRXResource​(javax.jcr.Session session,
                       java.lang.String resourcePath)
                throws FormsMgrException
        Deletes a resource from CRX side, be it a folder, form, guide or resource. For forms, guides and resources deletePreprocessors are invoked.
        Parameters:
        session -
        resourcePath - - The path of the resource to be deleted.
        Throws:
        FormsMgrException

      • generateFormsetThumbnail

        void generateFormsetThumbnail​(ResourceResolver resolver,
                              java.lang.String formsetPath)
                       throws FormsMgrException,
                              java.io.IOException
        Generate Thumbnail for Formset
        Parameters:
        resolver -
        formsetPath -
        Throws:
        FormsMgrException
        java.io.IOException

      • createFragmentFromPanel

        java.lang.String createFragmentFromPanel​(ResourceResolver resolver,
                                         JSONObject params)
                                  throws FormsMgrException
        This API is used to create Adaptive Form Fragment from exiting panel of an Adaptive Form. The fragment created is made up of the panel taken as input in params.
        Parameters:
        resolver -
        params -
        Throws:
        FormsMgrException

      • cleanUpForm

        void cleanUpForm​(javax.jcr.Session session,
                 java.lang.String formPath)
          throws FormsMgrException
        This API is used to clean up the unwanted info related to review, analytics, abtest and replication from provided Form To be used in import of packages and copy/paste functionality
        Parameters:
        session - representing JCR session
        formPath - representing repository path to Form
        Throws:
        FormsMgrException

      • cleanUpReviewInfo

        void cleanUpReviewInfo​(javax.jcr.Session session,
                       java.lang.String formPath)
                throws FormsMgrException
        This API is used to clean up unwanted review information of form. To be used in import of packages and copy/paste functionality
        Parameters:
        session - representing JCR session
        formPath - representing repository path to Form
        Throws:
        FormsMgrException

      • cleanUpABTestingInfo

        void cleanUpABTestingInfo​(javax.jcr.Session session,
                          java.lang.String formPath)
                   throws FormsMgrException
        This API is used to clean up the unwanted A/B testing details present on the form and its corresponding cq:Page To be used in import of packages and copy/paste functionality
        Parameters:
        session -
        formPath -
        Throws:
        FormsMgrException

      • cleanUpFormABTestingInfo

        void cleanUpFormABTestingInfo​(javax.jcr.Session session,
                              java.lang.String formPath)
                       throws FormsMgrException
        This API is used to clean up the unwanted A/B testing details present on the form dam:Asset To be used in copy/paste functionality
        Parameters:
        session -
        formPath - path of form dam:asset node
        Throws:
        FormsMgrException

      • cleanUpFormPageABTestingInfo

        void cleanUpFormPageABTestingInfo​(javax.jcr.Session session,
                                  java.lang.String pagePath)
                           throws FormsMgrException
        This API is used to clean up the unwanted A/B testing details present on the form cq:Page To be used in copy/paste functionality
        Parameters:
        session -
        pagePath - path of the cq:Page corresponding Form asset
        Throws:
        FormsMgrException

      • cleanUpAnalyticsInfo

        void cleanUpAnalyticsInfo​(javax.jcr.Session session,
                          java.lang.String formPath)
                   throws FormsMgrException
        This API is used to clean up the unwanted Analytics information present with the form To be used in import of packages and copy/paste functionality
        Parameters:
        session -
        formPath -
        Throws:
        FormsMgrException

      • checkNodeExist

        boolean checkNodeExist​(ResourceResolver resourceResolver,
                       java.lang.String nodePath)
                throws FormsMgrException
        This API is used to check whether a node exists or not
        Parameters:
        resourceResolver -
        nodePath -
        Returns:
        Throws:
        FormsMgrException

      • copyAsset

        void copyAsset​(CopiedAssetInfo copiedAssetInfo,
               java.lang.String sourcePath,
               java.lang.String destinationPath,
               ResourceResolver resourceResolver)
        throws FormsMgrException
        This API is used to copy the asset at destinationPath. It also performs clean up task.
        Parameters:
        copiedAssetInfo -
        sourcePath -
        destinationPath -
        resourceResolver -
        Throws:
        FormsMgrException

      • scheduleFormReplication

        void scheduleFormReplication​(java.lang.String assetPath,
                             java.lang.String updatedAttribute,
                             long updatedTime)
                      throws FormsMgrException
        This API is used to schedule a replication job.
        Parameters:
        assetPath -
        updatedAttribute -
        updatedTime -
        Throws:
        FormsMgrException