com.marklogic.client.bitemporal

Interface TemporalDocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>

All Known Subinterfaces:

GenericDocumentManager, JSONDocumentManager, XMLDocumentManager

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TemporalDocumentManager.ProtectionLevel Various protection levels to prevent updation/deletion and wiping of temporal documents.

Method Summary

Modifier and Type	Method and Description
java.lang.String	advanceLsqt(java.lang.String temporalCollection) Enables Last Stable Query Time (LSQT) on the named collection and advances the LSQT for the collection to the maximum system start time.
java.lang.String	advanceLsqt(java.lang.String temporalCollection, long lag) Enables Last Stable Query Time (LSQT) on the named collection and advances the LSQT for the collection to the maximum system start time.
TemporalDescriptor	create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, java.lang.String temporalCollection) Just like create but create document in a temporalCollection, which will enforce all the rules of bitemporal data management.
TemporalDescriptor	create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, java.lang.String temporalCollection, java.util.Calendar systemTime) Just like create but create document at a specific system time
TemporalDescriptor	delete(DocumentDescriptor desc, Transaction transaction, java.lang.String temporalCollection) Just like delete but delete document in a temporalCollection, which will enforce all the rules of bitemporal data management.
TemporalDescriptor	delete(DocumentDescriptor desc, Transaction transaction, java.lang.String temporalCollection, java.util.Calendar systemTime) Just like delete but delete document at a specified system time
TemporalDescriptor	delete(java.lang.String docId, Transaction transaction, java.lang.String temporalCollection) Just like delete but delete document in a temporalCollection, which will enforce all the rules of bitemporal data management.
TemporalDescriptor	delete(java.lang.String docId, Transaction transaction, java.lang.String temporalCollection, java.util.Calendar systemTime) Just like delete but delete document at a specified system time
void	patch(java.lang.String uri, java.lang.String temporalCollection, DocumentPatchHandle patch) Modifies the content of a temporal JSON or XML document in the temporal collection.
void	patch(java.lang.String uri, java.lang.String temporalCollection, DocumentPatchHandle patch, Transaction transaction) Modifies the content of a temporal JSON or XML document in the temporal collection.
void	patch(java.lang.String uri, java.lang.String temporalDocumentURI, java.lang.String temporalCollection, java.lang.String sourceDocumentURI, DocumentPatchHandle patch) Patches a temporal document by taking the content from the sourceDocumentURI present in the temporalDocumentURI collection with the patch handle and creates a new version identified by the uri in the temporalCollection.
void	patch(java.lang.String uri, java.lang.String temporalDocumentURI, java.lang.String temporalCollection, java.lang.String sourceDocumentURI, DocumentPatchHandle patch, Transaction transaction) Patches a temporal document by taking the content from the sourceDocumentURI present in the temporalDocumentURI collection with the patch handle and creates a new version identified by the uri in the temporalCollection.
void	protect(java.lang.String temporalDocumentURI, java.lang.String temporalCollection, TemporalDocumentManager.ProtectionLevel level, java.util.Calendar expiryTime) Protects the temporal document from document update, wipe or delete till the expiryTime provided
void	protect(java.lang.String temporalDocumentURI, java.lang.String temporalCollection, TemporalDocumentManager.ProtectionLevel level, java.util.Calendar expiryTime, java.lang.String archivePath) Protects the temporal document from document update, wipe or delete till the expiryTime provided and saves the serialized copy of the current version in the path given
void	protect(java.lang.String temporalDocumentURI, java.lang.String temporalCollection, TemporalDocumentManager.ProtectionLevel level, java.util.Calendar expiryTime, java.lang.String archivePath, Transaction transaction) Protects the temporal document from document update, wipe or delete till the expiryTime provided and saves the serialized copy of the current version in the path given
void	protect(java.lang.String temporalDocumentURI, java.lang.String temporalCollection, TemporalDocumentManager.ProtectionLevel level, java.util.Calendar expiryTime, Transaction transaction) Protects the temporal document from document update, wipe or delete till the expiryTime provided
void	protect(java.lang.String temporalDocumentURI, java.lang.String temporalCollection, TemporalDocumentManager.ProtectionLevel level, javax.xml.datatype.Duration duration) Protects the temporal document from document update, wipe or delete for the specified duration.
void	protect(java.lang.String temporalDocumentURI, java.lang.String temporalCollection, TemporalDocumentManager.ProtectionLevel level, javax.xml.datatype.Duration duration, java.lang.String archivePath) Protects the temporal document from document update, wipe or delete till the expiryTime provided and saves the serialized copy of the current version in the path given
void	protect(java.lang.String temporalDocumentURI, java.lang.String temporalCollection, TemporalDocumentManager.ProtectionLevel level, javax.xml.datatype.Duration duration, java.lang.String archivePath, Transaction transaction) Protects the temporal document from document update, wipe or delete till the expiryTime provided and saves the serialized copy of the current version in the path given
void	protect(java.lang.String temporalDocumentURI, java.lang.String temporalCollection, TemporalDocumentManager.ProtectionLevel level, javax.xml.datatype.Duration duration, Transaction transaction) Protects the temporal document from document update, wipe or delete for the specified duration.
void	wipe(java.lang.String temporalDocumentURI, java.lang.String temporalCollection) Removes all the versions of the temporal document specified by the temporal document logical URI in the temporalCollection
void	wipe(java.lang.String temporalDocumentURI, Transaction transaction, java.lang.String temporalCollection) Removes all the versions of the temporal document specified by the temporal document logical URI in the temporalCollection
TemporalDescriptor	write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, java.lang.String temporalCollection) Just like write but write document in a temporalCollection, which will enforce all the rules of bitemporal data management.
TemporalDescriptor	write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, java.lang.String temporalCollection, java.util.Calendar systemTime) Just like write but write document at a specific system time
TemporalDescriptor	write(DocumentDescriptor desc, java.lang.String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, java.lang.String temporalCollection) Just like write but creates a new version of the document in the logical temporal collection URI passed as argument and names the new version of the document as the URI in the Document descriptor
TemporalDescriptor	write(DocumentDescriptor desc, java.lang.String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, java.lang.String temporalCollection, java.util.Calendar systemTime) Just like write but writes document at a specific system time
void	write(DocumentWriteSet writeSet, ServerTransform transform, Transaction transaction, java.lang.String temporalCollection) Just like write but create document in a temporalCollection, which will enforce all the rules of bitemporal data management.
TemporalDescriptor	write(java.lang.String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, java.lang.String temporalCollection) Just like write but write document in a temporalCollection, which will enforce all the rules of bitemporal data management.
TemporalDescriptor	write(java.lang.String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, java.lang.String temporalCollection, java.util.Calendar systemTime) Just like write but write document at a specific system time
TemporalDescriptor	write(java.lang.String uri, java.lang.String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, java.lang.String temporalCollection) Just like write but creates a new version of the document in the logical temporal collection URI passed as argument and names the new version of the document as the docId passed.
TemporalDescriptor	write(java.lang.String uri, java.lang.String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, java.lang.String temporalCollection, java.util.Calendar systemTime) Just like write but writes document at a specific system time

