com.adobe.forms.common.service.FormDataXMLProviderRegistry Maven / Gradle / Ivy

Go to download
/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2014 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and may be covered by U.S. and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.adobe.forms.common.service;

import java.io.InputStream;
import java.util.List;

/**
 * Registry for maintaining the implementation of {DataXMLProvider} and {FormDataXMLProvider}
 * @pad.exclude Exclude from Published API.
 */
public interface FormDataXMLProviderRegistry {
    /**
     * Returns the data XML given a URL for the data. It calls all the implementation of FormDataXMLProvider and returns
     * the non null data returned by the first implementation
     * @deprecated
     */
    public String getDataXMLFromService(String dataRef) throws FormsException;

    /**
     * Returns the data XML Stream given Data XML Options. If the Service Name is provided in the options then that particular
     * service is used to return the data otherwise all the DataXMLProvider implementations are iterated
     * to return the data and the iteration stops when first implementation returns a non null data.
     * @param options DataXMLOptions for returning the data
     * @return input stream that can be used to get the data xml
     * @throws FormsException
     */
    public InputStream getDataXMLStreamFromService(DataXMLOptions options) throws FormsException;

    /**
     * Returns the implementations of DataXMLProvider registered for getting the data xml.
     * @return List of DataXMLProvider implementations
     */
    public List getProviders();
}