org.nuxeo.drive.service

Interface VersioningFileSystemItemFactory

All Superinterfaces:

FileSystemItemFactory

All Known Implementing Classes:

DefaultFileSystemItemFactory

public interface VersioningFileSystemItemFactory
extends FileSystemItemFactory

A FileSystemItemFactory able to handle versioning.

Author:

Antoine Taillefer

See Also:

DefaultFileSystemItemFactory

Method Summary

Methods

Modifier and Type	Method and Description
double	getVersioningDelay() Gets the delay passed which a document needs to be versioned since its last modification.
VersioningOption	getVersioningOption() Gets the increment option used when versioning a document.
boolean	needsVersioning(DocumentModel doc) Returns true if the given DocumentModel needs to be versioned.
void	setVersioningDelay(double versioningDelay) Sets the delay passed which a document needs to be versioned since its last modification.
void	setVersioningOption(VersioningOption versioningOption) Sets the increment option used when versioning a document.

Methods inherited from interface org.nuxeo.drive.service.FileSystemItemFactory

canHandleFileSystemItemId, exists, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItemById, getName, handleParameters, isFileSystemItem, isFileSystemItem, isFileSystemItem, setName

Method Detail

needsVersioning

boolean needsVersioning(DocumentModel doc)
                        throws ClientException

Returns true if the given DocumentModel needs to be versioned. An example of policy could be to version the document if the last modification was done more than getVersioningDelay() seconds ago.

Throws:

ClientException

See Also:

DocumentBackedFileItem.versionIfNeeded(DocumentModel doc, CoreSession session)

getVersioningDelay

double getVersioningDelay()

Gets the delay passed which a document needs to be versioned since its last modification.

See Also:

DefaultFileSystemItemFactory.needsVersioning(DocumentModel)

setVersioningDelay

void setVersioningDelay(double versioningDelay)

Sets the delay passed which a document needs to be versioned since its last modification.

getVersioningOption

VersioningOption getVersioningOption()

Gets the increment option used when versioning a document.

See Also:

DocumentBackedFileItem.versionIfNeeded(DocumentModel doc, CoreSession session)

setVersioningOption

void setVersioningOption(VersioningOption versioningOption)

Sets the increment option used when versioning a document.