IRepositoryFile (pentaho-platform-api 9.1.0.0-317 API)

All Superinterfaces:: ISearchable

public interface IRepositoryFile
extends ISearchable

Field Summary

Fields
Modifier and Type Field and Description

static char SEPARATOR
- Fields inherited from interface org.pentaho.platform.api.repository.ISearchable
  SEARCH_TYPE_PHRASE, SEARCH_TYPE_WORDS_AND, SEARCH_TYPE_WORDS_OR

Fields
Modifier and Type	Field and Description
`static char`	`SEPARATOR`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addChildFile(IRepositoryFile file)`
`int`	`compareTo(Object o)`
`boolean`	`containsActions()`
`boolean`	`exists()`
`Set`	`getChildrenFiles()`
`byte[]`	`getData()`
`String`	`getExtension()`
`String`	`getFileId()`
`String`	`getFileName()`
`String`	`getFullPath()`
`long`	`getLastModified()`
`IRepositoryFile`	`getParent()`
`String`	`getPhraseSearchQueryName()`
`int`	`getRevision()`
`String[]`	`getSearchableColumns()`
`String`	`getSearchableTable()`
`String`	`getSolution()`
`String`	`getSolutionPath()`
`boolean`	`hasExtension()`
`boolean`	`isDirectory()`
`boolean`	`isRoot()`
`ISolutionFile[]`	`listFiles()`
`ISolutionFile[]`	`listFiles(IFileFilter filter)`
`IRepositoryFile[]`	`listRepositoryFiles()`
`void`	`removeChildFile(IRepositoryFile file)`
`void`	`resetAccessControls(List acls)`
`ISolutionFile`	`retrieveParent()`
`void`	`setAccessControls(List acls)` This method's purpose is to allow Hibernate to initialize the ACLs from the data-store.
`void`	`setChildrenFiles(Set childrenFiles)`
`void`	`setData(byte[] data)`
`void`	`setLastModified(long modDate)`
`void`	`setParent(IRepositoryFile parent)`

- Field Detail
  - SEPARATOR
```
static final char SEPARATOR
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setAccessControls
```
void setAccessControls(List acls)
```
    This method's purpose is to allow Hibernate to initialize the ACLs from the data-store. Application clients should likely use resetAccessControls.
  - resetAccessControls
```
void resetAccessControls(List acls)
```
  - getRevision
```
int getRevision()
```
  - getFileId
```
String getFileId()
```
  - getSolution
```
String getSolution()
```
  - getSolutionPath
```
String getSolutionPath()
```
  - getFileName
```
String getFileName()
```
  - getFullPath
```
String getFullPath()
```
  - setParent
```
void setParent(IRepositoryFile parent)
```
  - getParent
```
IRepositoryFile getParent()
```
  - retrieveParent
```
ISolutionFile retrieveParent()
```
  - getSearchableColumns
```
String[] getSearchableColumns()
```
    Specified by:
    
    getSearchableColumns in interface ISearchable
    
    Returns:
    
    Returns an array of the char/varchar columns that can be searched.
  - getSearchableTable
```
String getSearchableTable()
```
    Specified by:
    
    getSearchableTable in interface ISearchable
    
    Returns:
    
    Returns the name of the hibernated object which will be used in the search.
  - getPhraseSearchQueryName
```
String getPhraseSearchQueryName()
```
    Specified by:
    
    getPhraseSearchQueryName in interface ISearchable
    
    Returns:
    
    Returns the fully-package-qualified name of a named query in the Hibernate Schema that supports a full-text search of all searchable columns. The parameter name for the search term in the query must be :searchTerm or the query will fail.
  - isDirectory
```
boolean isDirectory()
```
  - getChildrenFiles
```
Set getChildrenFiles()
```
    Returns:
    
    Returns the childrenResources.
  - setChildrenFiles
```
void setChildrenFiles(Set childrenFiles)
```
    Parameters:
    
    childrenResources - The childrenResources to set.
  - addChildFile
```
void addChildFile(IRepositoryFile file)
```
  - removeChildFile
```
void removeChildFile(IRepositoryFile file)
```
  - getData
```
byte[] getData()
```
    Returns:
    
    Returns the data.
  - setData
```
void setData(byte[] data)
```
    Parameters:
    
    data - The data to set.
  - listFiles
```
ISolutionFile[] listFiles(IFileFilter filter)
```
  - listFiles
```
ISolutionFile[] listFiles()
```
  - listRepositoryFiles
```
IRepositoryFile[] listRepositoryFiles()
```
  - compareTo
```
int compareTo(Object o)
```
  - getLastModified
```
long getLastModified()
```
    Returns:
    
    Returns the modDate.
  - setLastModified
```
void setLastModified(long modDate)
```
    Parameters:
    
    modDate - The modDate to set.
  - containsActions
```
boolean containsActions()
```
  - isRoot
```
boolean isRoot()
```
  - hasExtension
```
boolean hasExtension()
```
    Returns:
    
    a boolean indicating if this file has an extension
  - getExtension
```
String getExtension()
```
    Returns:
    
    the extension (including the . seperator) of this file
  - exists
```
boolean exists()
```

Interface IRepositoryFile

Field Summary

Fields inherited from interface org.pentaho.platform.api.repository.ISearchable

Method Summary

Field Detail

SEPARATOR

Method Detail

setAccessControls

resetAccessControls

getRevision

getFileId

getSolution

getSolutionPath

getFileName

getFullPath

setParent

getParent

retrieveParent

getSearchableColumns

getSearchableTable

getPhraseSearchQueryName

isDirectory

getChildrenFiles

setChildrenFiles

addChildFile

removeChildFile

getData

setData

listFiles

listFiles

listRepositoryFiles

compareTo

getLastModified

setLastModified

containsActions

isRoot

hasExtension

getExtension

exists