com.liferay.portal.kernel.repository.model
Interface FileEntry

All Superinterfaces:
AuditedModel, ClassedModel, GroupedModel, RepositoryModel<FileEntry>, java.io.Serializable
All Known Implementing Classes:
FileEntryProxyBean

public interface FileEntry
extends RepositoryModel<FileEntry>

Author:
Alexander Chow

Field Summary
static Accessor<FileEntry,java.lang.Long> FILE_ENTRY_ID_ACCESSOR
           
 
Method Summary
 boolean containsPermission(PermissionChecker permissionChecker, java.lang.String actionId)
           
 long getCompanyId()
           
 java.io.InputStream getContentStream()
          Retrieves the content stream of the current file version.
 java.io.InputStream getContentStream(java.lang.String version)
           
 java.util.Date getCreateDate()
           
 java.lang.String getDescription()
           
 java.lang.String getExtension()
           
 long getFileEntryId()
           
 FileVersion getFileVersion()
          Retrieves the current file version.
 FileVersion getFileVersion(java.lang.String version)
           
 java.util.List<FileVersion> getFileVersions(int status)
           
 Folder getFolder()
           
 long getFolderId()
           
 long getGroupId()
           
 java.lang.String getIcon()
           
 FileVersion getLatestFileVersion()
          Retrieves the latest file version.
 Lock getLock()
           
 java.lang.String getMimeType()
           
 java.lang.String getMimeType(java.lang.String version)
           
 java.util.Date getModifiedDate()
           
 int getReadCount()
           
 long getRepositoryId()
           
 long getSize()
           
 java.lang.String getTitle()
           
 long getUserId()
           
 java.lang.String getUserName()
           
 java.lang.String getUserUuid()
           
 java.lang.String getUuid()
           
 java.lang.String getVersion()
           
 long getVersionUserId()
           
 java.lang.String getVersionUserName()
           
 java.lang.String getVersionUserUuid()
           
 boolean hasLock()
           
 boolean isCheckedOut()
           
 boolean isDefaultRepository()
           
 boolean isSupportsLocking()
           
 boolean isSupportsMetadata()
           
 boolean isSupportsSocial()
           
 
Methods inherited from interface com.liferay.portal.kernel.repository.model.RepositoryModel
getAttributes, getModel, getPrimaryKey, isEscapedModel, toEscapedModel
 
Methods inherited from interface com.liferay.portal.model.GroupedModel
setGroupId
 
Methods inherited from interface com.liferay.portal.model.AuditedModel
setCompanyId, setCreateDate, setModifiedDate, setUserId, setUserName, setUserUuid
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getExpandoBridge, getModelClass, getModelClassName, getPrimaryKeyObj, setPrimaryKeyObj
 

Field Detail

FILE_ENTRY_ID_ACCESSOR

static final Accessor<FileEntry,java.lang.Long> FILE_ENTRY_ID_ACCESSOR
Method Detail

containsPermission

boolean containsPermission(PermissionChecker permissionChecker,
                           java.lang.String actionId)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

getCompanyId

long getCompanyId()
Specified by:
getCompanyId in interface AuditedModel

getContentStream

java.io.InputStream getContentStream()
                                     throws PortalException,
                                            SystemException
Retrieves the content stream of the current file version. In a Liferay repository, this is the latest approved version. In third-party repositories, this may be the latest content regardless of workflow state.

Returns:
content stream of the current file version
Throws:
PortalException
SystemException
See Also:
getFileVersion()

getContentStream

java.io.InputStream getContentStream(java.lang.String version)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

getCreateDate

java.util.Date getCreateDate()
Specified by:
getCreateDate in interface AuditedModel

getDescription

java.lang.String getDescription()

getExtension

java.lang.String getExtension()

getFileEntryId

long getFileEntryId()

getFileVersion

FileVersion getFileVersion()
                           throws PortalException,
                                  SystemException
Retrieves the current file version. The workflow state of the latest file version may affect what is returned by this method. In a Liferay repository, this will return the latest approved version; the latest version regardless of workflow state can be retrieved by getLatestFileVersion(). In third-party repositories, these two methods may function identically.

Returns:
current file version
Throws:
PortalException
SystemException

getFileVersion

FileVersion getFileVersion(java.lang.String version)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

getFileVersions

java.util.List<FileVersion> getFileVersions(int status)
                                            throws SystemException
Throws:
SystemException

getFolder

Folder getFolder()

getFolderId

long getFolderId()

getGroupId

long getGroupId()
Specified by:
getGroupId in interface GroupedModel

getIcon

java.lang.String getIcon()

getLatestFileVersion

FileVersion getLatestFileVersion()
                                 throws PortalException,
                                        SystemException
Retrieves the latest file version. In a Liferay repository, this means the latest version regardless of workflow state. In third-party repositories, this may have an identical functionality with getFileVersion().

Returns:
latest file version
Throws:
PortalException
SystemException

getLock

Lock getLock()

getMimeType

java.lang.String getMimeType()

getMimeType

java.lang.String getMimeType(java.lang.String version)

getModifiedDate

java.util.Date getModifiedDate()
Specified by:
getModifiedDate in interface AuditedModel

getReadCount

int getReadCount()

getRepositoryId

long getRepositoryId()

getSize

long getSize()

getTitle

java.lang.String getTitle()

getUserId

long getUserId()
Specified by:
getUserId in interface AuditedModel

getUserName

java.lang.String getUserName()
Specified by:
getUserName in interface AuditedModel

getUserUuid

java.lang.String getUserUuid()
                             throws SystemException
Specified by:
getUserUuid in interface AuditedModel
Throws:
SystemException

getUuid

java.lang.String getUuid()

getVersion

java.lang.String getVersion()

getVersionUserId

long getVersionUserId()

getVersionUserName

java.lang.String getVersionUserName()

getVersionUserUuid

java.lang.String getVersionUserUuid()
                                    throws SystemException
Throws:
SystemException

hasLock

boolean hasLock()

isCheckedOut

boolean isCheckedOut()

isDefaultRepository

boolean isDefaultRepository()

isSupportsLocking

boolean isSupportsLocking()

isSupportsMetadata

boolean isSupportsMetadata()

isSupportsSocial

boolean isSupportsSocial()