Method Detail

advanceLsqt

java.lang.String advanceLsqt(java.lang.String temporalCollection)

Enables Last Stable Query Time (LSQT) on the named collection and advances the LSQT for the collection to the maximum system start time. When LSQT is enabled on the temporal collection, you can use the systemTime argument on many of the other TemporalDocumentManager methods. The system time is returned in ISO 8601 format like all MarkLogic timestamps. It can be parsed by DatatypeConverter.parseDateTime but will lose precision since java.util.Calendar only supports millisecond precision. Requires a user with the "rest-admin" privilege. For details on how to use LSQT, see [Last Stable Query Time (LSQT) and Application-controlled System Time](http://docs.marklogic.com/guide/temporal/managing#id_75536) in the *Temporal Developer's Guide*.

Parameters:

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

Returns:

the temporal system time

advanceLsqt

java.lang.String advanceLsqt(java.lang.String temporalCollection,
                             long lag)

Enables Last Stable Query Time (LSQT) on the named collection and advances the LSQT for the collection to the maximum system start time. When LSQT is enabled on the temporal collection, you can use the systemTime argument on many of the other TemporalDocumentManager methods. The system time is returned in ISO 8601 format like all MarkLogic timestamps. It can be parsed by DatatypeConverter.parseDateTime but will lose precision since java.util.Calendar only supports millisecond precision. Requires a user with the "rest-admin" privilege. For details on how to use LSQT, see [Last Stable Query Time (LSQT) and Application-controlled System Time](http://docs.marklogic.com/guide/temporal/managing#id_75536) in the *Temporal Developer's Guide*.

Parameters:

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

lag - the milliseconds behind the maximum system start time to set LSQT

Returns:

the temporal system time

create

TemporalDescriptor create(DocumentUriTemplate template,
                          DocumentMetadataWriteHandle metadataHandle,
                          W contentHandle,
                          ServerTransform transform,
                          Transaction transaction,
                          java.lang.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 TemporalDescriptor including the database uri that identifies the created document, as well as the temporal system time when the document was created

Throws:

ForbiddenUserException

FailedRequestException

write

TemporalDescriptor write(DocumentDescriptor desc,
                         DocumentMetadataWriteHandle metadataHandle,
                         W contentHandle,
                         ServerTransform transform,
                         Transaction transaction,
                         java.lang.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

Returns:

the TemporalDescriptor with the temporal system time when the document was written

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

write

TemporalDescriptor write(java.lang.String docId,
                         DocumentMetadataWriteHandle metadataHandle,
                         W contentHandle,
                         ServerTransform transform,
                         Transaction transaction,
                         java.lang.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

Returns:

the TemporalDescriptor with the temporal system time when the document was written

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

delete

TemporalDescriptor delete(DocumentDescriptor desc,
                          Transaction transaction,
                          java.lang.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

Returns:

the TemporalDescriptor with the temporal system time when the document was deleted

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

delete

TemporalDescriptor delete(java.lang.String docId,
                          Transaction transaction,
                          java.lang.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

Returns:

the TemporalDescriptor with the temporal system time when the document was deleted

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

create

TemporalDescriptor create(DocumentUriTemplate template,
                          DocumentMetadataWriteHandle metadataHandle,
                          W contentHandle,
                          ServerTransform transform,
                          Transaction transaction,
                          java.lang.String temporalCollection,
                          java.util.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, as well as the temporal system time when the document was created

Throws:

ForbiddenUserException

FailedRequestException

write

TemporalDescriptor write(DocumentDescriptor desc,
                         DocumentMetadataWriteHandle metadataHandle,
                         W contentHandle,
                         ServerTransform transform,
                         Transaction transaction,
                         java.lang.String temporalCollection,
                         java.util.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

Returns:

the TemporalDescriptor with the temporal system time when the document was written

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

write

TemporalDescriptor write(java.lang.String docId,
                         DocumentMetadataWriteHandle metadataHandle,
                         W contentHandle,
                         ServerTransform transform,
                         Transaction transaction,
                         java.lang.String temporalCollection,
                         java.util.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

Returns:

the TemporalDescriptor with the temporal system time when the document was written

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

write

void write(DocumentWriteSet writeSet,
           ServerTransform transform,
           Transaction transaction,
           java.lang.String temporalCollection)

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

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

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

See Also:

REST API -> Reading and Writing Multiple Documents

write

TemporalDescriptor write(DocumentDescriptor desc,
                         java.lang.String temporalDocumentURI,
                         DocumentMetadataWriteHandle metadataHandle,
                         W contentHandle,
                         ServerTransform transform,
                         Transaction transaction,
                         java.lang.String temporalCollection)

Just like write but creates a new version of the document in the logical temporal collection URI passed as argument and names the new version of the document as the URI in the Document descriptor

Parameters:

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

temporalDocumentURI - the logical temporal document collection URI 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

Returns:

the TemporalDescriptor with the temporal system time when the document was written

write

TemporalDescriptor write(java.lang.String uri,
                         java.lang.String temporalDocumentURI,
                         DocumentMetadataWriteHandle metadataHandle,
                         W contentHandle,
                         ServerTransform transform,
                         Transaction transaction,
                         java.lang.String temporalCollection)

Just like write but creates a new version of the document in the logical temporal collection URI passed as argument and names the new version of the document as the docId passed.

Parameters:

uri - the version URI identifier for the document

temporalDocumentURI - the logical temporal document collection URI 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

Returns:

the TemporalDescriptor with the temporal system time when the document was written

write

TemporalDescriptor write(java.lang.String uri,
                         java.lang.String temporalDocumentURI,
                         DocumentMetadataWriteHandle metadataHandle,
                         W contentHandle,
                         ServerTransform transform,
                         Transaction transaction,
                         java.lang.String temporalCollection,
                         java.util.Calendar systemTime)

Just like write but writes document at a specific system time

Parameters:

uri - the version URI identifier for the document

temporalDocumentURI - the logical temporal document collection URI 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

Returns:

the TemporalDescriptor with the temporal system time when the document was written

write

TemporalDescriptor write(DocumentDescriptor desc,
                         java.lang.String temporalDocumentURI,
                         DocumentMetadataWriteHandle metadataHandle,
                         W contentHandle,
                         ServerTransform transform,
                         Transaction transaction,
                         java.lang.String temporalCollection,
                         java.util.Calendar systemTime)

Just like write but writes document at a specific system time

Parameters:

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

temporalDocumentURI - the logical temporal document collection URI 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

Returns:

the TemporalDescriptor with the temporal system time when the document was written

delete

TemporalDescriptor delete(DocumentDescriptor desc,
                          Transaction transaction,
                          java.lang.String temporalCollection,
                          java.util.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

Returns:

the TemporalDescriptor with the temporal system time when the document was deleted

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

delete

TemporalDescriptor delete(java.lang.String docId,
                          Transaction transaction,
                          java.lang.String temporalCollection,
                          java.util.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

Returns:

the TemporalDescriptor with the temporal system time when the document was deleted

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

wipe

void wipe(java.lang.String temporalDocumentURI,
          Transaction transaction,
          java.lang.String temporalCollection)

Removes all the versions of the temporal document specified by the temporal document logical URI in the temporalCollection

Parameters:

temporalDocumentURI - the logical temporal document URI of the document to be wiped

transaction - an open transaction

temporalCollection - the name of the temporal collection existing in the database from which this temporal document should be wiped

wipe

void wipe(java.lang.String temporalDocumentURI,
          java.lang.String temporalCollection)

Removes all the versions of the temporal document specified by the temporal document logical URI in the temporalCollection

Parameters:

temporalDocumentURI - the logical temporal document URI of the document to be wiped

temporalCollection - the name of the temporal collection existing in the database from which this temporal document should be wiped

protect

void protect(java.lang.String temporalDocumentURI,
             java.lang.String temporalCollection,
             TemporalDocumentManager.ProtectionLevel level,
             java.util.Calendar expiryTime)

Protects the temporal document from document update, wipe or delete till the expiryTime provided

Parameters:

temporalDocumentURI - the logical temporal document URI of the document to be protected

temporalCollection - the name of the temporal collection which contains the temporal document

level - the Protection level acquired - NODELETE, NOWIPE or NOUPDATE. Default value is NODELETE

expiryTime - the exact date time when the document protection expires

protect

void protect(java.lang.String temporalDocumentURI,
             java.lang.String temporalCollection,
             TemporalDocumentManager.ProtectionLevel level,
             java.util.Calendar expiryTime,
             java.lang.String archivePath)

Protects the temporal document from document update, wipe or delete till the expiryTime provided and saves the serialized copy of the current version in the path given

Parameters:

temporalDocumentURI - the logical temporal document URI of the document to be protected

temporalCollection - the name of the temporal collection which contains the temporal document

level - the Protection level acquired - NODELETE, NOWIPE or NOUPDATE. Default value is NODELETE

expiryTime - the exact date time when the document protection expires

archivePath - File path to save a serialized copy of the current version of the document

protect

void protect(java.lang.String temporalDocumentURI,
             java.lang.String temporalCollection,
             TemporalDocumentManager.ProtectionLevel level,
             javax.xml.datatype.Duration duration)

Protects the temporal document from document update, wipe or delete for the specified duration.

Parameters:

temporalDocumentURI - the logical temporal document URI of the document to be protected

temporalCollection - the name of the temporal collection which contains the temporal document

level - the Protection level acquired - NODELETE, NOWIPE, NOUPDATE. Default value is NODELETE

duration - the duration during which the document is protected

protect

void protect(java.lang.String temporalDocumentURI,
             java.lang.String temporalCollection,
             TemporalDocumentManager.ProtectionLevel level,
             javax.xml.datatype.Duration duration,
             java.lang.String archivePath)

Protects the temporal document from document update, wipe or delete till the expiryTime provided and saves the serialized copy of the current version in the path given

Parameters:

temporalDocumentURI - the logical temporal document URI of the document to be protected

temporalCollection - the name of the temporal collection which contains the temporal document

level - the Protection level acquired - NODELETE, NOWIPE, NOUPDATE. Default value is NODELETE

duration - the duration during which the document is protected

archivePath - File path to save a serialized copy of the current version of the document

protect

void protect(java.lang.String temporalDocumentURI,
             java.lang.String temporalCollection,
             TemporalDocumentManager.ProtectionLevel level,
             javax.xml.datatype.Duration duration,
             Transaction transaction)

Protects the temporal document from document update, wipe or delete for the specified duration.

Parameters:

temporalDocumentURI - the logical temporal document URI of the document to be protected

temporalCollection - the name of the temporal collection which contains the temporal document

level - the Protection level acquired - NODELETE, NOWIPE, NOUPDATE. Default value is NODELETE

duration - the duration during which the document is protected

transaction - an open transaction

protect

void protect(java.lang.String temporalDocumentURI,
             java.lang.String temporalCollection,
             TemporalDocumentManager.ProtectionLevel level,
             java.util.Calendar expiryTime,
             Transaction transaction)

Protects the temporal document from document update, wipe or delete till the expiryTime provided

Parameters:

temporalDocumentURI - the logical temporal document URI of the document to be protected

temporalCollection - the name of the temporal collection which contains the temporal document

level - the Protection level acquired - NODELETE, NOWIPE or NOUPDATE. Default value is NODELETE

expiryTime - the exact date time when the document protection expires

transaction - an open transaction

protect

void protect(java.lang.String temporalDocumentURI,
             java.lang.String temporalCollection,
             TemporalDocumentManager.ProtectionLevel level,
             javax.xml.datatype.Duration duration,
             java.lang.String archivePath,
             Transaction transaction)

Protects the temporal document from document update, wipe or delete till the expiryTime provided and saves the serialized copy of the current version in the path given

Parameters:

temporalDocumentURI - the logical temporal document URI of the document to be protected

temporalCollection - the name of the temporal collection which contains the temporal document

level - the Protection level acquired - NODELETE, NOWIPE, NOUPDATE. Default value is NODELETE

duration - the duration during which the document is protected

archivePath - File path to save a serialized copy of the current version of the document

transaction - an open transaction

protect

void protect(java.lang.String temporalDocumentURI,
             java.lang.String temporalCollection,
             TemporalDocumentManager.ProtectionLevel level,
             java.util.Calendar expiryTime,
             java.lang.String archivePath,
             Transaction transaction)

Protects the temporal document from document update, wipe or delete till the expiryTime provided and saves the serialized copy of the current version in the path given

Parameters:

temporalDocumentURI - the logical temporal document URI of the document to be protected

temporalCollection - the name of the temporal collection which contains the temporal document

level - the Protection level acquired - NODELETE, NOWIPE or NOUPDATE. Default value is NODELETE

expiryTime - the exact date time when the document protection expires

archivePath - File path to save a serialized copy of the current version of the document

transaction - an open transaction

patch

void patch(java.lang.String uri,
           java.lang.String temporalCollection,
           DocumentPatchHandle patch)

Modifies the content of a temporal JSON or XML document in the temporal collection.

Parameters:

uri - the URI identifier for the document

temporalCollection - the name of the temporal collection which contains the temporal document to be patched.

patch - a handle definition of what to patch in the document

patch

void patch(java.lang.String uri,
           java.lang.String temporalCollection,
           DocumentPatchHandle patch,
           Transaction transaction)

Modifies the content of a temporal JSON or XML document in the temporal collection.

Parameters:

uri - the URI identifier for the document

temporalCollection - the name of the temporal collection which contains the temporal document to be patched.

patch - a handle definition of what to patch in the document

transaction - an open transaction

patch

void patch(java.lang.String uri,
           java.lang.String temporalDocumentURI,
           java.lang.String temporalCollection,
           java.lang.String sourceDocumentURI,
           DocumentPatchHandle patch)

Patches a temporal document by taking the content from the sourceDocumentURI present in the temporalDocumentURI collection with the patch handle and creates a new version identified by the uri in the temporalCollection.

Parameters:

uri - the new version URI identifier for the document

temporalDocumentURI - the logical temporal document URI

temporalCollection - the name of the temporal collection which contains the temporal document to be patched.

sourceDocumentURI - the URI of the document to be used as the source of the patch

patch - a handle definition of what to patch in the document

patch

void patch(java.lang.String uri,
           java.lang.String temporalDocumentURI,
           java.lang.String temporalCollection,
           java.lang.String sourceDocumentURI,
           DocumentPatchHandle patch,
           Transaction transaction)

Patches a temporal document by taking the content from the sourceDocumentURI present in the temporalDocumentURI collection with the patch handle and creates a new version identified by the uri in the temporalCollection.

Parameters:

uri - the new version URI identifier for the document

temporalDocumentURI - the logical temporal document URI

temporalCollection - the name of the temporal collection which contains the temporal document to be patched.

sourceDocumentURI - the URI of the document to be used as the source of the patch

patch - a handle definition of what to patch in the document

transaction - an open transaction