Interface IRepositoryFileDao
-
- All Known Implementing Classes:
FileSystemRepositoryFileDao
,JcrRepositoryFileDao
public interface IRepositoryFileDao
A data access object for reading and writingRepositoryFile
instances. The methods in this interface might closely resemble those inIUnifiedRepository
but this interface is not part of the public Pentaho API and can evolve independently.- Author:
- mlowery
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description boolean
canUnlockFile(Serializable fileId)
void
copyFile(Serializable fileId, String destAbsPath, String versionMessage)
org.pentaho.platform.api.repository2.unified.RepositoryFile
createFile(Serializable parentFolderId, org.pentaho.platform.api.repository2.unified.RepositoryFile file, org.pentaho.platform.api.repository2.unified.IRepositoryFileData data, org.pentaho.platform.api.repository2.unified.RepositoryFileAcl acl, String versionMessage)
org.pentaho.platform.api.repository2.unified.RepositoryFile
createFolder(Serializable parentFolderId, org.pentaho.platform.api.repository2.unified.RepositoryFile file, org.pentaho.platform.api.repository2.unified.RepositoryFileAcl acl, String versionMessage)
void
deleteFile(Serializable fileId, String versionMessage)
void
deleteFileAtVersion(Serializable fileId, Serializable versionId)
void
deleteLocalePropertiesForFile(org.pentaho.platform.api.repository2.unified.RepositoryFile repositoryFile, String locale)
default List<org.pentaho.platform.api.repository2.unified.RepositoryFile>
getAllDeletedFiles()
List<Locale>
getAvailableLocalesForFile(org.pentaho.platform.api.repository2.unified.RepositoryFile repositoryFile)
List<Locale>
getAvailableLocalesForFileById(Serializable fileId)
List<Locale>
getAvailableLocalesForFileByPath(String relPath)
List<org.pentaho.platform.api.repository2.unified.RepositoryFile>
getChildren(Serializable folderId, String filter, Boolean showHiddenFiles)
Deprecated.List<org.pentaho.platform.api.repository2.unified.RepositoryFile>
getChildren(org.pentaho.platform.api.repository2.unified.RepositoryRequest repositoryRequest)
<T extends org.pentaho.platform.api.repository2.unified.IRepositoryFileData>
TgetData(Serializable fileId, Serializable versionId, Class<T> dataClass)
List<org.pentaho.platform.api.repository2.unified.RepositoryFile>
getDeletedFiles()
List<org.pentaho.platform.api.repository2.unified.RepositoryFile>
getDeletedFiles(String origParentFolderPath, String filter)
org.pentaho.platform.api.repository2.unified.RepositoryFile
getFile(Serializable fileId, Serializable versionId)
org.pentaho.platform.api.repository2.unified.RepositoryFile
getFile(String relPath)
org.pentaho.platform.api.repository2.unified.RepositoryFile
getFile(String relPath, boolean loadLocaleMaps)
org.pentaho.platform.api.repository2.unified.RepositoryFile
getFile(String relPath, boolean loadLocaleMaps, org.pentaho.platform.api.locale.IPentahoLocale locale)
org.pentaho.platform.api.repository2.unified.RepositoryFile
getFile(String relPath, org.pentaho.platform.api.locale.IPentahoLocale locale)
org.pentaho.platform.api.repository2.unified.RepositoryFile
getFileByAbsolutePath(String absPath)
org.pentaho.platform.api.repository2.unified.RepositoryFile
getFileById(Serializable fileId)
org.pentaho.platform.api.repository2.unified.RepositoryFile
getFileById(Serializable fileId, boolean loadLocaleMaps)
org.pentaho.platform.api.repository2.unified.RepositoryFile
getFileById(Serializable fileId, boolean loadLocaleMaps, org.pentaho.platform.api.locale.IPentahoLocale locale)
org.pentaho.platform.api.repository2.unified.RepositoryFile
getFileById(Serializable fileId, org.pentaho.platform.api.locale.IPentahoLocale locale)
Map<String,Serializable>
getFileMetadata(Serializable fileId)
Properties
getLocalePropertiesForFile(org.pentaho.platform.api.repository2.unified.RepositoryFile repositoryFile, String locale)
Properties
getLocalePropertiesForFileById(Serializable fileId, String locale)
Properties
getLocalePropertiesForFileByPath(String relPath, String locale)
List<org.pentaho.platform.api.repository2.unified.RepositoryFile>
getReferrers(Serializable fileId)
List<Character>
getReservedChars()
org.pentaho.platform.api.repository2.unified.RepositoryFileTree
getTree(String relPath, int depth, String filter, boolean showHidden)
Deprecated.org.pentaho.platform.api.repository2.unified.RepositoryFileTree
getTree(org.pentaho.platform.api.repository2.unified.RepositoryRequest repositoryRequest)
List<org.pentaho.platform.api.repository2.unified.VersionSummary>
getVersionSummaries(Serializable fileId)
org.pentaho.platform.api.repository2.unified.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
setFileMetadata(Serializable fileId, Map<String,Serializable> metadataMap)
void
setLocalePropertiesForFile(org.pentaho.platform.api.repository2.unified.RepositoryFile repositoryFile, String locale, Properties properties)
void
setLocalePropertiesForFileById(Serializable fileId, String locale, Properties properties)
void
setLocalePropertiesForFileByPath(String relPath, String locale, Properties properties)
void
undeleteFile(Serializable fileId, String versionMessage)
void
unlockFile(Serializable fileId)
org.pentaho.platform.api.repository2.unified.RepositoryFile
updateFile(org.pentaho.platform.api.repository2.unified.RepositoryFile file, org.pentaho.platform.api.repository2.unified.IRepositoryFileData data, String versionMessage)
org.pentaho.platform.api.repository2.unified.RepositoryFile
updateFolder(org.pentaho.platform.api.repository2.unified.RepositoryFile file, String versionMessage)
-
-
-
Method Detail
-
getFileByAbsolutePath
org.pentaho.platform.api.repository2.unified.RepositoryFile getFileByAbsolutePath(String absPath)
-
getFile
org.pentaho.platform.api.repository2.unified.RepositoryFile getFile(String relPath)
-
getTree
@Deprecated org.pentaho.platform.api.repository2.unified.RepositoryFileTree getTree(String relPath, int depth, String filter, boolean showHidden)
Deprecated.
-
getTree
org.pentaho.platform.api.repository2.unified.RepositoryFileTree getTree(org.pentaho.platform.api.repository2.unified.RepositoryRequest repositoryRequest)
-
getFile
org.pentaho.platform.api.repository2.unified.RepositoryFile getFile(String relPath, boolean loadLocaleMaps)
-
getFileById
org.pentaho.platform.api.repository2.unified.RepositoryFile getFileById(Serializable fileId)
-
getFileById
org.pentaho.platform.api.repository2.unified.RepositoryFile getFileById(Serializable fileId, boolean loadLocaleMaps)
-
getFile
org.pentaho.platform.api.repository2.unified.RepositoryFile getFile(String relPath, org.pentaho.platform.api.locale.IPentahoLocale locale)
-
getFileById
org.pentaho.platform.api.repository2.unified.RepositoryFile getFileById(Serializable fileId, org.pentaho.platform.api.locale.IPentahoLocale locale)
-
getFile
org.pentaho.platform.api.repository2.unified.RepositoryFile getFile(String relPath, boolean loadLocaleMaps, org.pentaho.platform.api.locale.IPentahoLocale locale)
-
getFileById
org.pentaho.platform.api.repository2.unified.RepositoryFile getFileById(Serializable fileId, boolean loadLocaleMaps, org.pentaho.platform.api.locale.IPentahoLocale locale)
-
getData
<T extends org.pentaho.platform.api.repository2.unified.IRepositoryFileData> T getData(Serializable fileId, Serializable versionId, Class<T> dataClass)
-
createFile
org.pentaho.platform.api.repository2.unified.RepositoryFile createFile(Serializable parentFolderId, org.pentaho.platform.api.repository2.unified.RepositoryFile file, org.pentaho.platform.api.repository2.unified.IRepositoryFileData data, org.pentaho.platform.api.repository2.unified.RepositoryFileAcl acl, String versionMessage)
-
createFolder
org.pentaho.platform.api.repository2.unified.RepositoryFile createFolder(Serializable parentFolderId, org.pentaho.platform.api.repository2.unified.RepositoryFile file, org.pentaho.platform.api.repository2.unified.RepositoryFileAcl acl, String versionMessage)
-
updateFolder
org.pentaho.platform.api.repository2.unified.RepositoryFile updateFolder(org.pentaho.platform.api.repository2.unified.RepositoryFile file, String versionMessage)
-
getChildren
@Deprecated List<org.pentaho.platform.api.repository2.unified.RepositoryFile> getChildren(Serializable folderId, String filter, Boolean showHiddenFiles)
Deprecated.
-
getChildren
List<org.pentaho.platform.api.repository2.unified.RepositoryFile> getChildren(org.pentaho.platform.api.repository2.unified.RepositoryRequest repositoryRequest)
-
updateFile
org.pentaho.platform.api.repository2.unified.RepositoryFile updateFile(org.pentaho.platform.api.repository2.unified.RepositoryFile file, org.pentaho.platform.api.repository2.unified.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<org.pentaho.platform.api.repository2.unified.RepositoryFile> getDeletedFiles(String origParentFolderPath, String filter)
-
getDeletedFiles
List<org.pentaho.platform.api.repository2.unified.RepositoryFile> getDeletedFiles()
-
getAllDeletedFiles
default List<org.pentaho.platform.api.repository2.unified.RepositoryFile> getAllDeletedFiles()
-
canUnlockFile
boolean canUnlockFile(Serializable fileId)
-
lockFile
void lockFile(Serializable fileId, String message)
-
unlockFile
void unlockFile(Serializable fileId)
-
getVersionSummaries
List<org.pentaho.platform.api.repository2.unified.VersionSummary> getVersionSummaries(Serializable fileId)
-
getVersionSummary
org.pentaho.platform.api.repository2.unified.VersionSummary getVersionSummary(Serializable fileId, Serializable versionId)
-
getFile
org.pentaho.platform.api.repository2.unified.RepositoryFile getFile(Serializable fileId, Serializable versionId)
-
moveFile
void moveFile(Serializable fileId, String destRelPath, String versionMessage)
-
copyFile
void copyFile(Serializable fileId, String destAbsPath, String versionMessage)
-
restoreFileAtVersion
void restoreFileAtVersion(Serializable fileId, Serializable versionId, String versionMessage)
-
getReferrers
List<org.pentaho.platform.api.repository2.unified.RepositoryFile> getReferrers(Serializable fileId)
-
setFileMetadata
void setFileMetadata(Serializable fileId, Map<String,Serializable> metadataMap)
-
getFileMetadata
Map<String,Serializable> getFileMetadata(Serializable fileId)
-
getAvailableLocalesForFileById
List<Locale> getAvailableLocalesForFileById(Serializable fileId)
-
getAvailableLocalesForFile
List<Locale> getAvailableLocalesForFile(org.pentaho.platform.api.repository2.unified.RepositoryFile repositoryFile)
-
getLocalePropertiesForFileById
Properties getLocalePropertiesForFileById(Serializable fileId, String locale)
-
getLocalePropertiesForFileByPath
Properties getLocalePropertiesForFileByPath(String relPath, String locale)
-
getLocalePropertiesForFile
Properties getLocalePropertiesForFile(org.pentaho.platform.api.repository2.unified.RepositoryFile repositoryFile, String locale)
-
setLocalePropertiesForFileById
void setLocalePropertiesForFileById(Serializable fileId, String locale, Properties properties)
-
setLocalePropertiesForFileByPath
void setLocalePropertiesForFileByPath(String relPath, String locale, Properties properties)
-
setLocalePropertiesForFile
void setLocalePropertiesForFile(org.pentaho.platform.api.repository2.unified.RepositoryFile repositoryFile, String locale, Properties properties)
-
deleteLocalePropertiesForFile
void deleteLocalePropertiesForFile(org.pentaho.platform.api.repository2.unified.RepositoryFile repositoryFile, String locale)
-
-