com.adobe.forms.common.service

Class DataXMLOptions

java.lang.Object

com.adobe.forms.common.service.DataXMLOptions

public class DataXMLOptions
extends Object

The DataXMLOptions captures the set of parameters to be passed to the DataXMLProvider for getting the data xml for a form. The following options are supported currently dataRef : path of the XML formResource : resource of the Form for which the data is required pagePath : path of the page which renders the form aemFormContainer : If the Form is being embedded inside an AEM Form Container than the path of the AEM Form Container resource. It can be null if the form is not being embedded inside a Container.

Constructor Summary

Constructors

Constructor and Description
DataXMLOptions()
DataXMLOptions(DataOptions dataOptions)

Method Summary

Modifier and Type	Method and Description
org.apache.sling.api.resource.Resource	getAemFormContainer() Container (if any) resource in which the form is being embedded.
String	getDataRef() path of the XML being passed as the sling request parameter or request attribute.
org.apache.sling.api.resource.Resource	getFormResource() Form resource present inside DAM for which the data is required.
String	getPagePath() Path of the page where the form resides.
Map	getParams() Returns the parameter map
String	getServiceName() returns the name of the service to be used for getting the data xml.
DataXMLOptions	setAemFormContainer(org.apache.sling.api.resource.Resource aemFormContainer) Container (if any) resource in which the form is being embedded.
DataXMLOptions	setDataRef(String dataRef) set the path of the XML from where the data has to be obtained
DataXMLOptions	setFormResource(org.apache.sling.api.resource.Resource formResource) Form resource present inside DAM for which the data is required.
DataXMLOptions	setPagePath(String pagePath) Path of the page/profile (for MF) where the form resides.
DataXMLOptions	setParams(Map paramMap) Sets the parameter map.
DataXMLOptions	setServiceName(String serviceName) set the name of the service to be used for getting the data xml.

Constructor Detail

DataXMLOptions

public DataXMLOptions()

DataXMLOptions

public DataXMLOptions(DataOptions dataOptions)

Method Detail

getDataRef

public String getDataRef()

path of the XML being passed as the sling request parameter or request attribute.

Returns:

path of the XML being passed as the sling request parameter or request attribute or null if nothing passed

setDataRef

public DataXMLOptions setDataRef(String dataRef)

set the path of the XML from where the data has to be obtained

Parameters:

dataRef - path of the XML from where the data has to be obtained

Returns:

the same object on which this API is called. This has been done mainly for chaining multiple API calls.

getFormResource

public org.apache.sling.api.resource.Resource getFormResource()

Form resource present inside DAM for which the data is required.

Returns:

resource of the form that is being ren

setFormResource

public DataXMLOptions setFormResource(org.apache.sling.api.resource.Resource formResource)

Form resource present inside DAM for which the data is required.

Parameters:

formResource - Form resource present inside DAM for which the data is required.

Returns:

the same object on which this API is called. This has been done mainly for chaining multiple API calls.

getPagePath

public String getPagePath()

Path of the page where the form resides. For adaptive form it will be the path of the page and for mobile form it will be the path of the profile which is rendering the Form.

Returns:

Path of the page where the form resides

setPagePath

public DataXMLOptions setPagePath(String pagePath)

Path of the page/profile (for MF) where the form resides.

Parameters:

pagePath - Path of the page/profile (for MF) where the form resides.

Returns:

the same object on which this API is called. This has been done mainly for chaining multiple API calls.

getAemFormContainer

public org.apache.sling.api.resource.Resource getAemFormContainer()

Container (if any) resource in which the form is being embedded.

Returns:

container if the form is being embedded otherwise null

setAemFormContainer

public DataXMLOptions setAemFormContainer(org.apache.sling.api.resource.Resource aemFormContainer)

Container (if any) resource in which the form is being embedded.

Parameters:

aemFormContainer - Container (if any) resource in which the form is being embedded.

Returns:

the same object on which this API is called. This has been done mainly for chaining multiple API calls.

getServiceName

public String getServiceName()

returns the name of the service to be used for getting the data xml.

Returns:

name of the service or null if nothing is set

setServiceName

public DataXMLOptions setServiceName(String serviceName)

set the name of the service to be used for getting the data xml. If none provided, all the available service will be queried for the data

Parameters:

serviceName - name of the service to be used for getting the data xml

Returns:

the same object on which this API is called. This has been done mainly for chaining multiple API calls.

getParams

public Map getParams()

Returns the parameter map

Returns:

map containing the parameters

setParams

public DataXMLOptions setParams(Map paramMap)

Sets the parameter map. This parameter map is any custom payload which has to be made available to the prefill service A sample example could be to fetch a map from a request attribute and set it to this params.

Parameters:

paramMap - map of parameters

Returns:

the same object on which this API is called. This has been done mainly for chaining multiple API calls.