com.adobe.fd.fp.service.DraftAFDataService 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 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.fd.fp.service;

import java.util.Map;

import com.adobe.fd.fp.exception.FormsPortalException;

/**  
 * DraftAFDataService will get/delete/save user data (attachments and form data) filled in Adaptive Form  
 *
 */

@Deprecated
public interface DraftAFDataService {
	
	/**
	 * Deletes the user data stored against the ID passed as the argument
	 * 
	 * @param draftDataID
	 * @return status for the just occurred delete draft UserData operation 
	 * @throws FormsPortalException
	 */
	public Boolean deleteAFDraftUserData (String draftDataID) throws FormsPortalException;
	
	/**
	 * Saves user data provided in the argument map
	 * 
	 * @param draftUserDataMap contains Form Data (key - "guideState"), Adaptive Form Name (Key - "guideName"), and Draft DataID (Key - "userDataID") in case of update
	 * @return userData ID would be returned which needs to be saved in metadata node 
	 * @throws FormsPortalException
	 */
	public String saveAFUserData (Map draftUserDataMap) throws FormsPortalException;
	
	/**
	 * Gets the user data stored against the ID passed as the argument
	 * 
	 * @param Draft DataID
	 * @return guideState (which would then be populated in adaptive form to reload the draft) which is stored against draftDataID
	 * @throws FormsPortalException
	 */
	public byte[] getAFDraftUserData(String draftDataID) throws FormsPortalException;
	
	/**
	 * Saves the attachments for current adaptive form instance 
	 * 
	 * @param attachmentsBytes would expect byte array of the attachment to be saved
	 * @return id for the attachment just saved (so that it could be retrieved later)
	 * @throws FormsPortalException
	 */
	public String saveAttachments(byte[] attachmentBytes) throws FormsPortalException;
	
	/**
	 * To delete an attachment
	 * 
	 * @param attachmentID
	 * @return status of delete operation performed on attachment corresponding to this attachment ID
	 * @throws FormsPortalException
	 */
	public boolean deleteAttachment(String attachmentID) throws FormsPortalException;
}