Package com.liferay.portal.kernel.repository.model

Interface FileEntry

All Superinterfaces:

AuditedModel, ClassedModel, ExternalReferenceCodeModel, GroupedModel, RepositoryEntry, RepositoryModel<FileEntry>, Serializable, StagedGroupedModel, StagedModel

All Known Implementing Classes:

FileEntryProxyBean, FileEntryWrapper

@JSON
@ProviderType
public interface FileEntry
extends ExternalReferenceCodeModel, RepositoryEntry, RepositoryModel<FileEntry>

Author:

Alexander Chow

Field Summary

Fields

Modifier and Type	Field	Description
static final Accessor<FileEntry,Long>	FILE_ENTRY_ID_ACCESSOR

Method Summary

Modifier and Type	Method	Description
boolean	containsPermission(PermissionChecker permissionChecker, String actionId)
long	getCompanyId()
InputStream	getContentStream()	Returns the content stream of the current file version.
InputStream	getContentStream(String version)
Date	getCreateDate()
default long	getCtCollectionId()
String	getDescription()
Date	getDisplayDate()
Date	getExpirationDate()
String	getExtension()
default String	getExternalReferenceCode()
long	getFileEntryId()
String	getFileName()
List<FileShortcut>	getFileShortcuts()
FileVersion	getFileVersion()	Returns the current file version.
FileVersion	getFileVersion(String version)
List<FileVersion>	getFileVersions(int status)
List<FileVersion>	getFileVersions(int status, int start, int end)
int	getFileVersionsCount(int status)
Folder	getFolder()
long	getFolderId()
long	getGroupId()
String	getIcon()
String	getIconCssClass()
FileVersion	getLatestFileVersion()	Returns the latest file version.
FileVersion	getLatestFileVersion(boolean trusted)	Returns the latest file version, optionally bypassing security checks.
Lock	getLock()
String	getMimeType()
String	getMimeType(String version)
Date	getModifiedDate()
long	getReadCount()
<T extends Capability> T	getRepositoryCapability(Class<T> capabilityClass)
long	getRepositoryId()
Date	getReviewDate()
long	getSize()
String	getTitle()
long	getUserId()
String	getUserName()
String	getUserUuid()
String	getUuid()
String	getVersion()
boolean	hasLock()
boolean	isCheckedOut()
boolean	isDefaultRepository()
boolean	isInTrash()
boolean	isInTrashContainer()
boolean	isManualCheckInRequired()
<T extends Capability> boolean	isRepositoryCapabilityProvided(Class<T> capabilityClass)
boolean	isSupportsLocking()
boolean	isSupportsMetadata()
boolean	isSupportsSocial()

Methods inherited from interface com.liferay.portal.kernel.model.AuditedModel

setCompanyId, setCreateDate, setModifiedDate, setUserId, setUserName, setUserUuid

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getExpandoBridge, getModelClass, getModelClassName, getPrimaryKeyObj, setPrimaryKeyObj

Methods inherited from interface com.liferay.portal.kernel.model.ExternalReferenceCodeModel

setExternalReferenceCode

Methods inherited from interface com.liferay.portal.kernel.model.GroupedModel

setGroupId

Methods inherited from interface com.liferay.portal.kernel.repository.model.RepositoryModel

execute, getAttributes, getModel, getPrimaryKey, isEscapedModel, toEscapedModel, toUnescapedModel

Methods inherited from interface com.liferay.portal.kernel.model.StagedGroupedModel

getLastPublishDate, setLastPublishDate

Methods inherited from interface com.liferay.portal.kernel.model.StagedModel

clone, getStagedModelType, setCompanyId, setCreateDate, setModifiedDate, setUuid

Field Details

FILE_ENTRY_ID_ACCESSOR

static final Accessor<FileEntry,Long> FILE_ENTRY_ID_ACCESSOR

Method Details

containsPermission

boolean containsPermission(PermissionChecker permissionChecker,
 String actionId)
                    throws PortalException

Throws:

PortalException

getCompanyId

long getCompanyId()

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface RepositoryEntry

Specified by:

getCompanyId in interface StagedModel

getContentStream

@JSON(include=false)
InputStream getContentStream()
                      throws PortalException

Returns the content stream of the current file version. In a Liferay repository, this is the latest approved version. In third-party repositories, the latest content stream may be returned, regardless of workflow state.

