DocumentManager (MarkLogic Java Client API 7.0.0)

Type Parameters:

R - the set of handles for reading the document content from the database

W - the set of handles for writing the document content to the database

All Known Subinterfaces:

BinaryDocumentManager, GenericDocumentManager, JSONDocumentManager, TextDocumentManager, XMLDocumentManager
```
public interface DocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>
```
A Document Manager provides database operations on a document.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DocumentManager.Metadata` The Metadata enumeration specifies the categories of metadata read from or written to the database.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearMetadataCategories()` Clears the metadata categories.
`DocumentDescriptor`	`create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle)` Creates a database document with metadata and content and a uri assigned by the server.
`DocumentDescriptor`	`create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform)` Creates a database document with metadata and content and a uri assigned by the server as transformed on the server.
`DocumentDescriptor`	`create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction)` Creates a database document with metadata and content and a uri assigned by the server in an open database transaction as transformed on the server.
`DocumentDescriptor`	`create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, Transaction transaction)`
`DocumentDescriptor`	`create(DocumentUriTemplate template, W contentHandle)` Creates a database document with a uri assigned by the server.
`DocumentDescriptor`	`create(DocumentUriTemplate template, W contentHandle, ServerTransform transform)` Creates a database document with a uri assigned by the server as transformed on the server.
`DocumentDescriptor`	`create(DocumentUriTemplate template, W contentHandle, ServerTransform transform, Transaction transaction)` Creates a database document with a uri assigned by the server in an open database transaction as transformed on the server.
`DocumentDescriptor`	`create(DocumentUriTemplate template, W contentHandle, Transaction transaction)` Creates a database document with a uri assigned by the server in an open database transaction.
`DocumentDescriptor`	`createAs(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, java.lang.Object content)` Creates a database document with a uri assigned by the server from an object of an IO class.
`DocumentDescriptor`	`createAs(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, java.lang.Object content, ServerTransform transform)` Creates a database document with a uri assigned by the server from an object of an IO class.
`DocumentDescriptor`	`createAs(DocumentUriTemplate template, java.lang.Object content)` Creates a database document with a uri assigned by the server from an object of an IO class.
`DocumentDescriptor`	`createAs(DocumentUriTemplate template, java.lang.Object content, ServerTransform transform)` Creates a database document with a uri assigned by the server from an object of an IO class.
`void`	`delete(DocumentDescriptor desc)` Deletes the document metadata and content from the database To call delete(), an application must authenticate as rest-writer or rest-admin.
`void`	`delete(DocumentDescriptor desc, Transaction transaction)` Deletes the document metadata and content from an open database transaction To call delete(), an application must authenticate as rest-writer or rest-admin.
`void`	`delete(java.lang.String... uris)` Deletes the documents' metadata and content To call delete(), an application must authenticate as rest-writer or rest-admin.
`void`	`delete(java.lang.String docId)` Deletes the document metadata and content from the database To call delete(), an application must authenticate as rest-writer or rest-admin.
`void`	`delete(java.lang.String docId, Transaction transaction)` Deletes the document metadata and content from an open database transaction To call delete(), an application must authenticate as rest-writer or rest-admin.
`void`	`delete(Transaction transaction, java.lang.String... uris)` Deletes the documents' metadata and content from an open database transaction To call delete(), an application must authenticate as rest-writer or rest-admin.
`DocumentDescriptor`	`exists(java.lang.String docId)` Checks whether a document exists and gets its byte length, format, mimetype, and version if it does.
`DocumentDescriptor`	`exists(java.lang.String docId, Transaction transaction)` Checks whether a document exists in an open transaction and gets its byte length, format, mimetype, and version if it does.
`Format`	`getContentFormat()` Gets the default format of the managed documents
`java.util.Set<DocumentManager.Metadata>`	`getMetadataCategories()` Returns the categories of metadata to read, write, patch, or search.
`Format`	`getNonDocumentFormat()` Returns the format (if set) for the search response from `search` and metadata available from `DocumentPage.next().getMetadata(handle)` (assuming `setMetadataCategories` has been called to request specific metadata).
`long`	`getPageLength()` Get the maximum number of records to return in a page from calls to `search`
`ServerTransform`	`getReadTransform()` Returns the transform for read requests that don't specify a transform.
`QueryManager.QueryView`	`getSearchView()` Returns the view types included in a SearchReadHandle populated by calls to `search`
`ServerTransform`	`getWriteTransform()` Returns the transform for write requests that don't specify a transform.
`DocumentDescriptor`	`newDescriptor(java.lang.String uri)` Creates a document descriptor for identifying the uri of a document, its format and mimetype, and its version.
`DocumentUriTemplate`	`newDocumentUriTemplate(java.lang.String extension)` Creates a document uri template for assigning a uri to a document.
`DocumentMetadataPatchBuilder`	`newPatchBuilder(Format pathFormat)` For XMLDocumentManager or JSONDocumentManager, creates a builder for specifying changes to the document and metadata of a document.
`DocumentWriteSet`	`newWriteSet()`
`void`	`patch(DocumentDescriptor desc, DocumentPatchHandle patch)` Modifies the metadata or content of a document.
`void`	`patch(DocumentDescriptor desc, DocumentPatchHandle patch, Transaction transaction)` Modifies the metadata or content of a document within an open database transaction on the server.
`void`	`patch(java.lang.String docId, DocumentPatchHandle patch)` Modifies the metadata or content of a document within an open database transaction on the server.
`void`	`patch(java.lang.String docId, DocumentPatchHandle patch, Transaction transaction)` Modifies the metadata or content of a document within an open database transaction on the server.
`void`	`patchAs(java.lang.String docId, java.lang.Object patch)` Modifies the metadata or content of a document within an open database transaction on the server.
`<T extends R> T`	`read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle)` Reads the document metadata and content from the database in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
`<T extends R> T`	`read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform)` Reads the document metadata and content from the database as transformed on the server.
`<T extends R> T`	`read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, Transaction transaction)` Reads the document metadata and content from an open database transaction as transformed on the server.
`<T extends R> T`	`read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, Transaction transaction)` Reads the document metadata and content from an open database transaction in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
`<T extends R> T`	`read(DocumentDescriptor desc, T contentHandle)` Reads the document content from the database in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
`<T extends R> T`	`read(DocumentDescriptor desc, T contentHandle, ServerTransform transform)` Reads the document content from the database as transformed on the server.
`<T extends R> T`	`read(DocumentDescriptor desc, T contentHandle, ServerTransform transform, Transaction transaction)` Reads the document content from an open database transaction as transformed on the server.
`<T extends R> T`	`read(DocumentDescriptor desc, T contentHandle, Transaction transaction)` Reads the document content from an open database transaction in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
`DocumentPage`	`read(long serverTimestamp, ServerTransform transform, java.lang.String... uris)` Reads from the database a list of documents matching the provided uris.
`DocumentPage`	`read(long serverTimestamp, java.lang.String... uris)` Reads from the database a list of documents matching the provided uris.
`DocumentPage`	`read(ServerTransform transform, java.lang.String... uris)` Reads from the database a list of documents matching the provided uris.
`DocumentPage`	`read(ServerTransform transform, Transaction transaction, java.lang.String... uris)` Reads from the database a list of documents matching the provided uris.
`DocumentPage`	`read(java.lang.String... uris)` Reads from the database a list of documents matching the provided uris.
`<T extends R> T`	`read(java.lang.String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle)` Reads the document metadata and content from the database in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
`<T extends R> T`	`read(java.lang.String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform)` Reads the document metadata and content from the database as transformed on the server.
`<T extends R> T`	`read(java.lang.String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, Transaction transaction)` Reads the document metadata and content from an open database transaction as transformed on the server.
`<T extends R> T`	`read(java.lang.String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, Transaction transaction)` Reads the document metadata and content from an open database transaction in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
`<T extends R> T`	`read(java.lang.String docId, T contentHandle)` Reads the document content from the database in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
`<T extends R> T`	`read(java.lang.String docId, T contentHandle, ServerTransform transform)` Reads the document content from the database as transformed on the server.
`<T extends R> T`	`read(java.lang.String docId, T contentHandle, ServerTransform transform, Transaction transaction)` Reads the document content from an open database transaction as transformed on the server.
`<T extends R> T`	`read(java.lang.String docId, T contentHandle, Transaction transaction)` Reads the document content from an open database transaction in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
`DocumentPage`	`read(Transaction transaction, java.lang.String... uris)` Reads from the database a list of documents matching the provided uris.
`<T> T`	`readAs(java.lang.String docId, java.lang.Class<T> as)` Reads the document content from the database in the representation specified by the IO class.
`<T> T`	`readAs(java.lang.String docId, java.lang.Class<T> as, ServerTransform transform)` Reads the document content from the database in the representation specified by the IO class.
`<T> T`	`readAs(java.lang.String docId, DocumentMetadataReadHandle metadataHandle, java.lang.Class<T> as)` Reads the document metadata and content from the database in the representation specified by the IO class.
`<T> T`	`readAs(java.lang.String docId, DocumentMetadataReadHandle metadataHandle, java.lang.Class<T> as, ServerTransform transform)` Reads the document metadata and content from the database in the representation specified by the IO class.
`DocumentPage`	`readMetadata(java.lang.String... uris)` Reads from the database the metadata for a list of documents matching the provided uris.
`<T extends DocumentMetadataReadHandle> T`	`readMetadata(java.lang.String docId, T metadataHandle)` Reads the document metadata from the database in the representation provided by the handle To call readMetadata(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
`<T extends DocumentMetadataReadHandle> T`	`readMetadata(java.lang.String docId, T metadataHandle, Transaction transaction)` Reads the document metadata from an open database transaction in the representation provided by the handle To call readMetadata(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
`DocumentPage`	`readMetadata(Transaction transaction, java.lang.String... uris)` Reads from the database the metadata for a list of documents matching the provided uris.
`DocumentPage`	`search(SearchQueryDefinition querydef, long start)` Just like `QueryManager.search` but return complete documents via iterable DocumentPage.
`DocumentPage`	`search(SearchQueryDefinition querydef, long start, long serverTimestamp)` Just like `QueryManager.search` but return complete documents via iterable DocumentPage.
`DocumentPage`	`search(SearchQueryDefinition querydef, long start, SearchReadHandle searchHandle)` Just like `QueryManager.search` but return complete documents via iterable DocumentPage.
`DocumentPage`	`search(SearchQueryDefinition querydef, long start, SearchReadHandle searchHandle, java.lang.String forestName)` Just like `QueryManager.search` but return complete documents via iterable DocumentPage.
`DocumentPage`	`search(SearchQueryDefinition querydef, long start, SearchReadHandle searchHandle, Transaction transaction)` Just like `QueryManager.search(SearchQueryDefinition, SearchReadHandle, long, Transaction)` but return complete documents via iterable DocumentPage.
`DocumentPage`	`search(SearchQueryDefinition querydef, long start, SearchReadHandle searchHandle, Transaction transaction, java.lang.String forestName)` Just like `QueryManager.search(SearchQueryDefinition, SearchReadHandle, long, Transaction, String)` but return complete documents via iterable DocumentPage.
`DocumentPage`	`search(SearchQueryDefinition querydef, long start, java.lang.String forestName)` Just like `QueryManager.search` but return complete documents via iterable DocumentPage.
`DocumentPage`	`search(SearchQueryDefinition querydef, long start, Transaction transaction)` Just like `QueryManager.search` but return complete documents via iterable DocumentPage.
`DocumentPage`	`search(SearchQueryDefinition querydef, long start, Transaction transaction, java.lang.String forestName)` Just like `QueryManager.search` but return complete documents via iterable DocumentPage.
`void`	`setContentFormat(Format format)` Sets the default format of the managed documents
`void`	`setMetadataCategories(DocumentManager.Metadata... categories)` Specifies the categories of metadata to read, write, patch, or search.
`void`	`setMetadataCategories(java.util.Set<DocumentManager.Metadata> categories)` Specifies the categories of metadata to read, write, patch, or search.
`void`	`setNonDocumentFormat(Format nonDocumentFormat)` Specifies the format for the search response from `search` and metadata available from `DocumentPage.next().getMetadata(handle)` (assuming `setMetadataCategories` has been called to request specific metadata).
`void`	`setPageLength(long length)` Specifies the maximum number of documents that can appear in any page of the query results, overriding any maximum specified in the query options.
`void`	`setReadTransform(ServerTransform transform)` Specifies a transform for read requests that don't specify a transform.
`void`	`setSearchView(QueryManager.QueryView view)` Specifies the view types included in a SearchReadHandle populated by calls to `search`
`void`	`setWriteTransform(ServerTransform transform)` Specifies a transform for write requests that don't specify a transform.
`void`	`startLogging(RequestLogger logger)` Starts debugging client requests.
`void`	`stopLogging()` Stops debugging client requests.
`void`	`write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle)` Writes the document metadata and content to the database from the representations provided by the handles To call write(), an application must authenticate as rest-writer or rest-admin.
`void`	`write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform)` Writes the document metadata and content to the database as transformed on the server.
`void`	`write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction)` Writes the document metadata and content to an open database transaction as transformed on the server.
`void`	`write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, Transaction transaction)` Writes the document metadata and content to an open database transaction from the representations provided by the handles To call write(), an application must authenticate as rest-writer or rest-admin.
`void`	`write(DocumentDescriptor desc, W contentHandle)` Writes the document content to the database from the representation provided by the handle To call write(), an application must authenticate as rest-writer or rest-admin.
`void`	`write(DocumentDescriptor desc, W contentHandle, ServerTransform transform)` Writes the document content to the database as transformed on the server.
`void`	`write(DocumentDescriptor desc, W contentHandle, ServerTransform transform, Transaction transaction)` Writes the document content to an open database transaction as transformed on the server.
`void`	`write(DocumentDescriptor desc, W contentHandle, Transaction transaction)` Writes the document content to an open database transaction from the representation provided by the handle To call write(), an application must authenticate as rest-writer or rest-admin.
`void`	`write(DocumentWriteSet writeSet)` Write a set of documents and metadata to the server via REST API bulk capabilities.
`void`	`write(DocumentWriteSet writeSet, ServerTransform transform)` Write a set of documents and metadata to the server via REST API bulk capabilities.
`void`	`write(DocumentWriteSet writeSet, ServerTransform transform, Transaction transaction)` Write a set of documents and metadata to the server via REST API bulk capabilities.
`void`	`write(DocumentWriteSet writeSet, Transaction transaction)` Write a set of documents and metadata to the server via REST API bulk capabilities.
`void`	`write(java.lang.String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle)` Writes the document metadata and content to the database from the representations provided by the handles To call write(), an application must authenticate as rest-writer or rest-admin.
`void`	`write(java.lang.String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform)` Writes the document metadata and content to the database as transformed on the server.
`void`	`write(java.lang.String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction)` Writes the document metadata and content to an open database transaction as transformed on the server.
`void`	`write(java.lang.String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, Transaction transaction)` Writes the document metadata and content to an open database transaction from the representations provided by the handles To call write(), an application must authenticate as rest-writer or rest-admin.
`void`	`write(java.lang.String docId, W contentHandle)` Writes the document content to the database from the representation provided by the handle To call write(), an application must authenticate as rest-writer or rest-admin.
`void`	`write(java.lang.String docId, W contentHandle, ServerTransform transform)` Writes the document content to the database as transformed on the server.
`void`	`write(java.lang.String docId, W contentHandle, ServerTransform transform, Transaction transaction)` Writes the document content to an open database transaction as transformed on the server.
`void`	`write(java.lang.String docId, W contentHandle, Transaction transaction)` Writes the document content to an open database transaction from the representation provided by the handle To call write(), an application must authenticate as rest-writer or rest-admin.
`void`	`writeAs(java.lang.String docId, DocumentMetadataWriteHandle metadataHandle, java.lang.Object content)` Writes the document content to the database from an object of an IO class.
`void`	`writeAs(java.lang.String docId, DocumentMetadataWriteHandle metadataHandle, java.lang.Object content, ServerTransform transform)` Writes the document content to the database from an object of an IO class.
`void`	`writeAs(java.lang.String docId, java.lang.Object content)` Writes the document content to the database from an object of an IO class.
`void`	`writeAs(java.lang.String docId, java.lang.Object content, ServerTransform transform)` Writes the document content to the database from an object of an IO class.
`void`	`writeDefaultMetadata(java.lang.String... uris)` Reverts the metadata in the database for the documents to the defaults To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
`void`	`writeDefaultMetadata(java.lang.String docId)` Reverts the document metadata in the database to the defaults To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
`void`	`writeDefaultMetadata(java.lang.String docId, Transaction transaction)` Reverts the document metadata in an open database transaction to the defaults To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
`void`	`writeDefaultMetadata(Transaction transaction, java.lang.String... uris)` Reverts the document metadata in an open database transaction to the defaults To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
`void`	`writeMetadata(java.lang.String docId, DocumentMetadataWriteHandle metadataHandle)` Writes the document metadata to the database from the representation provided by the handle To call writeMetadata(), an application must authenticate as rest-writer or rest-admin.
`void`	`writeMetadata(java.lang.String docId, DocumentMetadataWriteHandle metadataHandle, Transaction transaction)` Writes the document metadata to an open database transaction from the representation provided by the handle To call writeMetadata(), an application must authenticate as rest-writer or rest-admin.

- Method Detail
  - newDescriptor
```
DocumentDescriptor newDescriptor(java.lang.String uri)
```
    Creates a document descriptor for identifying the uri of a document, its format and mimetype, and its version.
    
    Parameters:
    
    uri - the identifier for the document
    
    Returns:
    
    a descriptor for the document
  - newDocumentUriTemplate
```
DocumentUriTemplate newDocumentUriTemplate(java.lang.String extension)
```
    Creates a document uri template for assigning a uri to a document.
    
    Parameters:
    
    extension - the identifier for the document
    
    Returns:
    
    a template for the document uri
  - newPatchBuilder
```
DocumentMetadataPatchBuilder newPatchBuilder(Format pathFormat)
```
    For XMLDocumentManager or JSONDocumentManager, creates a builder for specifying changes to the document and metadata of a document. For GenericDocumentManager, TextDocumentManager, and BinaryDocumentManager, creates a builder for specifying changes to only the metadata of a document since binary and text documents cannot be changed with patches.
    
    Parameters:
    
    pathFormat - the patch path language. Set to JSON for JSONPath or XML for XPath.
    
    Returns:
    
    the patch builder
  - exists
```
DocumentDescriptor exists(java.lang.String docId)
                   throws ForbiddenUserException,
                          FailedRequestException
```
    Checks whether a document exists and gets its byte length, format, mimetype, and version if it does. To call exists(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    Returns:
    
    a descriptor for the document or null if the document is not found
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - exists
```
DocumentDescriptor exists(java.lang.String docId,
                          Transaction transaction)
                   throws ForbiddenUserException,
                          FailedRequestException
```
    Checks whether a document exists in an open transaction and gets its byte length, format, mimetype, and version if it does. To call exists(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    a descriptor for the document or null if the document is not found
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - readAs
```
<T> T readAs(java.lang.String docId,
             java.lang.Class<T> as)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException
```
    Reads the document content from the database in the representation specified by the IO class. 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
    
    Type Parameters:
    
    T - the type of object that will be returned by the handle registered for it
    
    Parameters:
    
    docId - the URI identifier for the document
    
    as - the IO class for reading the content of the document
    
    Returns:
    
    an object of the IO class with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - readAs
```
<T> T readAs(java.lang.String docId,
             java.lang.Class<T> as,
             ServerTransform transform)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException
```
    Reads the document content from the database in the representation specified by the IO class. 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
    
    Type Parameters:
    
    T - the type of object that will be returned by the handle registered for it
    
    Parameters:
    
    docId - the URI identifier for the document
    
    as - the IO class for reading the content of the document
    
    transform - a server transform to modify the document content
    
    Returns:
    
    an object of the IO class with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - readAs
```
<T> T readAs(java.lang.String docId,
             DocumentMetadataReadHandle metadataHandle,
             java.lang.Class<T> as)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException
```
    Reads the document metadata and content from the database in the representation specified by the IO class. 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
    
    Type Parameters:
    
    T - the type of object that will be returned by the handle registered for it
    
    Parameters:
    
    docId - the URI identifier for the document
    
    metadataHandle - a handle for reading the metadata of the document
    
    as - the IO class for reading the content of the document
    
    Returns:
    
    an object of the IO class with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - readAs
```
<T> T readAs(java.lang.String docId,
             DocumentMetadataReadHandle metadataHandle,
             java.lang.Class<T> as,
             ServerTransform transform)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException
```
    Reads the document metadata and content from the database in the representation specified by the IO class. 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
    
    Type Parameters:
    
    T - the type of object that will be returned by the handle registered for it
    
    Parameters:
    
    docId - the URI identifier for the document
    
    metadataHandle - a handle for reading the metadata of the document
    
    as - the IO class for reading the content of the document
    
    transform - a server transform to modify the document content
    
    Returns:
    
    an object of the IO class with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(java.lang.String docId,
                     T contentHandle)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document content from the database in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    docId - the URI identifier for the document
    
    contentHandle - a handle for reading the content of the document
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(java.lang.String docId,
                     T contentHandle,
                     ServerTransform transform)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document content from the database as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    docId - the URI identifier for the document
    
    contentHandle - a handle for reading the content of the document
    
    transform - a server transform to modify the document content
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(DocumentDescriptor desc,
                     T contentHandle)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document content from the database in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    contentHandle - a handle for reading the content of the document
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(DocumentDescriptor desc,
                     T contentHandle,
                     ServerTransform transform)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document content from the database as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    contentHandle - a handle for reading the content of the document
    
    transform - a server transform to modify the document content
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(java.lang.String docId,
                     DocumentMetadataReadHandle metadataHandle,
                     T contentHandle)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document metadata and content from the database in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    docId - the URI identifier for the document
    
    metadataHandle - a handle for reading the metadata of the document
    
    contentHandle - a handle for reading the content of the document
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(java.lang.String docId,
                     DocumentMetadataReadHandle metadataHandle,
                     T contentHandle,
                     ServerTransform transform)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document metadata and content from the database as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    docId - the URI identifier for the document
    
    metadataHandle - a handle for reading the metadata of the document
    
    contentHandle - a handle for reading the content of the document
    
    transform - a server transform to modify the document content
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(DocumentDescriptor desc,
                     DocumentMetadataReadHandle metadataHandle,
                     T contentHandle)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document metadata and content from the database in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    metadataHandle - a handle for reading the metadata of the document
    
    contentHandle - a handle for reading the content of the document
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(DocumentDescriptor desc,
                     DocumentMetadataReadHandle metadataHandle,
                     T contentHandle,
                     ServerTransform transform)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document metadata and content from the database as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    metadataHandle - a handle for reading the metadata of the document
    
    contentHandle - a handle for reading the content of the document
    
    transform - a server transform to modify the document content
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(java.lang.String docId,
                     T contentHandle,
                     Transaction transaction)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document content from an open database transaction in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    docId - the URI identifier for the document
    
    contentHandle - a handle for reading the content of the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(java.lang.String docId,
                     T contentHandle,
                     ServerTransform transform,
                     Transaction transaction)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document content from an open database transaction as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    docId - the URI identifier for the document
    
    contentHandle - a handle for reading the content of the document
    
    transform - a server transform to modify the document content
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(DocumentDescriptor desc,
                     T contentHandle,
                     Transaction transaction)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document content from an open database transaction in the representation provided by the handle To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    contentHandle - a handle for reading the content of the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(DocumentDescriptor desc,
                     T contentHandle,
                     ServerTransform transform,
                     Transaction transaction)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document content from an open database transaction as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    contentHandle - a handle for reading the content of the document
    
    transform - a server transform to modify the document content
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(java.lang.String docId,
                     DocumentMetadataReadHandle metadataHandle,
                     T contentHandle,
                     Transaction transaction)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document metadata and content from an open database transaction in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    docId - the URI identifier for the document
    
    metadataHandle - a handle for reading the metadata of the document
    
    contentHandle - a handle for reading the content of the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(java.lang.String docId,
                     DocumentMetadataReadHandle metadataHandle,
                     T contentHandle,
                     ServerTransform transform,
                     Transaction transaction)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document metadata and content from an open database transaction as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    docId - the URI identifier for the document
    
    metadataHandle - a handle for reading the metadata of the document
    
    contentHandle - a handle for reading the content of the document
    
    transform - a server transform to modify the document content
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(DocumentDescriptor desc,
                     DocumentMetadataReadHandle metadataHandle,
                     T contentHandle,
                     Transaction transaction)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document metadata and content from an open database transaction in the representations provided by the handles To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    metadataHandle - a handle for reading the metadata of the document
    
    contentHandle - a handle for reading the content of the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
<T extends R> T read(DocumentDescriptor desc,
                     DocumentMetadataReadHandle metadataHandle,
                     T contentHandle,
                     ServerTransform transform,
                     Transaction transaction)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException
```
    Reads the document metadata and content from an open database transaction as transformed on the server. To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of content handle to return
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    metadataHandle - a handle for reading the metadata of the document
    
    contentHandle - a handle for reading the content of the document
    
    transform - a server transform to modify the document content
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the content handle populated with the content of the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - read
```
DocumentPage read(java.lang.String... uris)
```
    Reads from the database a list of documents matching the provided uris. Allows iteration across matching documents and metadata (only if setMetadataCategories has been called to request metadata). To find out how many of your uris matched, call the DocumentPage.size() method.
    
    Parameters:
    
    uris - the database uris identifying documents to retrieve
    
    Returns:
    
    the DocumentPage of matching documents and metadata
  - read
```
DocumentPage read(long serverTimestamp,
                  java.lang.String... uris)
```
    Reads from the database a list of documents matching the provided uris. Allows iteration across matching documents and metadata (only if setMetadataCategories has been called to request metadata). To find out how many of your uris matched, call the DocumentPage.size() method.
    
    Parameters:
    
    serverTimestamp - the point in time at which to read these documents. The value must be a merge timestamp obtained from the server via getServerTimestamp() on any handle.
    
    uris - the database uris identifying documents to retrieve
    
    Returns:
    
    the DocumentPage of matching documents and metadata
    
    Since:
    
    6.4.1
  - read
```
DocumentPage read(ServerTransform transform,
                  java.lang.String... uris)
```
    Reads from the database a list of documents matching the provided uris. Allows iteration across matching documents and metadata (only if setMetadataCategories has been called to request metadata). To find out how many of your uris matched, call the DocumentPage.size() method.
    
    Parameters:
    
    transform - the transform to be run on the server on each document (must already be installed)
    
    uris - the database uris identifying documents to retrieve
    
    Returns:
    
    the DocumentPage of matching documents and metadata
  - read
```
DocumentPage read(long serverTimestamp,
                  ServerTransform transform,
                  java.lang.String... uris)
```
    Reads from the database a list of documents matching the provided uris. Allows iteration across matching documents and metadata (only if setMetadataCategories has been called to request metadata). To find out how many of your uris matched, call the DocumentPage.size() method.
    
    Parameters:
    
    serverTimestamp - the point in time at which to read these documents. The value must be a merge timestamp obtained from the server via getServerTimestamp() on any handle.
    
    transform - the transform to be run on the server on each document (must already be installed)
    
    uris - the database uris identifying documents to retrieve
    
    Returns:
    
    the DocumentPage of matching documents and metadata
    
    Since:
    
    6.4.1
  - read
```
DocumentPage read(Transaction transaction,
                  java.lang.String... uris)
```
    Reads from the database a list of documents matching the provided uris. Allows iteration across matching documents and metadata (only if setMetadataCategories has been called to request metadata). To find out how many of your uris matched, call the DocumentPage.size() method.
    
    Parameters:
    
    transaction - the transaction in which this read is participating
    
    uris - the database uris identifying documents to retrieve
    
    Returns:
    
    the DocumentPage of matching documents and metadata
  - read
```
DocumentPage read(ServerTransform transform,
                  Transaction transaction,
                  java.lang.String... uris)
```
    Reads from the database a list of documents matching the provided uris. Allows iteration across matching documents and metadata (only if setMetadataCategories has been called to request metadata). To find out how many of your uris matched, call the DocumentPage.size() method.
    
    Parameters:
    
    transform - the transform to be run on the server on each document (must already be installed)
    
    transaction - the transaction in which this read is participating
    
    uris - the database uris identifying documents to retrieve
    
    Returns:
    
    the DocumentPage of matching documents and metadata
  - readMetadata
```
DocumentPage readMetadata(java.lang.String... uris)
```
    Reads from the database the metadata for a list of documents matching the provided uris. Allows iteration across the metadata for matching documents (only if setMetadataCategories has been called to request metadata). To find out how many of your uris matched, call the DocumentPage.size() method.
    
    Parameters:
    
    uris - the database uris identifying documents
    
    Returns:
    
    the DocumentPage of metadata from matching documents
  - readMetadata
```
DocumentPage readMetadata(Transaction transaction,
                          java.lang.String... uris)
```
    Reads from the database the metadata for a list of documents matching the provided uris. Allows iteration across the metadata for matching documents (only if setMetadataCategories has been called to request metadata). To find out how many of your uris matched, call the DocumentPage.size() method.
    
    Parameters:
    
    transaction - the transaction in which this read is participating
    
    uris - the database uris identifying documents
    
    Returns:
    
    the DocumentPage of metadata from matching documents
  - search
```
DocumentPage search(SearchQueryDefinition querydef,
                    long start)
```
    Just like QueryManager.search but return complete documents via iterable DocumentPage. Retrieves up to getPageLength() documents in each DocumentPage. If setMetadataCategories has been called, populates metadata for each result in the format specified by setNonDocumentFormat.
    
    Parameters:
    
    querydef - the definition of query criteria and query options
    
    start - the offset of the first document in the page (where 1 is the first result)
    
    Returns:
    
    the DocumentPage of matching documents and metadata
  - search
```
DocumentPage search(SearchQueryDefinition querydef,
                    long start,
                    java.lang.String forestName)
```
    Just like QueryManager.search but return complete documents via iterable DocumentPage. Retrieves up to getPageLength() documents in each DocumentPage. If setMetadataCategories has been called, populates metadata for each result in the format specified by setNonDocumentFormat.
    
    Parameters:
    
    querydef - the definition of query criteria and query options
    
    start - the offset of the first document in the page (where 1 is the first result)
    
    forestName - a forest to limit this search
    
    Returns:
    
    the DocumentPage of matching documents and metadata
  - search
```
DocumentPage search(SearchQueryDefinition querydef,
                    long start,
                    long serverTimestamp)
```
    Just like QueryManager.search but return complete documents via iterable DocumentPage. Retrieves up to getPageLength() documents in each DocumentPage. If setMetadataCategories has been called, populates metadata for each result in the format specified by setNonDocumentFormat.
    
    Parameters:
    
    querydef - the definition of query criteria and query options
    
    start - the offset of the first document in the page (where 1 is the first result)
    
    serverTimestamp - the point in time at which to read these documents. The value must be a merge timestamp obtained from the server via getServerTimestamp() on any handle.
    
    Returns:
    
    the DocumentPage of matching documents and metadata
    
    Since:
    
    6.4.1
  - search
```
DocumentPage search(SearchQueryDefinition querydef,
                    long start,
                    Transaction transaction)
```
    Just like QueryManager.search but return complete documents via iterable DocumentPage. Retrieves up to getPageLength() documents in each DocumentPage. If setMetadataCategories has been called, populates metadata for each result in the format specified by setNonDocumentFormat.
    
    Parameters:
    
    querydef - the definition of query criteria and query options
    
    start - the offset of the first document in the page (where 1 is the first result)
    
    transaction - an open transaction for matching documents
    
    Returns:
    
    the DocumentPage of matching documents and metadata
  - search
```
DocumentPage search(SearchQueryDefinition querydef,
                    long start,
                    Transaction transaction,
                    java.lang.String forestName)
```
    Just like QueryManager.search but return complete documents via iterable DocumentPage. Retrieves up to getPageLength() documents in each DocumentPage. If setMetadataCategories has been called, populates metadata for each result in the format specified by setNonDocumentFormat.
    
    Parameters:
    
    querydef - the definition of query criteria and query options
    
    start - the offset of the first document in the page (where 1 is the first result)
    
    transaction - an open transaction for matching documents
    
    forestName - a forest to limit this search
    
    Returns:
    
    the DocumentPage of matching documents and metadata
  - search
```
DocumentPage search(SearchQueryDefinition querydef,
                    long start,
                    SearchReadHandle searchHandle)
```
    Just like QueryManager.search but return complete documents via iterable DocumentPage. Retrieves up to getPageLength() documents in each DocumentPage. If searchHandle is not null, requests a search response and populates searchHandle with it. If setMetadataCategories has been called, populates metadata for each result in the format specified by setNonDocumentFormat.
    
    Parameters:
    
    querydef - the definition of query criteria and query options
    
    start - the offset of the first document in the page (where 1 is the first result)
    
    searchHandle - a handle for reading the search response which will include view types specified by setSearchView and format specified by setNonDocumentFormat
    
    Returns:
    
    the DocumentPage of matching documents and metadata
  - search
```
DocumentPage search(SearchQueryDefinition querydef,
                    long start,
                    SearchReadHandle searchHandle,
                    java.lang.String forestName)
```
    Just like QueryManager.search but return complete documents via iterable DocumentPage. Retrieves up to getPageLength() documents in each DocumentPage. If searchHandle is not null, requests a search response and populates searchHandle with it. If setMetadataCategories has been called, populates metadata for each result in the format specified by setNonDocumentFormat.
    
    Parameters:
    
    querydef - the definition of query criteria and query options
    
    start - the offset of the first document in the page (where 1 is the first result)
    
    searchHandle - a handle for reading the search response which will include view types specified by setSearchView and format specified by setNonDocumentFormat
    
    forestName - a forest to limit this search
    
    Returns:
    
    the DocumentPage of matching documents and metadata
  - search
```
DocumentPage search(SearchQueryDefinition querydef,
                    long start,
                    SearchReadHandle searchHandle,
                    Transaction transaction)
```
    Just like QueryManager.search(SearchQueryDefinition, SearchReadHandle, long, Transaction) but return complete documents via iterable DocumentPage. Retrieves up to getPageLength() documents in each DocumentPage. If searchHandle is not null, requests a search response and populates searchHandle with it. If setMetadataCategories has been called, populates metadata for each result in the format specified by setNonDocumentFormat.
    
    Parameters:
    
    querydef - the definition of query criteria and query options
    
    start - the offset of the first document in the page (where 1 is the first result)
    
    searchHandle - a handle for reading the search response which will include view types specified by setSearchView and format specified by setNonDocumentFormat
    
    transaction - an open transaction for matching documents
    
    Returns:
    
    the DocumentPage of matching documents and metadata
  - search
```
DocumentPage search(SearchQueryDefinition querydef,
                    long start,
                    SearchReadHandle searchHandle,
                    Transaction transaction,
                    java.lang.String forestName)
```
    Just like QueryManager.search(SearchQueryDefinition, SearchReadHandle, long, Transaction, String) but return complete documents via iterable DocumentPage. Retrieves up to getPageLength() documents in each DocumentPage. If searchHandle is not null, requests a search response and populates searchHandle with it. If setMetadataCategories has been called, populates metadata for each result in the format specified by setNonDocumentFormat.
    
    Parameters:
    
    querydef - the definition of query criteria and query options
    
    start - the offset of the first document in the page (where 1 is the first result)
    
    searchHandle - a handle for reading the search response which will include view types specified by setSearchView and format specified by setNonDocumentFormat
    
    transaction - an open transaction for matching documents
    
    forestName - a forest to limit this search
    
    Returns:
    
    the DocumentPage of matching documents and metadata
  - getPageLength
```
long getPageLength()
```
    Get the maximum number of records to return in a page from calls to search
    
    Returns:
    
    the maximum number of records to return in a page from calls to search
  - setPageLength
```
void setPageLength(long length)
```
    Specifies the maximum number of documents that can appear in any page of the query results, overriding any maximum specified in the query options.
    
    Parameters:
    
    length - the maximum number of records to return in a page from calls to search
  - getNonDocumentFormat
```
Format getNonDocumentFormat()
```
    Returns the format (if set) for the search response from search and metadata available from DocumentPage.next().getMetadata(handle) (assuming setMetadataCategories has been called to request specific metadata). If setNonDocumentFormat has not been called, the server default format will be used.
    
    Returns:
    
    the format, if set, null otherwise
  - setNonDocumentFormat
```
void setNonDocumentFormat(Format nonDocumentFormat)
```
    Specifies the format for the search response from search and metadata available from DocumentPage.next().getMetadata(handle) (assuming setMetadataCategories has been called to request specific metadata). If setNonDocumentFormat is not called, the server default format will be used.
    
    Parameters:
    
    nonDocumentFormat - the format to use
  - getSearchView
```
QueryManager.QueryView getSearchView()
```
    Returns the view types included in a SearchReadHandle populated by calls to search
    
    Returns:
    
    the view types included in a SearchReadHandle populated by calls to search
  - setSearchView
```
void setSearchView(QueryManager.QueryView view)
```
    Specifies the view types included in a SearchReadHandle populated by calls to search
    
    Parameters:
    
    view - the view types included in a SearchReadHandle populated by calls to search
  - newWriteSet
```
DocumentWriteSet newWriteSet()
```
  - write
```
void write(DocumentWriteSet writeSet)
```
    Write a set of documents and metadata to the server via REST API bulk capabilities.
    
    Parameters:
    
    writeSet - the set of documents and metadata to write
    
    See Also:
    
    REST API -> Reading and Writing Multiple Documents
  - write
```
void write(DocumentWriteSet writeSet,
           ServerTransform transform)
```
    Write a set of documents and metadata to the server via REST API bulk capabilities.
    
    Parameters:
    
    writeSet - the set of documents and metadata to write
    
    transform - a server transform to modify the contents of each document
    
    See Also:
    
    REST API -> Reading and Writing Multiple Documents
  - write
```
void write(DocumentWriteSet writeSet,
           Transaction transaction)
```
    Write a set of documents and metadata to the server via REST API bulk capabilities.
    
    Parameters:
    
    writeSet - the set of documents and metadata to write
    
    transaction - an open transaction under which the documents will be written
    
    See Also:
    
    REST API -> Reading and Writing Multiple Documents
  - write
```
void write(DocumentWriteSet writeSet,
           ServerTransform transform,
           Transaction transaction)
```
    Write a set of documents and metadata to the server via REST API bulk capabilities.
    
    Parameters:
    
    writeSet - the set of documents and metadata to write
    
    transform - a server transform to modify the contents of each document
    
    transaction - an open transaction under which the documents will be written
    
    See Also:
    
    REST API -> Reading and Writing Multiple Documents
  - writeAs
```
void writeAs(java.lang.String docId,
             java.lang.Object content)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException
```
    Writes the document content to the database from an object of an IO class. 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
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - writeAs
```
void writeAs(java.lang.String docId,
             java.lang.Object content,
             ServerTransform transform)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException
```
    Writes the document content to the database from an object of an IO class. 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
    
    transform - a server transform to modify the document content
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - writeAs
```
void writeAs(java.lang.String docId,
             DocumentMetadataWriteHandle metadataHandle,
             java.lang.Object content)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException
```
    Writes the document content to the database from an object of an IO class. 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
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - writeAs
```
void writeAs(java.lang.String docId,
             DocumentMetadataWriteHandle metadataHandle,
             java.lang.Object content,
             ServerTransform transform)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException
```
    Writes the document content to the database from an object of an IO class. 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
    
    transform - a server transform to modify the document content
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(java.lang.String docId,
           W contentHandle)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document content to the database from the representation provided by the handle To call write(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    contentHandle - a handle for writing the content of the document
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(java.lang.String docId,
           W contentHandle,
           ServerTransform transform)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document content to the database as transformed on the server. To call write(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    contentHandle - a handle for writing the content of the document
    
    transform - a server transform to modify the document content
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(DocumentDescriptor desc,
           W contentHandle)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document content to the database from the representation provided by the handle To call write(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    contentHandle - a handle for writing the content of the document
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(DocumentDescriptor desc,
           W contentHandle,
           ServerTransform transform)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document content to the database as transformed on the server. To call write(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    contentHandle - a handle for writing the content of the document
    
    transform - a server transform to modify the document content
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(java.lang.String docId,
           DocumentMetadataWriteHandle metadataHandle,
           W contentHandle)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document metadata and content to the database from the representations provided by the handles To call write(), an application must authenticate as rest-writer or rest-admin.
    
    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
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(java.lang.String docId,
           DocumentMetadataWriteHandle metadataHandle,
           W contentHandle,
           ServerTransform transform)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document metadata and content to the database as transformed on the server. To call write(), an application must authenticate as rest-writer or rest-admin.
    
    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
    
    transform - a server transform to modify the document content
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(DocumentDescriptor desc,
           DocumentMetadataWriteHandle metadataHandle,
           W contentHandle)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document metadata and content to the database from the representations provided by the handles To call write(), an application must authenticate as rest-writer or rest-admin.
    
    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
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(DocumentDescriptor desc,
           DocumentMetadataWriteHandle metadataHandle,
           W contentHandle,
           ServerTransform transform)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document metadata and content to the database as transformed on the server. To call write(), an application must authenticate as rest-writer or rest-admin.
    
    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
    
    transform - a server transform to modify the document content
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(java.lang.String docId,
           W contentHandle,
           Transaction transaction)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document content to an open database transaction from the representation provided by the handle To call write(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    contentHandle - a handle for writing the content of the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(java.lang.String docId,
           W contentHandle,
           ServerTransform transform,
           Transaction transaction)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document content to an open database transaction as transformed on the server. To call write(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    contentHandle - a handle for writing the content of the document
    
    transform - a server transform to modify the document content
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(DocumentDescriptor desc,
           W contentHandle,
           Transaction transaction)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document content to an open database transaction from the representation provided by the handle To call write(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    contentHandle - a handle for writing the content of the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(DocumentDescriptor desc,
           W contentHandle,
           ServerTransform transform,
           Transaction transaction)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document content to an open database transaction as transformed on the server. To call write(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    contentHandle - a handle for writing the content of the document
    
    transform - a server transform to modify the document content
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(java.lang.String docId,
           DocumentMetadataWriteHandle metadataHandle,
           W contentHandle,
           Transaction transaction)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document metadata and content to an open database transaction from the representations provided by the handles To call write(), an application must authenticate as rest-writer or rest-admin.
    
    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
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(java.lang.String docId,
           DocumentMetadataWriteHandle metadataHandle,
           W contentHandle,
           ServerTransform transform,
           Transaction transaction)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document metadata and content to an open database transaction as transformed on the server. To call write(), an application must authenticate as rest-writer or rest-admin.
    
    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
    
    transform - a server transform to modify the document content
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(DocumentDescriptor desc,
           DocumentMetadataWriteHandle metadataHandle,
           W contentHandle,
           Transaction transaction)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document metadata and content to an open database transaction from the representations provided by the handles To call write(), an application must authenticate as rest-writer or rest-admin.
    
    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
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - write
```
void write(DocumentDescriptor desc,
           DocumentMetadataWriteHandle metadataHandle,
           W contentHandle,
           ServerTransform transform,
           Transaction transaction)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException
```
    Writes the document metadata and content to an open database transaction as transformed on the server. To call write(), an application must authenticate as rest-writer or rest-admin.
    
    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
    
    transform - a server transform to modify the document content
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Throws:
    
    ResourceNotFoundException
    
    ForbiddenUserException
    
    FailedRequestException
  - delete
```
void delete(java.lang.String docId)
     throws ResourceNotFoundException,
            ForbiddenUserException,
            FailedRequestException
```
    Deletes the document metadata and content from the database To call delete(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - delete
```
void delete(java.lang.String docId,
            Transaction transaction)
     throws ResourceNotFoundException,
            ForbiddenUserException,
            FailedRequestException
```
    Deletes the document metadata and content from an open database transaction To call delete(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - delete
```
void delete(java.lang.String... uris)
     throws ResourceNotFoundException,
            ForbiddenUserException,
            FailedRequestException
```
    Deletes the documents' metadata and content To call delete(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    uris - the identifiers for the documents to delete
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - delete
```
void delete(Transaction transaction,
            java.lang.String... uris)
     throws ResourceNotFoundException,
            ForbiddenUserException,
            FailedRequestException
```
    Deletes the documents' metadata and content from an open database transaction To call delete(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    transaction - an open transaction
    
    uris - the identifiers for the documents to delete
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - delete
```
void delete(DocumentDescriptor desc)
     throws ResourceNotFoundException,
            ForbiddenUserException,
            FailedRequestException
```
    Deletes the document metadata and content from the database To call delete(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - delete
```
void delete(DocumentDescriptor desc,
            Transaction transaction)
     throws ResourceNotFoundException,
            ForbiddenUserException,
            FailedRequestException
```
    Deletes the document metadata and content from an open database transaction To call delete(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - createAs
```
DocumentDescriptor createAs(DocumentUriTemplate template,
                            java.lang.Object content)
                     throws ForbiddenUserException,
                            FailedRequestException
```
    Creates a database document with a uri assigned by the server from an object of an IO class. 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:
    
    template - the template for constructing the document uri
    
    content - an IO representation of the document content
    
    Returns:
    
    the database uri that identifies the created document
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - createAs
```
DocumentDescriptor createAs(DocumentUriTemplate template,
                            java.lang.Object content,
                            ServerTransform transform)
                     throws ForbiddenUserException,
                            FailedRequestException
```
    Creates a database document with a uri assigned by the server from an object of an IO class. 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:
    
    template - the template for constructing the document uri
    
    content - an IO representation of the document content
    
    transform - a server transform to modify the document content
    
    Returns:
    
    the database uri that identifies the created document
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - createAs
```
DocumentDescriptor createAs(DocumentUriTemplate template,
                            DocumentMetadataWriteHandle metadataHandle,
                            java.lang.Object content)
                     throws ForbiddenUserException,
                            FailedRequestException
```
    Creates a database document with a uri assigned by the server from an object of an IO class. 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:
    
    template - the template for constructing the document uri
    
    metadataHandle - a handle for writing the metadata of the document
    
    content - an IO representation of the document content
    
    Returns:
    
    the database uri that identifies the created document
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - createAs
```
DocumentDescriptor createAs(DocumentUriTemplate template,
                            DocumentMetadataWriteHandle metadataHandle,
                            java.lang.Object content,
                            ServerTransform transform)
                     throws ForbiddenUserException,
                            FailedRequestException
```
    Creates a database document with a uri assigned by the server from an object of an IO class. 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:
    
    template - the template for constructing the document uri
    
    metadataHandle - a handle for writing the metadata of the document
    
    content - an IO representation of the document content
    
    transform - a server transform to modify the document content
    
    Returns:
    
    the database uri that identifies the created document
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - create
```
DocumentDescriptor create(DocumentUriTemplate template,
                          W contentHandle)
                   throws ForbiddenUserException,
                          FailedRequestException
```
    Creates a database document with a uri assigned by the server.
    
    Parameters:
    
    template - the template for constructing the document uri
    
    contentHandle - a handle for writing the content of the document
    
    Returns:
    
    the database uri that identifies the created document
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - create
```
DocumentDescriptor create(DocumentUriTemplate template,
                          W contentHandle,
                          ServerTransform transform)
                   throws ForbiddenUserException,
                          FailedRequestException
```
    Creates a database document with a uri assigned by the server as transformed on the server.
    
    Parameters:
    
    template - the template for constructing the document uri
    
    contentHandle - a handle for writing the content of the document
    
    transform - a server transform to modify the document content
    
    Returns:
    
    the database uri that identifies the created document
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - create
```
DocumentDescriptor create(DocumentUriTemplate template,
                          W contentHandle,
                          Transaction transaction)
                   throws ForbiddenUserException,
                          FailedRequestException
```
    Creates a database document with a uri assigned by the server in an open database transaction.
    
    Parameters:
    
    template - the template for constructing the document uri
    
    contentHandle - a handle for writing the content of the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the database uri that identifies the created document
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - create
```
DocumentDescriptor create(DocumentUriTemplate template,
                          W contentHandle,
                          ServerTransform transform,
                          Transaction transaction)
                   throws ForbiddenUserException,
                          FailedRequestException
```
    Creates a database document with a uri assigned by the server in an open database transaction as transformed on the server.
    
    Parameters:
    
    template - the template for constructing the document uri
    
    contentHandle - a handle for writing the content of the document
    
    transform - a server transform to modify the document content
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the database uri that identifies the created document
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - create
```
DocumentDescriptor create(DocumentUriTemplate template,
                          DocumentMetadataWriteHandle metadataHandle,
                          W contentHandle)
                   throws ForbiddenUserException,
                          FailedRequestException
```
    Creates a database document with metadata and content and a uri assigned by the server.
    
    Parameters:
    
    template - the template for constructing the document uri
    
    metadataHandle - a handle for writing the metadata of the document
    
    contentHandle - a handle for writing the content of the document
    
    Returns:
    
    the database uri that identifies the created document
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - create
```
DocumentDescriptor create(DocumentUriTemplate template,
                          DocumentMetadataWriteHandle metadataHandle,
                          W contentHandle,
                          ServerTransform transform)
                   throws ForbiddenUserException,
                          FailedRequestException
```
    Creates a database document with metadata and content and a uri assigned by the server as transformed on the server.
    
    Parameters:
    
    template - the template for constructing the document uri
    
    metadataHandle - a handle for writing the metadata of the document
    
    contentHandle - a handle for writing the content of the document
    
    transform - a server transform to modify the document content
    
    Returns:
    
    the database uri that identifies the created document
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - create
```
DocumentDescriptor create(DocumentUriTemplate template,
                          DocumentMetadataWriteHandle metadataHandle,
                          W contentHandle,
                          Transaction transaction)
                   throws ForbiddenUserException,
                          FailedRequestException
```
    Parameters:
    
    template - the template for constructing the document uri
    
    metadataHandle - a handle for writing the metadata of the document
    
    contentHandle - a handle for writing the content of the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the database uri that identifies the created document
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - create
```
DocumentDescriptor create(DocumentUriTemplate template,
                          DocumentMetadataWriteHandle metadataHandle,
                          W contentHandle,
                          ServerTransform transform,
                          Transaction transaction)
                   throws ForbiddenUserException,
                          FailedRequestException
```
    Creates a database document with metadata and content and a uri assigned by the server in an open database transaction as transformed on the server.
    
    Parameters:
    
    template - the template for constructing the document uri
    
    metadataHandle - a handle for writing the metadata of the document
    
    contentHandle - a handle for writing the content of the document
    
    transform - a server transform to modify the document content
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the database uri that identifies the created document
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - patchAs
```
void patchAs(java.lang.String docId,
             java.lang.Object patch)
      throws ForbiddenUserException,
             FailedRequestException
```
    Modifies the metadata or content of a document within an open database transaction on the server. Content can only be modified for JSON or XML documents. You must use the setMetadataCategories() method to specify whether the patch includes metadata. An IO representation such as a string, input stream, or XML DOM specifies the patch as content. 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
    
    patch - an IO representation of the patch
    
    Throws:
    
    ForbiddenUserException
    
    FailedRequestException
  - patch
```
void patch(java.lang.String docId,
           DocumentPatchHandle patch)
```
    Modifies the metadata or content of a document within an open database transaction on the server. Content can only be modified for JSON or XML documents. When sending a raw JSON or XML patch, you must use the setMetadataCategories() method to specify whether the patch includes metadata. To call patch(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    patch - a handle for writing the modification to the document metadata or content
  - patch
```
void patch(java.lang.String docId,
           DocumentPatchHandle patch,
           Transaction transaction)
```
    Modifies the metadata or content of a document within an open database transaction on the server. Content can only be modified for JSON or XML documents. When sending a raw JSON or XML patch, you must use the setMetadataCategories() method to specify whether the patch includes metadata. To call patch(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    patch - a handle for writing the modification to the document metadata or content
    
    transaction - a open transaction
  - patch
```
void patch(DocumentDescriptor desc,
           DocumentPatchHandle patch)
```
    Modifies the metadata or content of a document. Content can only be modified for JSON or XML documents. When sending a raw JSON or XML patch, you must use the setMetadataCategories() method to specify whether the patch includes metadata. To call patch(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    patch - a handle for writing the modification to the document metadata or content
  - patch
```
void patch(DocumentDescriptor desc,
           DocumentPatchHandle patch,
           Transaction transaction)
```
    Modifies the metadata or content of a document within an open database transaction on the server. Content can only be modified for JSON or XML documents. When sending a raw JSON or XML patch, you must use the setMetadataCategories() method to specify whether the patch includes metadata. To call patch(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    desc - a descriptor for the URI identifier, format, and mimetype of the document
    
    patch - a handle for writing the modification to the document metadata or content
    
    transaction - a open transaction
  - readMetadata
```
<T extends DocumentMetadataReadHandle> T readMetadata(java.lang.String docId,
                                                      T metadataHandle)
                                               throws ResourceNotFoundException,
                                                      ForbiddenUserException,
                                                      FailedRequestException
```
    Reads the document metadata from the database in the representation provided by the handle To call readMetadata(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of DocumentMetadataReadHandle to return
    
    Parameters:
    
    docId - the URI identifier for the document
    
    metadataHandle - a handle for reading the metadata of the document
    
    Returns:
    
    the metadata handle populated with the metadata for the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - readMetadata
```
<T extends DocumentMetadataReadHandle> T readMetadata(java.lang.String docId,
                                                      T metadataHandle,
                                                      Transaction transaction)
                                               throws ResourceNotFoundException,
                                                      ForbiddenUserException,
                                                      FailedRequestException
```
    Reads the document metadata from an open database transaction in the representation provided by the handle To call readMetadata(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
    
    Type Parameters:
    
    T - the type of DocumentMetadataReadHandle to return
    
    Parameters:
    
    docId - the URI identifier for the document
    
    metadataHandle - a handle for reading the metadata of the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Returns:
    
    the metadata handle populated with the metadata for the document in the database
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - writeMetadata
```
void writeMetadata(java.lang.String docId,
                   DocumentMetadataWriteHandle metadataHandle)
            throws ResourceNotFoundException,
                   ForbiddenUserException,
                   FailedRequestException
```
    Writes the document metadata to the database from the representation provided by the handle To call writeMetadata(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    metadataHandle - a handle for writing the metadata of the document
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - writeMetadata
```
void writeMetadata(java.lang.String docId,
                   DocumentMetadataWriteHandle metadataHandle,
                   Transaction transaction)
            throws ResourceNotFoundException,
                   ForbiddenUserException,
                   FailedRequestException
```
    Writes the document metadata to an open database transaction from the representation provided by the handle To call writeMetadata(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    metadataHandle - a handle for writing the metadata of the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - writeDefaultMetadata
```
void writeDefaultMetadata(java.lang.String docId)
                   throws ResourceNotFoundException,
                          ForbiddenUserException,
                          FailedRequestException
```
    Reverts the document metadata in the database to the defaults To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - writeDefaultMetadata
```
void writeDefaultMetadata(java.lang.String docId,
                          Transaction transaction)
                   throws ResourceNotFoundException,
                          ForbiddenUserException,
                          FailedRequestException
```
    Reverts the document metadata in an open database transaction to the defaults To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    docId - the URI identifier for the document
    
    transaction - a open transaction under which the document may have been created or deleted
    
    Throws:
    
    ResourceNotFoundException - if the document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - writeDefaultMetadata
```
void writeDefaultMetadata(java.lang.String... uris)
                   throws ResourceNotFoundException,
                          ForbiddenUserException,
                          FailedRequestException
```
    Reverts the metadata in the database for the documents to the defaults To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    uris - the identifiers for the documents to receive the default metadata
    
    Throws:
    
    ResourceNotFoundException - if a document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - writeDefaultMetadata
```
void writeDefaultMetadata(Transaction transaction,
                          java.lang.String... uris)
                   throws ResourceNotFoundException,
                          ForbiddenUserException,
                          FailedRequestException
```
    Reverts the document metadata in an open database transaction to the defaults To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
    
    Parameters:
    
    transaction - an open transaction
    
    uris - the identifiers for the documents to receive the default metadata
    
    Throws:
    
    ResourceNotFoundException - if a document is not found
    
    ForbiddenUserException
    
    FailedRequestException
  - getContentFormat
```
Format getContentFormat()
```
    Gets the default format of the managed documents
    
    Returns:
    
    the default format for documents supported by this document manager
  - setContentFormat
```
void setContentFormat(Format format)
```
    Sets the default format of the managed documents
    
    Parameters:
    
    format - the default format for documents supported by this document manager
  - getMetadataCategories
```
java.util.Set<DocumentManager.Metadata> getMetadataCategories()
```
    Returns the categories of metadata to read, write, patch, or search.
    
    Returns:
    
    the set of metadata categories
  - setMetadataCategories
```
void setMetadataCategories(java.util.Set<DocumentManager.Metadata> categories)
```
    Specifies the categories of metadata to read, write, patch, or search.
    
    Parameters:
    
    categories - the set of metadata categories
  - setMetadataCategories
```
void setMetadataCategories(DocumentManager.Metadata... categories)
```
    Specifies the categories of metadata to read, write, patch, or search.
    
    Parameters:
    
    categories - the set of metadata categories
  - clearMetadataCategories
```
void clearMetadataCategories()
```
    Clears the metadata categories.
  - getReadTransform
```
ServerTransform getReadTransform()
```
    Returns the transform for read requests that don't specify a transform.
    
    Returns:
    
    the name of the transform
  - setReadTransform
```
void setReadTransform(ServerTransform transform)
```
    Specifies a transform for read requests that don't specify a transform.
    
    Parameters:
    
    transform - the name of the transform
  - getWriteTransform
```
ServerTransform getWriteTransform()
```
    Returns the transform for write requests that don't specify a transform.
    
    Returns:
    
    the name of the transform
  - setWriteTransform
```
void setWriteTransform(ServerTransform transform)
```
    Specifies a transform for write requests that don't specify a transform.
    
    Parameters:
    
    transform - the name of the transform
  - startLogging
```
void startLogging(RequestLogger logger)
```
    Starts debugging client requests. You can suspend and resume debugging output using the methods of the logger.
    
    Parameters:
    
    logger - the logger that receives debugging output
  - stopLogging
```
void stopLogging()
```
    Stops debugging client requests.

Interface DocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>

Nested Class Summary

Method Summary

Method Detail

newDescriptor

newDocumentUriTemplate

newPatchBuilder

exists

exists

readAs

readAs

readAs

readAs

read

read

read

read

read

read

read

read

read

read

read

read

read

read

read

read

read

read

read

read

read

read

readMetadata

readMetadata

search

search

search

search

search

search

search

search

search

getPageLength

setPageLength

getNonDocumentFormat

setNonDocumentFormat

getSearchView

setSearchView

newWriteSet

write

write

write

write

writeAs

writeAs

writeAs

writeAs

write

write

write

write

write

write

write

write

write

write

write

write

write

write

write

write

delete

delete

delete