com.adobe.fd.fp.service

Interface SubmitDataService

public interface SubmitDataService

SubmitDataService service will get/delete/submit user data (attachments and form data) filled with a submission of Form

Method Summary

Modifier and Type	Method and Description
boolean	deleteAttachment(String attachmentID) To delete an attachment
boolean	deleteData(String userDataID) Deletes user data stored against the userDataID
byte[]	getAttachment(String attachmentID) To get attachment bytes
byte[]	getData(String userDataID) Gets the user data stored against the ID passed as argument
String	saveAttachment(byte[] attachmentBytes) Submits the attachment bytes passed as argument
String	saveAttachmentAsynchronously(byte[] attachmentBytes, Map<String,Object> options) Submits the attachment bytes passed as argument asynchronously for the user id provided in options map.
String	saveData(String id, byte[] data) Submits the user data provided as byte array
String	saveData(String userDataID, String formName, String formData) Submits the user data passed in argument map
String	saveDataAsynchronusly(byte[] data, Map<String,Object> options) Submits the user data provided as byte array asynchronously for the user name provided in the options map

Method Detail

saveData

String saveData(String userDataID,
                String formName,
                String formData)
         throws FormsPortalException

Submits the user data passed in argument map

Parameters:

userDataID, - unique identifier associated with this user data

formName, - name of the form whose draft is being submitted

formData, - user data associated with this submission

Returns:

userdataID, corresponding to which the user data has been stored and which can be used later to retrieve this data

Throws:

FormsPortalException

saveData

String saveData(String id,
                byte[] data)
         throws FormsPortalException

Submits the user data provided as byte array

Parameters:

id -

data -

Returns:

id corresponding to saved data

Throws:

FormsPortalException

saveDataAsynchronusly

String saveDataAsynchronusly(byte[] data,
                             Map<String,Object> options)
                      throws FormsPortalException

Submits the user data provided as byte array asynchronously for the user name provided in the options map

Parameters:

data - data to be saved in bytes

options - map containing options that affect this save

Returns:

id of the saved data instance

Throws:

FormsPortalException

getData

byte[] getData(String userDataID)
        throws FormsPortalException

Gets the user data stored against the ID passed as argument

Parameters:

userDataID: - unique id associated with this user data for this submission

Returns:

user data associated with this submission

Throws:

FormsPortalException

deleteData

boolean deleteData(String userDataID)
            throws FormsPortalException

Deletes user data stored against the userDataID

Parameters:

userDataID: - unique id associated with this user data for this submission

Returns:

status of the delete operation on this submission

Throws:

FormsPortalException

saveAttachment

String saveAttachment(byte[] attachmentBytes)
               throws FormsPortalException

Submits the attachment bytes passed as argument

Parameters:

attachmentsBytes: - would expect byte array of the attachment for this submission

Returns:

attachmentID for the attachment just saved (so that it could be retrieved later)

Throws:

FormsPortalException

saveAttachmentAsynchronously

String saveAttachmentAsynchronously(byte[] attachmentBytes,
                                    Map<String,Object> options)
                             throws FormsPortalException

Submits the attachment bytes passed as argument asynchronously for the user id provided in options map.

Parameters:

attachmentBytes - would expect byte array of the attachment for this submission

options - map containing options that affect this save

Returns:

attachmentID for the attachment just saved (so that it could be retrieved later)

Throws:

FormsPortalException

deleteAttachment

boolean deleteAttachment(String attachmentID)
                  throws FormsPortalException

To delete an attachment

Parameters:

attachmentID: - Unique id for this attachment

Returns:

status of delete operation performed on attachment corresponding to this attachment ID

Throws:

FormsPortalException

getAttachment

byte[] getAttachment(String attachmentID)
              throws FormsPortalException

To get attachment bytes

Parameters:

attachmentID: - unique id for this attachment

Returns:

data corresponding to this attachmentID

Throws:

FormsPortalException