com.adobe.aem.formsndocuments.service

Interface FMCRUDService

public interface FMCRUDService

Exposes FM CRUD related operations. Operation other than Delete will be added later.

Method Summary

Modifier and Type	Method and Description
boolean	checkNodeExist(ResourceResolver resourceResolver, java.lang.String nodePath) This API is used to check whether a node exists or not
void	cleanUpABTestingInfo(Session session, java.lang.String formPath) 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
void	cleanUpAnalyticsInfo(Session session, java.lang.String formPath) 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
void	cleanUpForm(Session session, java.lang.String formPath) 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
void	cleanUpFormABTestingInfo(Session session, java.lang.String formPath) 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
void	cleanUpFormPageABTestingInfo(Session session, java.lang.String pagePath) 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
void	cleanUpReviewInfo(Session session, java.lang.String formPath) This API is used to clean up unwanted review information of form.
void	copyAsset(CopiedAssetInfo copiedAssetInfo, java.lang.String sourcePath, java.lang.String destinationPath, ResourceResolver resourceResolver) This API is used to copy the asset at destinationPath.
Asset	createAsset(ResourceResolver resolver, JSONObject assetJSON) Create the Dam Asset
void	createFDM(ResourceResolver resolver, JSONObject assetJson) This API is used to create FDM asset.
void	createFormset(ResourceResolver resolver, JSONObject assetJSON) Create the formset
java.lang.String	createFragmentFromPanel(ResourceResolver resolver, JSONObject params) This API is used to create Adaptive Form Fragment from exiting panel of an Adaptive Form.
void	createTheme(ResourceResolver resolver, JSONObject themeJson, JSONObject themeContentJson) This API is used to create Theme Asset.
void	deleteCRXResource(Session session, java.lang.String resourcePath) Deletes a resource from CRX side, be it a folder, form, guide or resource.
void	generateFormsetThumbnail(ResourceResolver resolver, java.lang.String formsetPath) Generate Thumbnail for Formset
void	scheduleFormReplication(java.lang.String assetPath, java.lang.String updatedAttribute, long updatedTime) This API is used to schedule a replication job.
void	updateFDMSources(ResourceResolver resolver, java.lang.String path, java.lang.String cqConf, JSONArray assetJson) This API is used to update FDM sources
void	updateFormset(ResourceResolver resolver, JSONObject assetJSON) Update the formset
void	updateThemeClientlib(ResourceResolver resolver, RequestParameterMap paramMap) Updates theme clientlib.

Method Detail

deleteCRXResource

void deleteCRXResource(Session session,
                       java.lang.String resourcePath)
                throws com.adobe.aemforms.fm.exception.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:

com.adobe.aemforms.fm.exception.FormsMgrException

createFormset

void createFormset(ResourceResolver resolver,
                   JSONObject assetJSON)
            throws com.adobe.aemforms.fm.exception.FormsMgrException,
                   java.io.IOException

Create the formset

Parameters:

resolver -

assetJSON -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

java.io.IOException

createAsset

Asset createAsset(ResourceResolver resolver,
                  JSONObject assetJSON)
           throws com.adobe.aemforms.fm.exception.FormsMgrException

Create the Dam Asset

Parameters:

resolver -

assetJSON -

Returns:

Dam Asset will be returned.

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

updateFormset

void updateFormset(ResourceResolver resolver,
                   JSONObject assetJSON)
            throws com.adobe.aemforms.fm.exception.FormsMgrException

Update the formset

Parameters:

resolver -

assetJSON -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

generateFormsetThumbnail

void generateFormsetThumbnail(ResourceResolver resolver,
                              java.lang.String formsetPath)
                       throws com.adobe.aemforms.fm.exception.FormsMgrException,
                              java.io.IOException

Generate Thumbnail for Formset

Parameters:

resolver -

formsetPath -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

java.io.IOException

createFragmentFromPanel

java.lang.String createFragmentFromPanel(ResourceResolver resolver,
                                         JSONObject params)
                                  throws com.adobe.aemforms.fm.exception.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:

com.adobe.aemforms.fm.exception.FormsMgrException

cleanUpForm

void cleanUpForm(Session session,
                 java.lang.String formPath)
          throws com.adobe.aemforms.fm.exception.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:

com.adobe.aemforms.fm.exception.FormsMgrException

cleanUpReviewInfo

void cleanUpReviewInfo(Session session,
                       java.lang.String formPath)
                throws com.adobe.aemforms.fm.exception.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:

com.adobe.aemforms.fm.exception.FormsMgrException

cleanUpABTestingInfo

void cleanUpABTestingInfo(Session session,
                          java.lang.String formPath)
                   throws com.adobe.aemforms.fm.exception.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:

com.adobe.aemforms.fm.exception.FormsMgrException

cleanUpFormABTestingInfo

void cleanUpFormABTestingInfo(Session session,
                              java.lang.String formPath)
                       throws com.adobe.aemforms.fm.exception.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:

com.adobe.aemforms.fm.exception.FormsMgrException

cleanUpFormPageABTestingInfo

void cleanUpFormPageABTestingInfo(Session session,
                                  java.lang.String pagePath)
                           throws com.adobe.aemforms.fm.exception.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:

com.adobe.aemforms.fm.exception.FormsMgrException

cleanUpAnalyticsInfo

void cleanUpAnalyticsInfo(Session session,
                          java.lang.String formPath)
                   throws com.adobe.aemforms.fm.exception.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:

com.adobe.aemforms.fm.exception.FormsMgrException

createTheme

void createTheme(ResourceResolver resolver,
                 JSONObject themeJson,
                 JSONObject themeContentJson)
          throws com.adobe.aemforms.fm.exception.FormsMgrException

This API is used to create Theme Asset.

Parameters:

resolver -

themeJson -

themeContentJson -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

checkNodeExist

boolean checkNodeExist(ResourceResolver resourceResolver,
                       java.lang.String nodePath)
                throws com.adobe.aemforms.fm.exception.FormsMgrException

This API is used to check whether a node exists or not

Parameters:

resourceResolver -

nodePath -

Returns:

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

copyAsset

void copyAsset(CopiedAssetInfo copiedAssetInfo,
               java.lang.String sourcePath,
               java.lang.String destinationPath,
               ResourceResolver resourceResolver)
        throws com.adobe.aemforms.fm.exception.FormsMgrException

This API is used to copy the asset at destinationPath. It also performs clean up task.

Parameters:

copiedAssetInfo -

sourcePath -

destinationPath -

resourceResolver -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

createFDM

void createFDM(ResourceResolver resolver,
               JSONObject assetJson)
        throws com.adobe.aemforms.fm.exception.FormsMgrException

This API is used to create FDM asset.

Parameters:

resolver -

assetJson -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

scheduleFormReplication

void scheduleFormReplication(java.lang.String assetPath,
                             java.lang.String updatedAttribute,
                             long updatedTime)
                      throws com.adobe.aemforms.fm.exception.FormsMgrException

This API is used to schedule a replication job.

Parameters:

assetPath -

updatedAttribute -

updatedTime -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

updateFDMSources

void updateFDMSources(ResourceResolver resolver,
                      java.lang.String path,
                      java.lang.String cqConf,
                      JSONArray assetJson)
               throws com.adobe.aemforms.fm.exception.FormsMgrException

This API is used to update FDM sources

Parameters:

resolver -

path -

assetJson -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

updateThemeClientlib

void updateThemeClientlib(ResourceResolver resolver,
                          RequestParameterMap paramMap)
                   throws com.adobe.aemforms.fm.exception.FormsMgrException

Updates theme clientlib.

Parameters:

resolver -

paramMap -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException