Class SubmitDocumentSdsJson

  • All Implemented Interfaces:
    Serializable

    public class SubmitDocumentSdsJson
    extends BaseJson
    These parameters are needed when submitting files in SDS mode (not to a workspace).
    See Also:
    Serialized Form
    • Constructor Detail

      • SubmitDocumentSdsJson

        public SubmitDocumentSdsJson()
    • Method Detail

      • getDeviceType

        public DeviceType getDeviceType()
      • setDeviceType

        public void setDeviceType​(DeviceType deviceType)
      • getUserRecipients

        public Set<String> getUserRecipients()
        A list of mails for users that are intended to be recipients of these files. Can be sent empty or not sent.
        Returns:
        A list of mails for users that are intended to be recipients of these files. Can be sent empty or not sent.
      • setUserRecipients

        public void setUserRecipients​(Set<String> userRecipients)
        A list of mails for users that are intended to be recipients of these files. Can be sent empty or not sent.
        Parameters:
        userRecipients - A list of mails for users that are intended to be recipients of these files. Can be sent empty or not sent.
      • getDocumentGuids

        public Set<String> getDocumentGuids()
        The list of file guids to submit.
        Returns:
        The list of file guids to submit.
      • setDocumentGuids

        public void setDocumentGuids​(Set<String> documentGuids)
        The list of file guids to submit.
        Parameters:
        documentGuids - The list of file guids to submit.
      • getListRecipients

        public Set<String> getListRecipients()
        A list of distribution list names that are intended to be recipients of these files. May be left null. Can be sent empty or not sent.
        Returns:
        A list of distribution list names that are intended to be recipients of these files. May be left null. Can be sent empty or not sent.
      • setListRecipients

        public void setListRecipients​(Set<String> listRecipients)
        A list of distribution list names that are intended to be recipients of these files. May be left null. Can be sent empty or not sent.
        Parameters:
        listRecipients - A list of distribution list names that are intended to be recipients of these files. May be left null. Can be sent empty or not sent.
      • getWhoCanView

        public WhoCanView getWhoCanView()
        In case Domain permissions or file that are available to everyone, use this parameter. Only recipients that are recipients of this file (directly of by a distribution list) will be notified that this file exist.
        Returns:
        In case Domain permissions or file that are available to everyone, use this parameter. Only recipients that are recipients of this file (directly of by a distribution list) will be notified that this file exist.
      • setWhoCanView

        public void setWhoCanView​(WhoCanView whoCanView)
        In case Domain permissions or file that are available to everyone, use this parameter. Only recipients that are recipients of this file (directly of by a distribution list) will be notified that this file exist.
        Parameters:
        whoCanView - In case Domain permissions or file that are available to everyone, use this parameter. Only recipients that are recipients of this file (directly of by a distribution list) will be notified that this file exist.
      • isIsCollaboration

        public boolean isIsCollaboration()
        Indicates whether the files are sent for collaboration.
        Returns:
        Indicates whether the files are sent for collaboration.
      • getIsCollaboration

        @Deprecated
        public boolean getIsCollaboration()
        Deprecated.
        Indicates whether the files are sent for collaboration.
        Returns:
        Indicates whether the files are sent for collaboration.
      • setIsCollaboration

        public void setIsCollaboration​(boolean isCollaboration)
        Indicates whether the files are sent for collaboration.
        Parameters:
        isCollaboration - Indicates whether the files are sent for collaboration.
      • getActiveDirectoryGroupsRecipients

        public Set<String> getActiveDirectoryGroupsRecipients()
        A list of activeDirectory group guids that are intended to be recipients of these files. May be left null. Can be sent empty or not sent.
        Returns:
        A list of activeDirectory group guids that are intended to be recipients of these files. May be left null. Can be sent empty or not sent.
      • setActiveDirectoryGroupsRecipients

        public void setActiveDirectoryGroupsRecipients​(Set<String> activeDirectoryGroupsRecipients)
        A list of activeDirectory group guids that are intended to be recipients of these files. May be left null. Can be sent empty or not sent.
        Parameters:
        activeDirectoryGroupsRecipients - A list of activeDirectory group guids that are intended to be recipients of these files. May be left null. Can be sent empty or not sent.
      • getIsSendEmail

        public Boolean getIsSendEmail()
        If set to True the server will notify recipients via email about new documents submitted.
        Returns:
        If set to True the server will notify recipients via email about new documents submitted.
      • setIsSendEmail

        public void setIsSendEmail​(Boolean isSendEmail)
        If set to True the server will notify recipients via email about new documents submitted.
        Parameters:
        isSendEmail - If set to True the server will notify recipients via email about new documents submitted.
      • getPermission

        public PermissionFromUserJson getPermission()
        The permissions to grant to recipients of this file.
        Returns:
        The permissions to grant to recipients of this file.
      • setPermission

        public void setPermission​(PermissionFromUserJson permission)
        The permissions to grant to recipients of this file.
        Parameters:
        permission - The permissions to grant to recipients of this file.
      • getReadConfirmation

        public Boolean getReadConfirmation()
        Indicates is read confirmation is required for this document.
        Returns:
        Indicates is read confirmation is required for this document.
      • setReadConfirmation

        public void setReadConfirmation​(Boolean readConfirmation)
        Indicates is read confirmation is required for this document.
        Parameters:
        readConfirmation - Indicates is read confirmation is required for this document.
      • getMailSubject

        public String getMailSubject()
      • setMailSubject

        public void setMailSubject​(String mailSubject)
      • isIsOpenToAnyone

        public boolean isIsOpenToAnyone()
        Indicates whether the file is sent using SimpleShare which means no authentication is required to view/download.
        Returns:
        Indicates whether the file is sent using SimpleShare which means no authentication is required to view/download.
      • getIsOpenToAnyone

        @Deprecated
        public boolean getIsOpenToAnyone()
        Deprecated.
        Indicates whether the file is sent using SimpleShare which means no authentication is required to view/download.
        Returns:
        Indicates whether the file is sent using SimpleShare which means no authentication is required to view/download.
      • setIsOpenToAnyone

        public void setIsOpenToAnyone​(boolean isOpenToAnyone)
        Indicates whether the file is sent using SimpleShare which means no authentication is required to view/download.
        Parameters:
        isOpenToAnyone - Indicates whether the file is sent using SimpleShare which means no authentication is required to view/download.
      • getMailMessage

        public String getMailMessage()
      • setMailMessage

        public void setMailMessage​(String mailMessage)
      • getModifiedDate

        public Date getModifiedDate()
      • setModifiedDate

        public void setModifiedDate​(Date modifiedDate)