Package com.adobe.forms.common.service

Class DataXMLOptions

  • public class DataXMLOptions
extends java.lang.Object
    Deprecated.
    use #DataOptions
    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 Detail

      • DataXMLOptions

        public DataXMLOptions()
        Deprecated.

      • DataXMLOptions

        public DataXMLOptions​(DataOptions dataOptions)
        Deprecated.

    • Method Detail

      • getDataRef

        public java.lang.String getDataRef()
        Deprecated.
        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​(java.lang.String dataRef)
        Deprecated.
        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 Resource getFormResource()
        Deprecated.
        Form resource present inside DAM for which the data is required.
        Returns:
        resource of the form that is being ren

      • setFormResource

        public DataXMLOptions setFormResource​(Resource formResource)
        Deprecated.
        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 java.lang.String getPagePath()
        Deprecated.
        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​(java.lang.String pagePath)
        Deprecated.
        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 Resource getAemFormContainer()
        Deprecated.
        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​(Resource aemFormContainer)
        Deprecated.
        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 java.lang.String getServiceName()
        Deprecated.
        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​(java.lang.String serviceName)
        Deprecated.
        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 java.util.Map getParams()
        Deprecated.
        Returns the parameter map
        Returns:
        map containing the parameters

      • setParams

        public DataXMLOptions setParams​(java.util.Map paramMap)
        Deprecated.
        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.