com.liferay.document.library.repository.external.model

Class ExtRepositoryFileEntryAdapter

java.lang.Object

com.liferay.document.library.repository.external.model.ExtRepositoryModelAdapter<T>

com.liferay.document.library.repository.external.model.ExtRepositoryObjectAdapter<FileEntry>

com.liferay.document.library.repository.external.model.ExtRepositoryFileEntryAdapter

All Implemented Interfaces:

AuditedModel, ClassedModel, GroupedModel, StagedGroupedModel, StagedModel, FileEntry, RepositoryEntry, RepositoryModel<FileEntry>, java.io.Serializable, java.lang.Cloneable

public class ExtRepositoryFileEntryAdapter
extends ExtRepositoryObjectAdapter<FileEntry>
implements FileEntry

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.liferay.portal.kernel.repository.model.FileEntry

FILE_ENTRY_ID_ACCESSOR

Constructor Summary

Constructors

Constructor and Description
ExtRepositoryFileEntryAdapter(ExtRepositoryAdapter extRepositoryAdapter, long extRepositoryObjectId, java.lang.String uuid, ExtRepositoryFileEntry extRepositoryFileEntry)

Method Summary

Modifier and Type	Method and Description
void	execute(RepositoryModelOperation repositoryModelOperation)
java.io.InputStream	getContentStream() Returns the content stream of the current file version.
java.io.InputStream	getContentStream(java.lang.String version)
ExtRepositoryFileEntry	getExtRepositoryModel()
long	getFileEntryId()
java.lang.String	getFileName()
java.util.List<FileShortcut>	getFileShortcuts()
FileVersion	getFileVersion() Returns the current file version.
FileVersion	getFileVersion(java.lang.String version)
java.util.List<FileVersion>	getFileVersions(int status)
int	getFileVersionsCount(int status)
Folder	getFolder()
long	getFolderId()
java.lang.String	getIcon()
java.lang.String	getIconCssClass()
FileVersion	getLatestFileVersion() Returns the latest file version.
FileVersion	getLatestFileVersion(boolean trusted) Returns the latest file version, optionally bypassing security checks.
Lock	getLock()
java.lang.String	getMimeType()
java.lang.String	getMimeType(java.lang.String version)
java.lang.Class<?>	getModelClass()
java.lang.String	getName()
long	getReadCount()
<T extends Capability> T	getRepositoryCapability(java.lang.Class<T> capabilityClass)
StagedModelType	getStagedModelType()
java.lang.String	getTitle()
java.lang.String	getVersion()
boolean	hasLock()
boolean	isCheckedOut()
boolean	isManualCheckInRequired()
<T extends Capability> boolean	isRepositoryCapabilityProvided(java.lang.Class<T> capabilityClass)
boolean	isSupportsLocking()

Methods inherited from class com.liferay.document.library.repository.external.model.ExtRepositoryObjectAdapter

containsPermission, getAncestorFolderIds, getAncestors, getExtension, getModifiedDate, getParentFolder, isInTrash, isInTrashContainer, isSupportsMetadata, isSupportsSocial

Methods inherited from class com.liferay.document.library.repository.external.model.ExtRepositoryModelAdapter

clone, getAttributes, getCompanyId, getCreateDate, getDescription, getExpandoBridge, getGroupId, getLastPublishDate, getModel, getModelClassName, getPrimaryKey, getPrimaryKeyObj, getRepository, getRepositoryId, getSize, getUser, getUserId, getUserName, getUserUuid, getUuid, isDefaultRepository, isEscapedModel, setCompanyId, setCreateDate, setGroupId, setLastPublishDate, setModifiedDate, setPrimaryKeyObj, setUserId, setUserName, setUserUuid, setUuid, toEscapedModel, toUnescapedModel

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

containsPermission, getCompanyId, getCreateDate, getDescription, getExtension, getGroupId, getModifiedDate, getRepositoryId, getSize, getUserId, getUserName, getUserUuid, getUuid, isDefaultRepository, isInTrash, isInTrashContainer, isSupportsMetadata, 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.kernel.model.StagedGroupedModel

getLastPublishDate, setLastPublishDate

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

setGroupId

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, getModelClassName, getPrimaryKeyObj, setPrimaryKeyObj

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

clone, setCompanyId, setCreateDate, setModifiedDate, setUuid

Constructor Detail

ExtRepositoryFileEntryAdapter

public ExtRepositoryFileEntryAdapter(ExtRepositoryAdapter extRepositoryAdapter,
                                     long extRepositoryObjectId,
                                     java.lang.String uuid,
                                     ExtRepositoryFileEntry extRepositoryFileEntry)

