Package 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

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

    • Method Detail

      • saveData

        java.lang.String saveData​(java.lang.String userDataID,
                          java.lang.String formName,
                          java.lang.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

        java.lang.String saveData​(java.lang.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

        java.lang.String saveDataAsynchronusly​(byte[] data,
                                       java.util.Map<java.lang.String,​java.lang.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​(java.lang.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​(java.lang.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

        java.lang.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

        java.lang.String saveAttachmentAsynchronously​(byte[] attachmentBytes,
                                              java.util.Map<java.lang.String,​java.lang.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​(java.lang.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​(java.lang.String attachmentID)
              throws FormsPortalException
        To get attachment bytes
        Parameters:
        attachmentID - : unique id for this attachment
        Returns:
        data corresponding to this attachmentID
        Throws:
        FormsPortalException