Returns:

the content stream of the current file version

Throws:

PortalException

See Also:

• getFileVersion()

getContentStream

InputStream getContentStream(String version)
                      throws PortalException

Throws:

PortalException

getCreateDate

Date getCreateDate()

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface RepositoryEntry

Specified by:

getCreateDate in interface StagedModel

getCtCollectionId

default long getCtCollectionId()

getDescription

String getDescription()

getDisplayDate

Date getDisplayDate()

getExpirationDate

Date getExpirationDate()

getExtension

String getExtension()

getExternalReferenceCode

default String getExternalReferenceCode()

Specified by:

getExternalReferenceCode in interface ExternalReferenceCodeModel

getFileEntryId

long getFileEntryId()

getFileName

String getFileName()

getFileShortcuts

List<FileShortcut> getFileShortcuts()

getFileVersion

FileVersion getFileVersion()
                    throws PortalException

Returns the current file version. The workflow state of the latest file version may affect the file version that is returned. In a Liferay repository, the latest approved version is returned; the latest version regardless of workflow state can be retrieved by getLatestFileVersion(). In third-party repositories, these two methods may function identically.

Returns:

the current file version

Throws:

PortalException

getFileVersion

FileVersion getFileVersion(String version)
                    throws PortalException

Throws:

PortalException

getFileVersions

List<FileVersion> getFileVersions(int status)

getFileVersions

List<FileVersion> getFileVersions(int status,
 int start,
 int end)

getFileVersionsCount

int getFileVersionsCount(int status)

getFolder

Folder getFolder()

getFolderId

long getFolderId()

getGroupId

long getGroupId()

Specified by:

getGroupId in interface GroupedModel

Specified by:

getGroupId in interface RepositoryEntry

getIcon

String getIcon()

getIconCssClass

String getIconCssClass()

getLatestFileVersion

FileVersion getLatestFileVersion()
                          throws PortalException

Returns the latest file version. In a Liferay repository, the latest version is returned, regardless of workflow state. In third-party repositories, the functionality of this method and getFileVersion() may be identical.

Returns:

the latest file version

Throws:

PortalException

getLatestFileVersion

FileVersion getLatestFileVersion(boolean trusted)
                          throws PortalException

Returns the latest file version, optionally bypassing security checks. In a Liferay repository, the latest version is returned, regardless of workflow state. In third-party repositories, the functionality of this method and getFileVersion() may be identical.

Parameters:

trusted - whether to bypass permission checks. In third-party repositories, this parameter may be ignored.

Returns:

the latest file version

Throws:

PortalException

getLock

Lock getLock()

getMimeType

String getMimeType()

getMimeType

String getMimeType(String version)

getModifiedDate

Date getModifiedDate()

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface RepositoryEntry

Specified by:

getModifiedDate in interface StagedModel

getReadCount

long getReadCount()

getRepositoryCapability

<T extends Capability> T getRepositoryCapability(Class<T> capabilityClass)

getRepositoryId

long getRepositoryId()

getReviewDate

Date getReviewDate()

getSize

long getSize()

getTitle

String getTitle()

getUserId

long getUserId()

Specified by:

getUserId in interface AuditedModel

Specified by:

getUserId in interface RepositoryEntry

getUserName

String getUserName()

Specified by:

getUserName in interface AuditedModel

Specified by:

getUserName in interface RepositoryEntry

getUserUuid

String getUserUuid()

Specified by:

getUserUuid in interface AuditedModel

Specified by:

getUserUuid in interface RepositoryEntry

getUuid

String getUuid()

Specified by:

getUuid in interface StagedModel

getVersion

String getVersion()

hasLock

boolean hasLock()

isCheckedOut

boolean isCheckedOut()

isDefaultRepository

boolean isDefaultRepository()

isInTrash

boolean isInTrash()

isInTrashContainer

boolean isInTrashContainer()

isManualCheckInRequired

boolean isManualCheckInRequired()

isRepositoryCapabilityProvided

<T extends Capability> boolean isRepositoryCapabilityProvided(Class<T> capabilityClass)

isSupportsLocking

boolean isSupportsLocking()

isSupportsMetadata

boolean isSupportsMetadata()

isSupportsSocial

boolean isSupportsSocial()