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

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

import java.util.Map;

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

/**
 * @pad.exclude Exclude from Published API.
 */
public interface SignAgreementService {

    /** Creates an Adobe Sign agreement for AF with the document passed as input
     * @param formSubmitInfo information about document for which agreement is to be created
     * @param postSigningURL URL to be rendered after signing
     * @param fetchFirstSignerUrl Boolean governing whether the url for signing the form for first signer will be returned or not
     * @return SignAgreementInfo Result of agreement creation
     */
    public SignAgreementInfo createAgreement(FormSubmitInfo formSubmitInfo, String postSigningURL, Boolean fetchFirstSignerUrl);

    public Map submitAgreement(String systemId, String agreementId, String signConfigPath) throws GuideException;
    
    public boolean cancelAgreement(String agreementId, Resource guideContainerResource) throws GuideException;
}