Interface DocumentWriteSet

All Superinterfaces:

Collection<DocumentWriteOperation>, Iterable<DocumentWriteOperation>, Set<DocumentWriteOperation>

See Also:

• DocumentManager.write(DocumentWriteSet)
• REST API Guide -> Writing Multiple Documents

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  DocumentWriteSet

  add(DocumentDescriptor desc, AbstractWriteHandle contentHandle)

  Adds to this write set a document with the given uri template, and contents provided by the handle

  DocumentWriteSet

  add(DocumentDescriptor desc, AbstractWriteHandle contentHandle, String temporalDocumentURI)

  Adds to this write set a document with the given uri template, temporalDocumentURI and contents provided by the handle

  DocumentWriteSet

  add(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle)

  Adds to this write set a document with the given uri template, metadata, and contents provided by the handle

  DocumentWriteSet

  add(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle, String temporalDocumentURI)

  Adds to this write set a document with the given uri template, metadata, temporalDocumentURI and contents provided by the handle

  DocumentWriteSet

  add(String docId, AbstractWriteHandle contentHandle)

  Adds to this write set a document with the given docId (server uri) and contents provided by the handle

  DocumentWriteSet

  add(String docId, AbstractWriteHandle contentHandle, String temporalDocumentURI)

  Adds to this write set a document with the given docId (server uri), temporalDocumentURI and contents provided by the handle

  DocumentWriteSet

  add(String docId, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle)

  Adds to this write set a document with the given docId (server uri), metadata, and contents provided by the handle

  DocumentWriteSet

  add(String docId, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle, String temporalDocumentURI)

  Adds to this write set a document with the given docId (server uri), metadata, temporalDocumentURI and contents provided by the handle

  DocumentWriteSet

  addAs(String docId, DocumentMetadataWriteHandle metadataHandle, Object content)

  Adds to this write set a document with the given docId (server uri), metadata, and contents.

  DocumentWriteSet

  addAs(String docId, DocumentMetadataWriteHandle metadataHandle, Object content, String temporalDocumentURI)

  Adds to this write set a document with the given docId (server uri), metadata, temporalDocumentURI and contents.

  DocumentWriteSet

  addAs(String docId, Object content)

  Adds to this write set a document with the given docId (server uri) and contents.

  DocumentWriteSet

  addAs(String docId, Object content, String temporalDocumentURI)

  Adds to this write set a document with the given docId (server uri), temporalDocumentURI and contents.

  DocumentWriteSet

  addDefault(DocumentMetadataWriteHandle metadataHandle)

  Sets the default metadata for this write set for all documents added after this call

  DocumentWriteSet

  disableDefault()

  Removes the default metadata for this write set for all documents added after this call

  Methods inherited from interface java.util.Collection

  parallelStream, removeIf, stream, toArray

  Methods inherited from interface java.lang.Iterable

  forEach

  Methods inherited from interface java.util.Set

  add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

