Liferay 6.2-ce-ga5

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

All Superinterfaces:
AuditedModel, ClassedModel, GroupedModel, RepositoryModel<FileEntry>, Serializable, StagedGroupedModel, StagedModel
All Known Implementing Classes:
FileEntryProxyBean, FileEntryWrapper

public interface FileEntry
extends RepositoryModel<FileEntry>


Field Summary
static Accessor<FileEntry,Long> FILE_ENTRY_ID_ACCESSOR
           
 
Method Summary
 boolean containsPermission(PermissionChecker permissionChecker, String actionId)
           
 long getCompanyId()
           
 InputStream getContentStream()
          Retrieves the content stream of the current file version.
 InputStream getContentStream(String version)
           
 Date getCreateDate()
           
 String getDescription()
           
 String getExtension()
           
 long getFileEntryId()
           
 FileVersion getFileVersion()
          Retrieves the current file version.
 FileVersion getFileVersion(String version)
           
 List<FileVersion> getFileVersions(int status)
           
 Folder getFolder()
           
 long getFolderId()
           
 long getGroupId()
           
 String getIcon()
           
 FileVersion getLatestFileVersion()
          Retrieves the latest file version.
 Lock getLock()
           
 String getMimeType()
           
 String getMimeType(String version)
           
 Date getModifiedDate()
           
 int getReadCount()
           
 long getRepositoryId()
           
 long getSize()
           
 String getTitle()
           
 long getUserId()
           
 String getUserName()
           
 String getUserUuid()
           
 String getUuid()
           
 String getVersion()
           
 long getVersionUserId()
           
 String getVersionUserName()
           
 String getVersionUserUuid()
           
 boolean hasLock()
           
 boolean isCheckedOut()
           
 boolean isDefaultRepository()
           
 boolean isInTrash()
           
 boolean isInTrashContainer()
           
 boolean isManualCheckInRequired()
           
 boolean isSupportsLocking()
           
 boolean isSupportsMetadata()
           
 boolean isSupportsSocial()
           
 
Methods inherited from interface com.liferay.portal.kernel.repository.model.RepositoryModel
getAttributes, getModel, getPrimaryKey, isEscapedModel, toEscapedModel, toUnescapedModel
 
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
 
Methods inherited from interface com.liferay.portal.model.StagedModel
clone, getStagedModelType, setCompanyId, setCreateDate, setModifiedDate, setUuid
 

Field Detail

FILE_ENTRY_ID_ACCESSOR

static final Accessor<FileEntry,Long> FILE_ENTRY_ID_ACCESSOR
Method Detail

containsPermission

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

getCompanyId

long getCompanyId()
Specified by:
getCompanyId in interface AuditedModel
Specified by:
getCompanyId in interface StagedModel

getContentStream

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 - if a portal exception occurred
SystemException - if a system exception occurred
See Also:
getFileVersion()

getContentStream

InputStream getContentStream(String version)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

getCreateDate

Date getCreateDate()
Specified by:
getCreateDate in interface AuditedModel
Specified by:
getCreateDate in interface StagedModel

getDescription

String getDescription()

getExtension

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 - if a portal exception occurred
SystemException - if a system exception occurred

getFileVersion

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

getFileVersions

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

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 - if a portal exception occurred
SystemException - if a system exception occurred

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 StagedModel

getReadCount

int getReadCount()

getRepositoryId

long getRepositoryId()

getSize

long getSize()

getTitle

String getTitle()

getUserId

long getUserId()
Specified by:
getUserId in interface AuditedModel

getUserName

String getUserName()
Specified by:
getUserName in interface AuditedModel

getUserUuid

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

getUuid

String getUuid()
Specified by:
getUuid in interface StagedModel

getVersion

String getVersion()

getVersionUserId

long getVersionUserId()

getVersionUserName

String getVersionUserName()

getVersionUserUuid

String getVersionUserUuid()
                          throws SystemException
Throws:
SystemException

hasLock

boolean hasLock()

isCheckedOut

boolean isCheckedOut()

isDefaultRepository

boolean isDefaultRepository()

isInTrash

boolean isInTrash()

isInTrashContainer

boolean isInTrashContainer()

isManualCheckInRequired

boolean isManualCheckInRequired()

isSupportsLocking

boolean isSupportsLocking()

isSupportsMetadata

boolean isSupportsMetadata()

isSupportsSocial

boolean isSupportsSocial()

Liferay 6.2-ce-ga5