RepositoryFile (pentaho-platform-api 7.1.0.0-12 API)

java.lang.Object
- org.pentaho.platform.api.repository2.unified.RepositoryFile

All Implemented Interfaces:

Serializable, Comparable<RepositoryFile>
```
public class RepositoryFile
extends Object
implements Comparable<RepositoryFile>, Serializable
```
Immutable repository file. Use the RepositoryFile.Builder to create instances.

Author:

mlowery

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RepositoryFile.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`RepositoryFile.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_LOCALE`
`static String`	`DESCRIPTION`
`static String`	`FILE_DESCRIPTION`
`static String`	`FILE_TITLE`
`static boolean`	`HIDDEN_BY_DEFAULT`
`static String`	`HIDDEN_KEY`
`static String`	`ROOT_LOCALE`
`static boolean`	`SCHEDULABLE_BY_DEFAULT`
`static String`	`SCHEDULABLE_KEY`
`static String`	`SEPARATOR`
`static String`	`TITLE`

Constructor Summary

Constructors
Constructor and Description
`RepositoryFile(Serializable id, String name, boolean folder, Boolean hidden, Boolean schedulable, boolean versioned, Serializable versionId, String path, Date createdDate, Date lastModifiedDate, boolean locked, String lockOwner, String lockMessage, Date lockDate, String locale, String title, String description, String originalParentFolderPath, Date deletedDate, long fileSize, String creatorId, Map<String,Properties> localePropertiesMap)`
`RepositoryFile(Serializable id, String name, boolean folder, Boolean hidden, Boolean schedulable, boolean versioned, Serializable versionId, String path, Date createdDate, Date lastModifiedDate, boolean locked, String lockOwner, String lockMessage, Date lockDate, String locale, String title, String description, String originalParentFolderPath, Date deletedDate, long fileSize, String creatorId, Map<String,Properties> localePropertiesMap, boolean aclNode)`
`RepositoryFile(Serializable id, String name, boolean folder, Boolean hidden, boolean versioned, Serializable versionId, String path, Date createdDate, Date lastModifiedDate, boolean locked, String lockOwner, String lockMessage, Date lockDate, String locale, String title, String description, String originalParentFolderPath, Date deletedDate, long fileSize, String creatorId, Map<String,Properties> localePropertiesMap)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RepositoryFile`	`clone()`
`int`	`compareTo(RepositoryFile other)`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedDate()`
`String`	`getCreatorId()`
`Date`	`getDeletedDate()`
`String`	`getDescription()`
`Long`	`getFileSize()`
`Serializable`	`getId()`
`Date`	`getLastModifiedDate()`
`String`	`getLocale()`
`Map<String,Properties>`	`getLocalePropertiesMap()`
`Date`	`getLockDate()`
`String`	`getLockMessage()`
`String`	`getLockOwner()`
`String`	`getName()`
`String`	`getOriginalParentFolderPath()`
`String`	`getPath()`
`String`	`getTitle()` Returns title for current locale or file name if not available.
`Serializable`	`getVersionId()`
`int`	`hashCode()`
`boolean`	`isAclNode()`
`boolean`	`isFolder()`
`Boolean`	`isHidden()`
`boolean`	`isLocked()`
`Boolean`	`isSchedulable()`
`boolean`	`isVersioned()`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- SEPARATOR
```
public static final String SEPARATOR
```
  See Also:
  
  Constant Field Values
- DEFAULT_LOCALE
```
public static final String DEFAULT_LOCALE
```
  See Also:
  
  Constant Field Values
- ROOT_LOCALE
```
public static final String ROOT_LOCALE
```
  See Also:
  
  Constant Field Values
- TITLE
```
public static final String TITLE
```
  See Also:
  
  Constant Field Values
- FILE_TITLE
```
public static final String FILE_TITLE
```
  See Also:
  
  Constant Field Values
- DESCRIPTION
```
public static final String DESCRIPTION
```
  See Also:
  
  Constant Field Values
- FILE_DESCRIPTION
```
public static final String FILE_DESCRIPTION
```
  See Also:
  
  Constant Field Values
- HIDDEN_BY_DEFAULT
```
public static final boolean HIDDEN_BY_DEFAULT
```
  See Also:
  
  Constant Field Values
- SCHEDULABLE_BY_DEFAULT
```
public static final boolean SCHEDULABLE_BY_DEFAULT
```
  See Also:
  
  Constant Field Values
- HIDDEN_KEY
```
public static final String HIDDEN_KEY
```
  See Also:
  
  Constant Field Values
- SCHEDULABLE_KEY
```
public static final String SCHEDULABLE_KEY
```
  See Also:
  
  Constant Field Values

Constructor Detail

RepositoryFile

public RepositoryFile(Serializable id,
                      String name,
                      boolean folder,
                      Boolean hidden,
                      Boolean schedulable,
                      boolean versioned,
                      Serializable versionId,
                      String path,
                      Date createdDate,
                      Date lastModifiedDate,
                      boolean locked,
                      String lockOwner,
                      String lockMessage,
                      Date lockDate,
                      String locale,
                      String title,
                      String description,
                      String originalParentFolderPath,
                      Date deletedDate,
                      long fileSize,
                      String creatorId,
                      Map<String,Properties> localePropertiesMap,
                      boolean aclNode)

RepositoryFile

public RepositoryFile(Serializable id,
                      String name,
                      boolean folder,
                      Boolean hidden,
                      Boolean schedulable,
                      boolean versioned,
                      Serializable versionId,
                      String path,
                      Date createdDate,
                      Date lastModifiedDate,
                      boolean locked,
                      String lockOwner,
                      String lockMessage,
                      Date lockDate,
                      String locale,
                      String title,
                      String description,
                      String originalParentFolderPath,
                      Date deletedDate,
                      long fileSize,
                      String creatorId,
                      Map<String,Properties> localePropertiesMap)

RepositoryFile

@Deprecated
public RepositoryFile(Serializable id,
                                  String name,
                                  boolean folder,
                                  Boolean hidden,
                                  boolean versioned,
                                  Serializable versionId,
                                  String path,
                                  Date createdDate,
                                  Date lastModifiedDate,
                                  boolean locked,
                                  String lockOwner,
                                  String lockMessage,
                                  Date lockDate,
                                  String locale,
                                  String title,
                                  String description,
                                  String originalParentFolderPath,
                                  Date deletedDate,
                                  long fileSize,
                                  String creatorId,
                                  Map<String,Properties> localePropertiesMap)

Deprecated.

Method Detail

getName
```
public String getName()
```

getId
```
public Serializable getId()
```

getCreatedDate
```
public Date getCreatedDate()
```

getCreatorId
```
public String getCreatorId()
```

getLastModifiedDate
```
public Date getLastModifiedDate()
```

getFileSize
```
public Long getFileSize()
```

isFolder
```
public boolean isFolder()
```

getPath
```
public String getPath()
```

isHidden
```
public Boolean isHidden()
```

isSchedulable
```
public Boolean isSchedulable()
```

isVersioned
```
public boolean isVersioned()
```

getVersionId
```
public Serializable getVersionId()
```

isLocked
```
public boolean isLocked()
```

getLockOwner
```
public String getLockOwner()
```

getLockMessage
```
public String getLockMessage()
```

getLockDate
```
public Date getLockDate()
```

getTitle
```
public String getTitle()
```
Returns title for current locale or file name if not available.

getDescription
```
public String getDescription()
```

getLocalePropertiesMap

public Map<String,Properties> getLocalePropertiesMap()

getLocale
```
public String getLocale()
```

getOriginalParentFolderPath

public String getOriginalParentFolderPath()

getDeletedDate
```
public Date getDeletedDate()
```

isAclNode
```
public boolean isAclNode()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

compareTo
```
public int compareTo(RepositoryFile other)
```
Specified by:

compareTo in interface Comparable<RepositoryFile>

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

clone
```
public RepositoryFile clone()
```
Overrides:

clone in class Object

Class RepositoryFile

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SEPARATOR

DEFAULT_LOCALE

ROOT_LOCALE

TITLE

FILE_TITLE

DESCRIPTION

FILE_DESCRIPTION

HIDDEN_BY_DEFAULT

SCHEDULABLE_BY_DEFAULT

HIDDEN_KEY

SCHEDULABLE_KEY

Constructor Detail

RepositoryFile

RepositoryFile

RepositoryFile

Method Detail

getName

getId

getCreatedDate

getCreatorId

getLastModifiedDate

getFileSize

isFolder

getPath

isHidden

isSchedulable

isVersioned

getVersionId

isLocked

getLockOwner

getLockMessage

getLockDate

getTitle

getDescription

getLocalePropertiesMap

getLocale

getOriginalParentFolderPath

getDeletedDate

isAclNode

toString

compareTo

hashCode

equals

clone