• Method Details

  • addDefault

    DocumentWriteSet addDefault(DocumentMetadataWriteHandle metadataHandle)
    Sets the default metadata for this write set for all documents added after this call

    Parameters:

    metadataHandle - the handle containing the metatdata to use as defaults

    Returns:

    this instance (for method chaining)

  • disableDefault

    DocumentWriteSet disableDefault()
    Removes the default metadata for this write set for all documents added after this call

    Returns:

    this instance (for method chaining)

  • add

    DocumentWriteSet add(String docId, AbstractWriteHandle contentHandle)
    Adds to this write set a document with the given docId (server uri) and contents provided by the handle

    Parameters:

    docId - the URI identifier for the document

    contentHandle - a handle for writing the content of the document

    Returns:

    this instance (for method chaining)

  • addAs

    DocumentWriteSet addAs(String docId, Object content)
    Adds to this write set a document with the given docId (server uri) and contents. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Parameters:

    docId - the URI identifier for the document

    content - an IO representation of the document content

    Returns:

    this instance (for method chaining)

  • add

    DocumentWriteSet add(String docId, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle)
    Adds to this write set a document with the given docId (server uri), metadata, and contents provided by the handle

    Parameters:

    docId - the URI identifier for the document

    metadataHandle - a handle for writing the metadata of the document

    contentHandle - a handle for writing the content of the document

    Returns:

    this instance (for method chaining)

  • addAs

    DocumentWriteSet addAs(String docId, DocumentMetadataWriteHandle metadataHandle, Object content)
    Adds to this write set a document with the given docId (server uri), metadata, and contents. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Parameters:

    docId - the URI identifier for the document

    metadataHandle - a handle for writing the metadata of the document

    content - an IO representation of the document content

    Returns:

    this instance (for method chaining)

  • add

    DocumentWriteSet add(DocumentDescriptor desc, AbstractWriteHandle contentHandle)
    Adds to this write set a document with the given uri template, and contents provided by the handle

    Parameters:

    desc - a descriptor for the URI identifier, format, and mimetype of the document

    contentHandle - a handle for writing the content of the document

    Returns:

    this instance (for method chaining)

  • add

    DocumentWriteSet add(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle)
    Adds to this write set a document with the given uri template, metadata, and contents provided by the handle

    Parameters:

    desc - a descriptor for the URI identifier, format, and mimetype of the document

    metadataHandle - a handle for writing the metadata of the document

    contentHandle - a handle for writing the content of the document

    Returns:

    this instance (for method chaining)

  • add

    DocumentWriteSet add(String docId, AbstractWriteHandle contentHandle, String temporalDocumentURI)
    Adds to this write set a document with the given docId (server uri), temporalDocumentURI and contents provided by the handle

    Parameters:

    docId - the version URI identifier for the document

    contentHandle - a handle for writing the content of the document

    temporalDocumentURI - the logical temporal document collection URI

    Returns:

    this instance (for method chaining)

  • addAs

    DocumentWriteSet addAs(String docId, Object content, String temporalDocumentURI)
    Adds to this write set a document with the given docId (server uri), temporalDocumentURI and contents. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Parameters:

    docId - the version URI identifier for the document

    content - an IO representation of the document content

    temporalDocumentURI - the logical temporal document collection URI

    Returns:

    this instance (for method chaining)

  • add

    DocumentWriteSet add(String docId, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle, String temporalDocumentURI)
    Adds to this write set a document with the given docId (server uri), metadata, temporalDocumentURI and contents provided by the handle

    Parameters:

    docId - the version URI identifier for the document

    metadataHandle - a handle for writing the metadata of the document

    contentHandle - a handle for writing the content of the document

    temporalDocumentURI - the logical temporal document collection URI

    Returns:

    this instance (for method chaining)

  • addAs

    DocumentWriteSet addAs(String docId, DocumentMetadataWriteHandle metadataHandle, Object content, String temporalDocumentURI)
    Adds to this write set a document with the given docId (server uri), metadata, temporalDocumentURI and contents. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

    Parameters:

    docId - the version URI identifier for the document

    metadataHandle - a handle for writing the metadata of the document

    content - an IO representation of the document content

    temporalDocumentURI - the logical temporal document collection URI

    Returns:

    this instance (for method chaining)

  • add

    DocumentWriteSet add(DocumentDescriptor desc, AbstractWriteHandle contentHandle, String temporalDocumentURI)
    Adds to this write set a document with the given uri template, temporalDocumentURI and contents provided by the handle

    Parameters:

    desc - a descriptor for the version URI identifier, format, and mimetype of the document

    contentHandle - a handle for writing the content of the document

    temporalDocumentURI - the logical temporal document collection URI

    Returns:

    this instance (for method chaining)

  • add

    DocumentWriteSet add(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, AbstractWriteHandle contentHandle, String temporalDocumentURI)
    Adds to this write set a document with the given uri template, metadata, temporalDocumentURI and contents provided by the handle

    Parameters:

    desc - a descriptor for the version URI identifier, format, and mimetype of the document

    metadataHandle - a handle for writing the metadata of the document

    contentHandle - a handle for writing the content of the document

    temporalDocumentURI - the logical temporal document collection URI

    Returns:

    this instance (for method chaining)

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.