Interface PositionalDocumentVersionId

All Superinterfaces:
PositionalResult
All Known Subinterfaces:
RecordAttachmentPositionResult

public interface PositionalDocumentVersionId extends PositionalResult
Represents a successful result of processing a document in a batch operation, such as a save or delete. Exposes the index of a DocumentVersion in a batch input and the DocumentVersion instance's id.
  • Method Details

    • getDocumentVersionId

      String getDocumentVersionId()
      Retrieves the DocumentVersion id.
      Returns:
      id of DocumentVersion
    • hasWarnings

      boolean hasWarnings()
      Indicates the warning status of the given document version. You can refer to the SDK log to see which warnings were encountered for the operation.
      Returns:
      true if the document version has warnings
    • getUniqueFieldValue

      <T> T getUniqueFieldValue(ValueType<T> returnType)
      Retrieves the document version's unique field value if the operation's request specified a unique field to identify on.
      Returns:
      the document version's unique field value if operation request specified, otherwise null