com.adobe.aemds.guide.service.GuideLCServiceConnector 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.aemds.guide.service;

import org.apache.sling.api.resource.Resource;

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


/**
 * Interface to pass on the submitted data of adaptive form to a LiveCycle Service.
 * This acts as a connector between adaptive form and LiveCycle Service
 */
public interface GuideLCServiceConnector {
    /**
     * Invokes the given process with parameters provided.
     * @param process       Name of the LC Process to invoke
     * @param inputParams   Map containing the parameters to be provided to the LC Process
     */
    public Map invokeProcess(String process, Map inputParams);

    /**
     * Returns the list of services present in the Livecycle Instance
     * @return the list of services
     */
    public List getServices();

    /**
     * Returns the name of the data xml parameter
     * @return string representing the name of the data xml parameter
     */
    public String getXmlParameterName();

    /**
     * Returns the name of the parameter corresponding to the list of file attachments
     * @return  string representing the name of the file attachment parameter
     */
    public String getFileListParameterName();

    /**
     * Returns the name of the dor document parameter
     * @return string representing the name of the dor document parameter
     */
    public String getDocumentOfRecordParameterName();
}