org.pentaho.platform.repository2.unified
Interface IRepositoryFileDao

All Known Implementing Classes:

JcrRepositoryFileDao

public interface IRepositoryFileDao

A data access object for reading and writing RepositoryFile instances. The methods in this interface might closely resemble those in IUnifiedRepository but this interface is not part of the public Pentaho API and can evolve independently.

Author:

mlowery

Method Summary

boolean	canUnlockFile(Serializable fileId)
RepositoryFile	createFile(Serializable parentFolderId, RepositoryFile file, IRepositoryFileData data, RepositoryFileAcl acl, String versionMessage)
RepositoryFile	createFolder(Serializable parentFolderId, RepositoryFile file, RepositoryFileAcl acl, String versionMessage)
void	deleteFile(Serializable fileId, String versionMessage)
void	deleteFileAtVersion(Serializable fileId, Serializable versionId)
List<RepositoryFile>	getChildren(Serializable folderId, String filter)
<T extends IRepositoryFileData> T	getData(Serializable fileId, Serializable versionId, Class<T> dataClass)
List<RepositoryFile>	getDeletedFiles()
List<RepositoryFile>	getDeletedFiles(Serializable folderId, String filter)
RepositoryFile	getFile(Serializable fileId, Serializable versionId)
RepositoryFile	getFile(String relPath)
RepositoryFile	getFile(String relPath, boolean loadLocaleMaps)
RepositoryFile	getFileByAbsolutePath(String absPath)
RepositoryFile	getFileById(Serializable fileId)
RepositoryFile	getFileById(Serializable fileId, boolean loadLocaleMaps)
RepositoryFileTree	getTree(String relPath, int depth, String filter)
List<VersionSummary>	getVersionSummaries(Serializable fileId)
VersionSummary	getVersionSummary(Serializable fileId, Serializable versionId)
void	lockFile(Serializable fileId, String message)
void	moveFile(Serializable fileId, String destRelPath, String versionMessage)
void	permanentlyDeleteFile(Serializable fileId, String versionMessage)
void	restoreFileAtVersion(Serializable fileId, Serializable versionId, String versionMessage)
void	undeleteFile(Serializable fileId, String versionMessage)
void	unlockFile(Serializable fileId)
RepositoryFile	updateFile(RepositoryFile file, IRepositoryFileData data, String versionMessage)

Method Detail

getFileByAbsolutePath

RepositoryFile getFileByAbsolutePath(String absPath)

getFile

RepositoryFile getFile(String relPath)

getTree

RepositoryFileTree getTree(String relPath,
                           int depth,
                           String filter)

getFile

RepositoryFile getFile(String relPath,
                       boolean loadLocaleMaps)

getFileById

RepositoryFile getFileById(Serializable fileId)

getFileById

RepositoryFile getFileById(Serializable fileId,
                           boolean loadLocaleMaps)

getData

<T extends IRepositoryFileData> T getData(Serializable fileId,
                                          Serializable versionId,
                                          Class<T> dataClass)

createFile

RepositoryFile createFile(Serializable parentFolderId,
                          RepositoryFile file,
                          IRepositoryFileData data,
                          RepositoryFileAcl acl,
                          String versionMessage)

createFolder

RepositoryFile createFolder(Serializable parentFolderId,
                            RepositoryFile file,
                            RepositoryFileAcl acl,
                            String versionMessage)

getChildren

List<RepositoryFile> getChildren(Serializable folderId,
                                 String filter)

updateFile

RepositoryFile updateFile(RepositoryFile file,
                          IRepositoryFileData data,
                          String versionMessage)

deleteFile

void deleteFile(Serializable fileId,
                String versionMessage)

deleteFileAtVersion

void deleteFileAtVersion(Serializable fileId,
                         Serializable versionId)

undeleteFile

void undeleteFile(Serializable fileId,
                  String versionMessage)

permanentlyDeleteFile

void permanentlyDeleteFile(Serializable fileId,
                           String versionMessage)

getDeletedFiles

List<RepositoryFile> getDeletedFiles(Serializable folderId,
                                     String filter)

getDeletedFiles

List<RepositoryFile> getDeletedFiles()

canUnlockFile

boolean canUnlockFile(Serializable fileId)

lockFile

void lockFile(Serializable fileId,
              String message)

unlockFile

void unlockFile(Serializable fileId)

getVersionSummaries

List<VersionSummary> getVersionSummaries(Serializable fileId)

getVersionSummary

VersionSummary getVersionSummary(Serializable fileId,
                                 Serializable versionId)

getFile

RepositoryFile getFile(Serializable fileId,
                       Serializable versionId)

moveFile

void moveFile(Serializable fileId,
              String destRelPath,
              String versionMessage)

restoreFileAtVersion

void restoreFileAtVersion(Serializable fileId,
                          Serializable versionId,
                          String versionMessage)