com.marklogic.client.bitemporal

Interface TemporalDocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>

All Known Subinterfaces:

JSONDocumentManager, XMLDocumentManager

public interface TemporalDocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>

Method Summary

Methods

Modifier and Type	Method and Description
DocumentDescriptor	create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection) Just like create but create document in a temporalCollection, which will enforce all the rules of bitemporal data management.
DocumentDescriptor	create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection, Calendar systemTime) Just like create but create document at a specific system time
void	delete(DocumentDescriptor desc, Transaction transaction, String temporalCollection) Just like delete but delete document in a temporalCollection, which will enforce all the rules of bitemporal data management.
void	delete(DocumentDescriptor desc, Transaction transaction, String temporalCollection, Calendar systemTime) Just like delete but delete document at a specified system time
void	delete(String docId, Transaction transaction, String temporalCollection) Just like delete but delete document in a temporalCollection, which will enforce all the rules of bitemporal data management.
void	delete(String docId, Transaction transaction, String temporalCollection, Calendar systemTime) Just like delete but delete document at a specified system time
void	write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection) Just like write but write document in a temporalCollection, which will enforce all the rules of bitemporal data management.
void	write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection, Calendar systemTime) Just like write but write document at a specific system time
void	write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection) Just like write but write document in a temporalCollection, which will enforce all the rules of bitemporal data management.
void	write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection, Calendar systemTime) Just like write but write document at a specific system time

Method Detail

create

DocumentDescriptor create(DocumentUriTemplate template,
                        DocumentMetadataWriteHandle metadataHandle,
                        W contentHandle,
                        ServerTransform transform,
                        Transaction transaction,
                        String temporalCollection)
                          throws ForbiddenUserException,
                                 FailedRequestException

Just like create but create document in a temporalCollection, which will enforce all the rules of bitemporal data management.

Parameters:

template - the template for constructing the document uri

metadataHandle - a handle for writing the metadata of the document

contentHandle - an IO representation of the document content

transform - a server transform to modify the document content

transaction - an open transaction under which the document may have been created or deleted

temporalCollection - the name of the temporal collection existing in the database into which this document should be written

Returns:

the database uri that identifies the created document

Throws:

ForbiddenUserException

FailedRequestException

write

void write(DocumentDescriptor desc,
         DocumentMetadataWriteHandle metadataHandle,
         W contentHandle,
         ServerTransform transform,
         Transaction transaction,
         String temporalCollection)
           throws ResourceNotFoundException,
                  ForbiddenUserException,
                  FailedRequestException

Just like write but write document in a temporalCollection, which will enforce all the rules of bitemporal data management.

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 - an IO representation of the document content

transform - a server transform to modify the document content

transaction - an open transaction under which the document may have been created or deleted

temporalCollection - the name of the temporal collection existing in the database into which this document should be written

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

write

void write(String docId,
         DocumentMetadataWriteHandle metadataHandle,
         W contentHandle,
         ServerTransform transform,
         Transaction transaction,
         String temporalCollection)
           throws ResourceNotFoundException,
                  ForbiddenUserException,
                  FailedRequestException

Just like write but write document in a temporalCollection, which will enforce all the rules of bitemporal data management.

Parameters:

docId - the URI identifier for the document

metadataHandle - a handle for writing the metadata of the document

contentHandle - an IO representation of the document content

transform - a server transform to modify the document content

transaction - an open transaction under which the document may have been created or deleted

temporalCollection - the name of the temporal collection existing in the database into which this document should be written

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

delete

void delete(DocumentDescriptor desc,
          Transaction transaction,
          String temporalCollection)
            throws ResourceNotFoundException,
                   ForbiddenUserException,
                   FailedRequestException

Just like delete but delete document in a temporalCollection, which will enforce all the rules of bitemporal data management.

Parameters:

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

transaction - an open transaction under which the document may have been created or deleted

temporalCollection - the name of the temporal collection existing in the database in which this document should be marked as deleted

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

delete

void delete(String docId,
          Transaction transaction,
          String temporalCollection)
            throws ResourceNotFoundException,
                   ForbiddenUserException,
                   FailedRequestException

Just like delete but delete document in a temporalCollection, which will enforce all the rules of bitemporal data management.

Parameters:

docId - the URI identifier for the document

transaction - an open transaction under which the document may have been created or deleted

temporalCollection - the name of the temporal collection existing in the database in which this document should be marked as deleted

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

create

DocumentDescriptor create(DocumentUriTemplate template,
                        DocumentMetadataWriteHandle metadataHandle,
                        W contentHandle,
                        ServerTransform transform,
                        Transaction transaction,
                        String temporalCollection,
                        Calendar systemTime)
                          throws ForbiddenUserException,
                                 FailedRequestException

Just like create but create document at a specific system time

Parameters:

template - the template for constructing the document uri

metadataHandle - a handle for writing the metadata of the document

contentHandle - an IO representation of the document content

transform - a server transform to modify the document content

transaction - an open transaction under which the document may have been created or deleted

temporalCollection - the name of the temporal collection existing in the database into which this document should be written

systemTime - the application-specified system time with which this document will be marked

Returns:

the database uri that identifies the created document

Throws:

ForbiddenUserException

FailedRequestException

write

void write(DocumentDescriptor desc,
         DocumentMetadataWriteHandle metadataHandle,
         W contentHandle,
         ServerTransform transform,
         Transaction transaction,
         String temporalCollection,
         Calendar systemTime)
           throws ResourceNotFoundException,
                  ForbiddenUserException,
                  FailedRequestException

Just like write but write document at a specific system time

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 - an IO representation of the document content

transform - a server transform to modify the document content

transaction - an open transaction under which the document may have been created or deleted

temporalCollection - the name of the temporal collection existing in the database into which this document should be written

systemTime - the application-specified system time with which this document will be marked

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

write

void write(String docId,
         DocumentMetadataWriteHandle metadataHandle,
         W contentHandle,
         ServerTransform transform,
         Transaction transaction,
         String temporalCollection,
         Calendar systemTime)
           throws ResourceNotFoundException,
                  ForbiddenUserException,
                  FailedRequestException

Just like write but write document at a specific system time

Parameters:

docId - the URI identifier for the document

metadataHandle - a handle for writing the metadata of the document

contentHandle - an IO representation of the document content

transform - a server transform to modify the document content

transaction - an open transaction under which the document may have been created or deleted

temporalCollection - the name of the temporal collection existing in the database into which this document should be written

systemTime - the application-specified system time with which this document will be marked

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

delete

void delete(DocumentDescriptor desc,
          Transaction transaction,
          String temporalCollection,
          Calendar systemTime)
            throws ResourceNotFoundException,
                   ForbiddenUserException,
                   FailedRequestException

Just like delete but delete document at a specified system time

Parameters:

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

transaction - an open transaction under which the document may have been created or deleted

temporalCollection - the name of the temporal collection existing in the database in which this document should be marked as deleted

systemTime - the application-specified system time with which this document will be marked

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

delete

void delete(String docId,
          Transaction transaction,
          String temporalCollection,
          Calendar systemTime)
            throws ResourceNotFoundException,
                   ForbiddenUserException,
                   FailedRequestException

Just like delete but delete document at a specified system time

Parameters:

docId - the URI identifier for the document

transaction - an open transaction under which the document may have been created or deleted

temporalCollection - the name of the temporal collection existing in the database in which this document should be marked as deleted

systemTime - the application-specified system time with which this document will be marked

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException