com.adobe.aemds.guide.service.FormSubmitActionService Maven / Gradle / Ivy

Go to download
/*
 *
 * ADOBE CONFIDENTIAL
 * ___________________
 *
 * Copyright 2016 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 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 com.adobe.aemds.guide.model.FormSubmitInfo;

import java.util.Map;

/**
 * Interface to provide Form Submit Service. The implementations should handle the form submission
 */
public interface FormSubmitActionService {

    /**
     * Returns the name of the service.
     * This name is used as value of submitService property configured on submit action node.
     * @return service name
     */
    public String getServiceName();

    /**
     * Form Submission handler. This handler submits the form data using the given {@link FormSubmitInfo} object
     * which contains the required information needed to submit the form like data, mimeType of data etc
     * @param formSubmitInfo    {@link FormSubmitInfo} object
     * @return map containing the submit output
     */
    public Map submit(FormSubmitInfo formSubmitInfo);
}