Package com.veeva.vault.sdk.api.edl

Interface SaveMatchedDocument.Builder

Enclosing interface:
SaveMatchedDocument
public static interface SaveMatchedDocument.Builder
Creates an instance of SaveMatchedDocument.

  • Method Details

    • withEdlItemId

      SaveMatchedDocument.Builder withEdlItemId(String edlItemId)
      Required: Sets the ID of the EDL Item record to which to save a matched document.
      Parameters:
      edlItemId - the EDL Item ID
      Returns:
      this SaveMatchedDocument.Builder

    • withDocumentVersionId

      SaveMatchedDocument.Builder withDocumentVersionId(String documentVersionId)
      Required: Sets the document version ID of the matched document to save. Providing only the document id matches the document to the latest version and unlocks it if it is locked. For example, "3". Providing the full document version ID matches and locks the document to the provided version if the version is valid and lockable. For example, "3_1_0". Learn more about working with EDLs in Vault Help.
      Parameters:
      documentVersionId - the document version ID in the format "3" or "3_1_0"
      Returns:
      this SaveMatchedDocument.Builder

    • excludeFromTotal

      SaveMatchedDocument.Builder excludeFromTotal(boolean exclude)
      Optional: Sets whether to exclude the matched document from the EDL Item's set of matched documents.
      Parameters:
      exclude - true if the document should be excluded; false if the document should be included.
      Returns:
      this SaveMatchedDocument.Builder

    • build

      SaveMatchedDocument build()
      Builds and returns a SaveMatchedDocument object.
      Returns:
      this completed SaveMatchedDocument