org.olat.core.util.vfs.version
Interface Versions

All Known Implementing Classes:
NotVersioned, VersionsFileImpl

public interface Versions

Description:
The interface which enabled the versioning

Initial Date: 21 sept. 2009

Author:
srosse

Method Summary
 boolean addVersion(Identity identity, java.lang.String comment, java.io.InputStream newVersion)
          add a new version of the file
 boolean delete(Identity identity, java.util.List<VFSRevision> revisionsToDelete)
          Delete the list of revisions given as parameter
 java.lang.String getComment()
           
 java.lang.String getCreator()
           
 java.lang.String getRevisionNr()
           
 java.util.List<VFSRevision> getRevisions()
           
 boolean isVersioned()
           
 boolean move(VFSContainer container)
          move the file
 boolean restore(Identity identity, VFSRevision revision, java.lang.String comment)
          restore the file to the revision given as parameter
 

Method Detail

isVersioned

boolean isVersioned()
Returns:
true if the file is versioned

getRevisionNr

java.lang.String getRevisionNr()
Returns:
the current version number

getCreator

java.lang.String getCreator()
Returns:
creator of the file

getComment

java.lang.String getComment()
Returns:
comment on the current version

getRevisions

java.util.List<VFSRevision> getRevisions()
Returns:
the list of revisions

addVersion

boolean addVersion(Identity identity,
                   java.lang.String comment,
                   java.io.InputStream newVersion)
add a new version of the file

Parameters:
identity -
comment -
newVersion -
Returns:

move

boolean move(VFSContainer container)
move the file

Parameters:
container -
Returns:

restore

boolean restore(Identity identity,
                VFSRevision revision,
                java.lang.String comment)
restore the file to the revision given as parameter

Parameters:
identity -
revision -
Returns:

delete

boolean delete(Identity identity,
               java.util.List<VFSRevision> revisionsToDelete)
Delete the list of revisions given as parameter

Parameters:
identity -
revisionsToDelete -
Returns: