public interface TemporalDocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>
Modifier and Type | Method and Description |
---|---|
TemporalDescriptor |
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. |
TemporalDescriptor |
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 |
TemporalDescriptor |
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. |
TemporalDescriptor |
delete(DocumentDescriptor desc,
Transaction transaction,
String temporalCollection,
Calendar systemTime)
Just like
delete but delete
document at a specified system time |
TemporalDescriptor |
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. |
TemporalDescriptor |
delete(String docId,
Transaction transaction,
String temporalCollection,
Calendar systemTime)
Just like
delete but delete
document at a specified system time |
TemporalDescriptor |
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. |
TemporalDescriptor |
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(DocumentWriteSet writeSet,
ServerTransform transform,
Transaction transaction,
String temporalCollection)
Just like
write but create document in a temporalCollection, which will enforce all the rules of
bitemporal data management. |
TemporalDescriptor |
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. |
TemporalDescriptor |
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 |
TemporalDescriptor create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection) throws ForbiddenUserException, FailedRequestException
create
but create document
in a temporalCollection, which will enforce all the rules of
bitemporal data management.template
- the template for constructing the document urimetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- an IO representation of the document contenttransform
- a server transform to modify the document contenttransaction
- an open transaction under which the document may have been created or deletedtemporalCollection
- the name of the temporal collection existing in the database into
which this document should be writtenForbiddenUserException
FailedRequestException
TemporalDescriptor write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
write
but write document
in a temporalCollection, which will enforce all the rules of
bitemporal data management.desc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- an IO representation of the document contenttransform
- a server transform to modify the document contenttransaction
- an open transaction under which the document may have been created or deletedtemporalCollection
- the name of the temporal collection existing in the database into
which this document should be writtenResourceNotFoundException
ForbiddenUserException
FailedRequestException
TemporalDescriptor write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
write
but write document
in a temporalCollection, which will enforce all the rules of
bitemporal data management.docId
- the URI identifier for the documentmetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- an IO representation of the document contenttransform
- a server transform to modify the document contenttransaction
- an open transaction under which the document may have been created or deletedtemporalCollection
- the name of the temporal collection existing in the database into
which this document should be writtenResourceNotFoundException
ForbiddenUserException
FailedRequestException
TemporalDescriptor delete(DocumentDescriptor desc, Transaction transaction, String temporalCollection) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
delete
but delete
document in a temporalCollection, which will enforce all the rules of
bitemporal data management.desc
- a descriptor for the URI identifier, format, and mimetype of the documenttransaction
- an open transaction under which the document may have been created or deletedtemporalCollection
- the name of the temporal collection existing in the database in
which this document should be marked as deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
TemporalDescriptor delete(String docId, Transaction transaction, String temporalCollection) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
delete
but delete
document in a temporalCollection, which will enforce all the rules of
bitemporal data management.docId
- the URI identifier for the documenttransaction
- an open transaction under which the document may have been created or deletedtemporalCollection
- the name of the temporal collection existing in the database in
which this document should be marked as deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
TemporalDescriptor create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection, Calendar systemTime) throws ForbiddenUserException, FailedRequestException
create
but create document
at a specific system timetemplate
- the template for constructing the document urimetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- an IO representation of the document contenttransform
- a server transform to modify the document contenttransaction
- an open transaction under which the document may have been created or deletedtemporalCollection
- the name of the temporal collection existing in the database into
which this document should be writtensystemTime
- the application-specified system time with which this document will be markedForbiddenUserException
FailedRequestException
TemporalDescriptor write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection, Calendar systemTime) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
write
but write document
at a specific system timedesc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- an IO representation of the document contenttransform
- a server transform to modify the document contenttransaction
- an open transaction under which the document may have been created or deletedtemporalCollection
- the name of the temporal collection existing in the database into
which this document should be writtensystemTime
- the application-specified system time with which this document will be markedResourceNotFoundException
ForbiddenUserException
FailedRequestException
TemporalDescriptor write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction, String temporalCollection, Calendar systemTime) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
write
but write document
at a specific system timedocId
- the URI identifier for the documentmetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- an IO representation of the document contenttransform
- a server transform to modify the document contenttransaction
- an open transaction under which the document may have been created or deletedtemporalCollection
- the name of the temporal collection existing in the database into
which this document should be writtensystemTime
- the application-specified system time with which this document will be markedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(DocumentWriteSet writeSet, ServerTransform transform, Transaction transaction, String temporalCollection)
write
but create document in a temporalCollection, which will enforce all the rules of
bitemporal data management.writeSet
- the set of documents and metadata to writetransform
- a server transform to modify the contents of each documenttransaction
- an open transaction under which the documents will be writtentemporalCollection
- the name of the temporal collection existing in the database into
which this document should be writtenTemporalDescriptor delete(DocumentDescriptor desc, Transaction transaction, String temporalCollection, Calendar systemTime) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
delete
but delete
document at a specified system timedesc
- a descriptor for the URI identifier, format, and mimetype of the documenttransaction
- an open transaction under which the document may have been created or deletedtemporalCollection
- the name of the temporal collection existing in the database in
which this document should be marked as deletedsystemTime
- the application-specified system time with which this document will be markedResourceNotFoundException
ForbiddenUserException
FailedRequestException
TemporalDescriptor delete(String docId, Transaction transaction, String temporalCollection, Calendar systemTime) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
delete
but delete
document at a specified system timedocId
- the URI identifier for the documenttransaction
- an open transaction under which the document may have been created or deletedtemporalCollection
- the name of the temporal collection existing in the database in
which this document should be marked as deletedsystemTime
- the application-specified system time with which this document will be markedResourceNotFoundException
ForbiddenUserException
FailedRequestException
Copyright © 2013-2016 MarkLogic Corporation.