com.adobe.aemds.guide.model.FormSubmitInfo 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.model;

import java.util.List;

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

import com.adobe.aemds.guide.service.external.PortalRecordInfo;
import com.adobe.forms.common.service.FileAttachmentWrapper;

/**
 * Defines the information required during form submission
 *
 * @since 6.3
 */
public class FormSubmitInfo {
    private Resource formContainerResource;
    private String formContainerPath;
    private String data;
    private String locale;
    private List fileAttachments;
    private String fileAttachmentMap;
    private FileAttachmentWrapper documentOfRecord;
    private String formSubmitter;
    private String contentType;
    private byte[] signData;
	private String agreementId;
    private PortalRecordInfo portalRecordInfo;

    public FormSubmitInfo() {
    }

    /**
     * Returns the path to the form container
     * @return  path to the form container
     */
    public String getFormContainerPath() {
        return formContainerPath;
    }

    /**
     * Sets the given form container path
     * @param formContainerPath path to the form container
     */
    public void setFormContainerPath(String formContainerPath) {
        this.formContainerPath = formContainerPath;
    }

    /**
     * Returns the submitted data of the form
     * @return  data submitted
     */
    public String getData() {
        return data;
    }

    /**
     * Sets the data submitted by the form
     * @param data data submitted
     */
    public void setData(String data) {
        this.data = data;
    }

    /**
     * Returns the list of {@link FileAttachmentWrapper} objects. This list contains
     * the file attachment submitted
     * @return  list of {@link FileAttachmentWrapper} objects
     */
    public List getFileAttachments() {
        return fileAttachments;
    }

    /**
     * Sets the list of {@link FileAttachmentWrapper} objects
     * @param fileAttachments   list of {@link FileAttachmentWrapper} objects
     */
    public void setFileAttachments(List fileAttachments) {
        this.fileAttachments = fileAttachments;
    }

    /**
     * Returns the document of record as a result of form submission.
     * @return  {@link FileAttachmentWrapper} representing the document of record
     */
    public FileAttachmentWrapper getDocumentOfRecord() {
        return documentOfRecord;
    }

    /**
     * Sets the document of record as a result of form submission.
     * @param documentOfRecord {@link FileAttachmentWrapper} representing the document of record
     */
    public void setDocumentOfRecord(FileAttachmentWrapper documentOfRecord) {
        this.documentOfRecord = documentOfRecord;
    }

    /**
     * Returns the String representation of File Attachment map
     * @return String representing File Attachment map
     */
    public String getFileAttachmentMap() {
        return fileAttachmentMap;
    }

    /**
     * Sets the String representation of File Attachment map
     * @param fileAttachmentMap String representing File Attachment map
     */
    public void setFileAttachmentMap(String fileAttachmentMap) {
        this.fileAttachmentMap = fileAttachmentMap;
    }

    /**
     * Returns the form container resource
     * @return form container resource
     */
    public Resource getFormContainerResource() {
        return formContainerResource;
    }

    /**
     * Sets the form container resource
     * @param formContainerResource resource to the form container
     */
    public void setFormContainerResource(Resource formContainerResource) {
        this.formContainerResource = formContainerResource;
    }

    /**
     * Returns the form locale
     * @return form locale
     */
    public String getLocale() {
        return locale;
    }

    /**
     * Sets the form locale
     * @param locale    form locale
     */
    public void setLocale(String locale) {
        this.locale = locale;
    }

    /**
     * Returns the id of the user who submitted the form
     * @return  id of the user
     */
    public String getFormSubmitter() {
        return formSubmitter;
    }

    /**
     * Sets the user id of the user who submitted the form
     * @param formSubmitter user id of the user
     */
    public void setFormSubmitter(String formSubmitter) {
        this.formSubmitter = formSubmitter;
    }

    /**
     * Returns the mime type of the submitted data.
     * For example, in case of json data, the mime type would be application/json
     * and in case of XML, the mime type would be application/xml.
     * @return  mime type of the data submitted
     */
    public String getContentType() {
        return contentType;
    }

    /**
     * Sets the mime type of the submitted data
     * @param contentType   mime type of the submitted data
     */
    public void setContentType(String contentType) {
        this.contentType = contentType;
    }

    /**
     * Returns the data (represented as byte array), filled by signers, while signing the form.
     * @return byte[] - data filled by the signers
     */
	public byte[] getSignData() {
		return signData;
	}

    /**
     * Sets the data (represented as byte array), filled by signers, while signing the form.
     * @@param signData  data (represented as byte array) filled by the signers
     */
	public void setSignData(byte[] signData) {	//NOSONAR
		this.signData = signData;
	}

    /**
     * Returns the Adobe Sign Agreement ID, which is generated when the form is sent to signers for signing.
     * @return String representing Adobe Sign Agreement ID
     */
	public String getAgreementId() {
		return agreementId;
	}

    /**
     * Sets the Adobe Sign Agreement ID, which is generated when the form is sent to signers for signing.
     * @param agreementId String representing Adobe Sign Agreement ID
     */
	public void setAgreementId(String agreementId) {
		this.agreementId = agreementId;
	}

    /**
     * Returns the information related to form submission, in Forms Portal.
     * @return {@link PortalRecordInfo} represents Forms Portal form submission info
     */
    public PortalRecordInfo getPortalRecordInfo() {
        return portalRecordInfo;
    }

    /**
     * Sets the information related to form submission, in Forms Portal.
     * @param portalRecordInfo {@link PortalRecordInfo} represents Forms Portal form submission info
     */
    public void setPortalRecordInfo(PortalRecordInfo portalRecordInfo) {
        this.portalRecordInfo = portalRecordInfo;
    }
}