Method Detail

execute

public void execute(RepositoryModelOperation repositoryModelOperation)
             throws PortalException

Specified by:

execute in interface RepositoryModel<FileEntry>

Throws:

PortalException

getContentStream

public java.io.InputStream getContentStream()
                                     throws PortalException

Description copied from interface: FileEntry

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.

Specified by:

getContentStream in interface FileEntry

Returns:

the content stream of the current file version

Throws:

PortalException

See Also:

FileEntry.getFileVersion()

getContentStream

public java.io.InputStream getContentStream(java.lang.String version)
                                     throws PortalException

Specified by:

getContentStream in interface FileEntry

Throws:

PortalException

getExtRepositoryModel

public ExtRepositoryFileEntry getExtRepositoryModel()

Overrides:

getExtRepositoryModel in class ExtRepositoryObjectAdapter<FileEntry>

getFileEntryId

public long getFileEntryId()

Specified by:

getFileEntryId in interface FileEntry

getFileName

public java.lang.String getFileName()

Specified by:

getFileName in interface FileEntry

getFileShortcuts

public java.util.List<FileShortcut> getFileShortcuts()

Specified by:

getFileShortcuts in interface FileEntry

getFileVersion

public FileVersion getFileVersion()

Description copied from interface: FileEntry

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 FileEntry.getLatestFileVersion(). In third-party repositories, these two methods may function identically.

Specified by:

getFileVersion in interface FileEntry

Returns:

the current file version

getFileVersion

public FileVersion getFileVersion(java.lang.String version)
                           throws PortalException

Specified by:

getFileVersion in interface FileEntry

Throws:

PortalException

getFileVersions

public java.util.List<FileVersion> getFileVersions(int status)

Specified by:

getFileVersions in interface FileEntry

getFileVersionsCount

public int getFileVersionsCount(int status)

Specified by:

getFileVersionsCount in interface FileEntry

getFolder

public Folder getFolder()

Specified by:

getFolder in interface FileEntry

getFolderId

public long getFolderId()

Specified by:

getFolderId in interface FileEntry

getIcon

public java.lang.String getIcon()

Specified by:

getIcon in interface FileEntry

getIconCssClass

public java.lang.String getIconCssClass()

Specified by:

getIconCssClass in interface FileEntry

getLatestFileVersion

public FileVersion getLatestFileVersion()
                                 throws PortalException

Description copied from interface: FileEntry

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 FileEntry.getFileVersion() may be identical.

Specified by:

getLatestFileVersion in interface FileEntry

Returns:

the latest file version

Throws:

PortalException

getLatestFileVersion

public FileVersion getLatestFileVersion(boolean trusted)
                                 throws PortalException

Description copied from interface: FileEntry

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 FileEntry.getFileVersion() may be identical.

Specified by:

getLatestFileVersion in interface FileEntry

Parameters:

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

Returns:

the latest file version

Throws:

PortalException

getLock

public Lock getLock()

Specified by:

getLock in interface FileEntry

getMimeType

public java.lang.String getMimeType()

Specified by:

getMimeType in interface FileEntry

getMimeType

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

Specified by:

getMimeType in interface FileEntry

getModelClass

public java.lang.Class<?> getModelClass()

Specified by:

getModelClass in interface ClassedModel

getName

public java.lang.String getName()

Specified by:

getName in class ExtRepositoryObjectAdapter<FileEntry>

getReadCount

public long getReadCount()

Specified by:

getReadCount in interface FileEntry

getRepositoryCapability

public <T extends Capability> T getRepositoryCapability(java.lang.Class<T> capabilityClass)

Specified by:

getRepositoryCapability in interface FileEntry

getStagedModelType

public StagedModelType getStagedModelType()

Specified by:

getStagedModelType in interface StagedModel

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface FileEntry

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface FileEntry

hasLock

public boolean hasLock()

Specified by:

hasLock in interface FileEntry

isCheckedOut

public boolean isCheckedOut()

Specified by:

isCheckedOut in interface FileEntry

isManualCheckInRequired

public boolean isManualCheckInRequired()

Specified by:

isManualCheckInRequired in interface FileEntry

isRepositoryCapabilityProvided

public <T extends Capability> boolean isRepositoryCapabilityProvided(java.lang.Class<T> capabilityClass)

Specified by:

isRepositoryCapabilityProvided in interface FileEntry

isSupportsLocking

public boolean isSupportsLocking()

Specified by:

isSupportsLocking in interface FileEntry