com.liferay.portlet.documentlibrary.model
Class DLFileEntryWrapper

java.lang.Object
  com.liferay.portlet.documentlibrary.model.DLFileEntryWrapper

All Implemented Interfaces:

AttachedModel, AuditedModel, BaseModel<DLFileEntry>, ClassedModel, GroupedModel, ModelWrapper<DLFileEntry>, PersistedModel, StagedGroupedModel, StagedModel, TrashedModel, TreeModel, TypedModel, DLFileEntry, DLFileEntryModel, Serializable, Cloneable, Comparable<DLFileEntry>

@ProviderType
public class DLFileEntryWrapper
extends Object
implements DLFileEntry, ModelWrapper<DLFileEntry>

This class is a wrapper for DLFileEntry.

See Also:

DLFileEntry, Serialized Form

Constructor Summary

DLFileEntryWrapper(DLFileEntry dlFileEntry)

Method Summary

String	buildTreePath()
Object	clone() Creates a shallow clone of this model instance.
int	compareTo(DLFileEntry dlFileEntry)
boolean	equals(Object obj)
String	getClassName() Returns the fully qualified class name of this document library file entry.
long	getClassNameId() Returns the class name ID of this document library file entry.
long	getClassPK() Returns the class p k of this document library file entry.
long	getCompanyId() Returns the company ID of this document library file entry.
InputStream	getContentStream()
InputStream	getContentStream(String version)
Date	getCreateDate() Returns the create date of this document library file entry.
long	getCustom1ImageId() Returns the custom1 image ID of this document library file entry.
long	getCustom2ImageId() Returns the custom2 image ID of this document library file entry.
long	getDataRepositoryId()
String	getDescription() Returns the description of this document library file entry.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
String	getExtension() Returns the extension of this document library file entry.
String	getExtraSettings() Returns the extra settings of this document library file entry.
UnicodeProperties	getExtraSettingsProperties()
Map<String,Fields>	getFieldsMap(long fileVersionId)
long	getFileEntryId() Returns the file entry ID of this document library file entry.
long	getFileEntryTypeId() Returns the file entry type ID of this document library file entry.
DLFileVersion	getFileVersion()
DLFileVersion	getFileVersion(String version)
List<DLFileVersion>	getFileVersions(int status)
int	getFileVersionsCount(int status)
DLFolder	getFolder()
long	getFolderId() Returns the folder ID of this document library file entry.
long	getGroupId() Returns the group ID of this document library file entry.
String	getIcon()
long	getLargeImageId() Returns the large image ID of this document library file entry.
DLFileVersion	getLatestFileVersion(boolean trusted)
Lock	getLock()
String	getLuceneProperties()
boolean	getManualCheckInRequired() Returns the manual check in required of this document library file entry.
String	getMimeType() Returns the mime type of this document library file entry.
Map<String,Object>	getModelAttributes()
Class<?>	getModelClass()
String	getModelClassName()
Date	getModifiedDate() Returns the modified date of this document library file entry.
String	getName() Returns the name of this document library file entry.
long	getPrimaryKey() Returns the primary key of this document library file entry.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
int	getReadCount() Returns the read count of this document library file entry.
long	getRepositoryId() Returns the repository ID of this document library file entry.
long	getSize() Returns the size of this document library file entry.
long	getSmallImageId() Returns the small image ID of this document library file entry.
StagedModelType	getStagedModelType()
int	getStatus() Returns the status of this document library file entry.
String	getTitle() Returns the title of this document library file entry.
TrashEntry	getTrashEntry() Returns the trash entry created when this document library file entry was moved to the Recycle Bin.
long	getTrashEntryClassPK() Returns the class primary key of the trash entry for this document library file entry.
TrashHandler	getTrashHandler() Returns the trash handler for this document library file entry.
String	getTreePath() Returns the tree path of this document library file entry.
long	getUserId() Returns the user ID of this document library file entry.
String	getUserName() Returns the user name of this document library file entry.
String	getUserUuid() Returns the user uuid of this document library file entry.
String	getUuid() Returns the uuid of this document library file entry.
String	getVersion() Returns the version of this document library file entry.
long	getVersionUserId() Deprecated. As of 6.2.0, replaced by DLFileVersionModel.getUserId()
String	getVersionUserName() Deprecated. As of 6.2.0, replaced by DLFileVersionModel.getUserName()
String	getVersionUserUuid() Deprecated. As of 6.2.0, replaced by DLFileVersionModel.getUserUuid()
DLFileEntry	getWrappedDLFileEntry() Deprecated. As of 6.1.0, replaced by getWrappedModel()
DLFileEntry	getWrappedModel()
int	hashCode()
boolean	hasLock()
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isCheckedOut()
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isInHiddenFolder()
boolean	isInTrash() Returns true if this document library file entry is in the Recycle Bin.
boolean	isInTrashContainer() Returns true if the parent of this document library file entry is in the Recycle Bin.
boolean	isInTrashExplicitly()
boolean	isManualCheckInRequired() Returns true if this document library file entry is manual check in required.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
void	persist() Updates this model instance in the database or adds it if it does not yet exist.
void	resetOriginalValues() Reset all original fields to current values.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setClassName(String className)
void	setClassNameId(long classNameId) Sets the class name ID of this document library file entry.
void	setClassPK(long classPK) Sets the class p k of this document library file entry.
void	setCompanyId(long companyId) Sets the company ID of this document library file entry.
void	setCreateDate(Date createDate) Sets the create date of this document library file entry.
void	setCustom1ImageId(long custom1ImageId) Sets the custom1 image ID of this document library file entry.
void	setCustom2ImageId(long custom2ImageId) Sets the custom2 image ID of this document library file entry.
void	setDescription(String description) Sets the description of this document library file entry.
void	setExpandoBridgeAttributes(BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setExtension(String extension) Sets the extension of this document library file entry.
void	setExtraSettings(String extraSettings) Sets the extra settings of this document library file entry.
void	setExtraSettingsProperties(UnicodeProperties extraSettingsProperties)
void	setFileEntryId(long fileEntryId) Sets the file entry ID of this document library file entry.
void	setFileEntryTypeId(long fileEntryTypeId) Sets the file entry type ID of this document library file entry.
void	setFolderId(long folderId) Sets the folder ID of this document library file entry.
void	setGroupId(long groupId) Sets the group ID of this document library file entry.
void	setLargeImageId(long largeImageId) Sets the large image ID of this document library file entry.
void	setManualCheckInRequired(boolean manualCheckInRequired) Sets whether this document library file entry is manual check in required.
void	setMimeType(String mimeType) Sets the mime type of this document library file entry.
void	setModelAttributes(Map<String,Object> attributes)
void	setModifiedDate(Date modifiedDate) Sets the modified date of this document library file entry.
void	setName(String name) Sets the name of this document library file entry.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrimaryKey(long primaryKey) Sets the primary key of this document library file entry.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setReadCount(int readCount) Sets the read count of this document library file entry.
void	setRepositoryId(long repositoryId) Sets the repository ID of this document library file entry.
void	setSize(long size) Sets the size of this document library file entry.
void	setSmallImageId(long smallImageId) Sets the small image ID of this document library file entry.
void	setTitle(String title) Sets the title of this document library file entry.
void	setTreePath(String treePath) Sets the tree path of this document library file entry.
void	setUserId(long userId) Sets the user ID of this document library file entry.
void	setUserName(String userName) Sets the user name of this document library file entry.
void	setUserUuid(String userUuid) Sets the user uuid of this document library file entry.
void	setUuid(String uuid) Sets the uuid of this document library file entry.
void	setVersion(String version) Sets the version of this document library file entry.
CacheModel<DLFileEntry>	toCacheModel() Returns a cache model object for this entity used by entity cache.
DLFileEntry	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
DLFileEntry	toUnescapedModel()
String	toXmlString() Returns the XML representation of this model instance.
void	updateTreePath(String treePath)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DLFileEntryWrapper

public DLFileEntryWrapper(DLFileEntry dlFileEntry)

Method Detail

getModelClass

public Class<?> getModelClass()

Specified by:

getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()

Specified by:

getModelClassName in interface ClassedModel

getModelAttributes

public Map<String,Object> getModelAttributes()

Specified by:

getModelAttributes in interface BaseModel<DLFileEntry>

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)

Specified by:

setModelAttributes in interface BaseModel<DLFileEntry>

getPrimaryKey

public long getPrimaryKey()

Returns the primary key of this document library file entry.

Specified by:

getPrimaryKey in interface DLFileEntryModel

Returns:

the primary key of this document library file entry

setPrimaryKey

public void setPrimaryKey(long primaryKey)

Sets the primary key of this document library file entry.

Specified by:

setPrimaryKey in interface DLFileEntryModel

Parameters:

primaryKey - the primary key of this document library file entry

getUuid

public String getUuid()

Returns the uuid of this document library file entry.

Specified by:

getUuid in interface StagedModel

Specified by:

getUuid in interface DLFileEntryModel

Returns:

the uuid of this document library file entry

setUuid

public void setUuid(String uuid)

Sets the uuid of this document library file entry.

Specified by:

setUuid in interface StagedModel

Specified by:

setUuid in interface DLFileEntryModel

Parameters:

uuid - the uuid of this document library file entry

getFileEntryId

public long getFileEntryId()

Returns the file entry ID of this document library file entry.

Specified by:

getFileEntryId in interface DLFileEntryModel

Returns:

the file entry ID of this document library file entry

setFileEntryId

public void setFileEntryId(long fileEntryId)

Sets the file entry ID of this document library file entry.

Specified by:

setFileEntryId in interface DLFileEntryModel

Parameters:

fileEntryId - the file entry ID of this document library file entry

getGroupId

public long getGroupId()

Returns the group ID of this document library file entry.

Specified by:

getGroupId in interface GroupedModel

Specified by:

getGroupId in interface DLFileEntryModel

Returns:

the group ID of this document library file entry

setGroupId

public void setGroupId(long groupId)

Sets the group ID of this document library file entry.

Specified by:

setGroupId in interface GroupedModel

Specified by:

setGroupId in interface DLFileEntryModel

Parameters:

groupId - the group ID of this document library file entry

getCompanyId

public long getCompanyId()

Returns the company ID of this document library file entry.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface StagedModel

Specified by:

getCompanyId in interface DLFileEntryModel

Returns:

the company ID of this document library file entry

setCompanyId

public void setCompanyId(long companyId)

Sets the company ID of this document library file entry.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface StagedModel

Specified by:

setCompanyId in interface DLFileEntryModel

Parameters:

companyId - the company ID of this document library file entry

getUserId

public long getUserId()

Returns the user ID of this document library file entry.

Specified by:

getUserId in interface AuditedModel

Specified by:

getUserId in interface DLFileEntryModel

Returns:

the user ID of this document library file entry

setUserId

public void setUserId(long userId)

Sets the user ID of this document library file entry.

Specified by:

setUserId in interface AuditedModel

Specified by:

setUserId in interface DLFileEntryModel

Parameters:

userId - the user ID of this document library file entry

getUserUuid

public String getUserUuid()
                   throws SystemException

Returns the user uuid of this document library file entry.

Specified by:

getUserUuid in interface AuditedModel

Specified by:

getUserUuid in interface DLFileEntryModel

Returns:

the user uuid of this document library file entry

Throws:

SystemException - if a system exception occurred

setUserUuid

public void setUserUuid(String userUuid)

Sets the user uuid of this document library file entry.

Specified by:

setUserUuid in interface AuditedModel

Specified by:

setUserUuid in interface DLFileEntryModel

Parameters:

userUuid - the user uuid of this document library file entry

getUserName

public String getUserName()

Returns the user name of this document library file entry.

Specified by:

getUserName in interface AuditedModel

Specified by:

getUserName in interface DLFileEntryModel

Returns:

the user name of this document library file entry

setUserName

public void setUserName(String userName)

Sets the user name of this document library file entry.

Specified by:

setUserName in interface AuditedModel

Specified by:

setUserName in interface DLFileEntryModel

Parameters:

userName - the user name of this document library file entry

getCreateDate

public Date getCreateDate()

Returns the create date of this document library file entry.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Specified by:

getCreateDate in interface DLFileEntryModel

Returns:

the create date of this document library file entry

setCreateDate

public void setCreateDate(Date createDate)

Sets the create date of this document library file entry.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Specified by:

setCreateDate in interface DLFileEntryModel

Parameters:

createDate - the create date of this document library file entry

getModifiedDate

public Date getModifiedDate()

Returns the modified date of this document library file entry.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Specified by:

getModifiedDate in interface DLFileEntryModel

Returns:

the modified date of this document library file entry

setModifiedDate

public void setModifiedDate(Date modifiedDate)

Sets the modified date of this document library file entry.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Specified by:

setModifiedDate in interface DLFileEntryModel

Parameters:

modifiedDate - the modified date of this document library file entry

getClassName

public String getClassName()

Returns the fully qualified class name of this document library file entry.

Specified by:

getClassName in interface TypedModel

Specified by:

getClassName in interface DLFileEntryModel

Returns:

the fully qualified class name of this document library file entry

setClassName

public void setClassName(String className)

Specified by:

setClassName in interface DLFileEntryModel

getClassNameId

public long getClassNameId()

Returns the class name ID of this document library file entry.

Specified by:

getClassNameId in interface TypedModel

Specified by:

getClassNameId in interface DLFileEntryModel

Returns:

the class name ID of this document library file entry

setClassNameId

public void setClassNameId(long classNameId)

Sets the class name ID of this document library file entry.

Specified by:

setClassNameId in interface TypedModel

Specified by:

setClassNameId in interface DLFileEntryModel

Parameters:

classNameId - the class name ID of this document library file entry

getClassPK

public long getClassPK()

Returns the class p k of this document library file entry.

Specified by:

getClassPK in interface AttachedModel

Specified by:

getClassPK in interface DLFileEntryModel

Returns:

the class p k of this document library file entry

setClassPK

public void setClassPK(long classPK)

Sets the class p k of this document library file entry.

Specified by:

setClassPK in interface AttachedModel

Specified by:

setClassPK in interface DLFileEntryModel

Parameters:

classPK - the class p k of this document library file entry

getRepositoryId

public long getRepositoryId()

Returns the repository ID of this document library file entry.

Specified by:

getRepositoryId in interface DLFileEntryModel

Returns:

the repository ID of this document library file entry

setRepositoryId

public void setRepositoryId(long repositoryId)

Sets the repository ID of this document library file entry.

Specified by:

setRepositoryId in interface DLFileEntryModel

Parameters:

repositoryId - the repository ID of this document library file entry

getFolderId

public long getFolderId()

Returns the folder ID of this document library file entry.

Specified by:

getFolderId in interface DLFileEntryModel

Returns:

the folder ID of this document library file entry

setFolderId

public void setFolderId(long folderId)

Sets the folder ID of this document library file entry.

Specified by:

setFolderId in interface DLFileEntryModel

Parameters:

folderId - the folder ID of this document library file entry

getTreePath

public String getTreePath()

Returns the tree path of this document library file entry.

Specified by:

getTreePath in interface TreeModel

Specified by:

getTreePath in interface DLFileEntryModel

Returns:

the tree path of this document library file entry

setTreePath

public void setTreePath(String treePath)

Sets the tree path of this document library file entry.

Specified by:

setTreePath in interface DLFileEntryModel

Parameters:

treePath - the tree path of this document library file entry

getName

public String getName()

Returns the name of this document library file entry.

Specified by:

getName in interface DLFileEntryModel

Returns:

the name of this document library file entry

setName

public void setName(String name)

Sets the name of this document library file entry.

Specified by:

setName in interface DLFileEntryModel

Parameters:

name - the name of this document library file entry

getExtension

public String getExtension()

Returns the extension of this document library file entry.

Specified by:

getExtension in interface DLFileEntryModel

Returns:

the extension of this document library file entry

setExtension

public void setExtension(String extension)

Sets the extension of this document library file entry.

Specified by:

setExtension in interface DLFileEntryModel

Parameters:

extension - the extension of this document library file entry

getMimeType

public String getMimeType()

Returns the mime type of this document library file entry.

Specified by:

getMimeType in interface DLFileEntryModel

Returns:

the mime type of this document library file entry

setMimeType

public void setMimeType(String mimeType)

Sets the mime type of this document library file entry.

Specified by:

setMimeType in interface DLFileEntryModel

Parameters:

mimeType - the mime type of this document library file entry

getTitle

public String getTitle()

Returns the title of this document library file entry.

Specified by:

getTitle in interface DLFileEntryModel

Returns:

the title of this document library file entry

setTitle

public void setTitle(String title)

Sets the title of this document library file entry.

Specified by:

setTitle in interface DLFileEntryModel

Parameters:

title - the title of this document library file entry

getDescription

public String getDescription()

Returns the description of this document library file entry.

Specified by:

getDescription in interface DLFileEntryModel

Returns:

the description of this document library file entry

setDescription

public void setDescription(String description)

Sets the description of this document library file entry.

Specified by:

setDescription in interface DLFileEntryModel

Parameters:

description - the description of this document library file entry

getExtraSettings

public String getExtraSettings()

Returns the extra settings of this document library file entry.

Specified by:

getExtraSettings in interface DLFileEntryModel

Returns:

the extra settings of this document library file entry

setExtraSettings

public void setExtraSettings(String extraSettings)

Sets the extra settings of this document library file entry.

Specified by:

setExtraSettings in interface DLFileEntryModel

Parameters:

extraSettings - the extra settings of this document library file entry

getFileEntryTypeId

public long getFileEntryTypeId()

Returns the file entry type ID of this document library file entry.

Specified by:

getFileEntryTypeId in interface DLFileEntryModel

Returns:

the file entry type ID of this document library file entry

setFileEntryTypeId

public void setFileEntryTypeId(long fileEntryTypeId)

Sets the file entry type ID of this document library file entry.

Specified by:

setFileEntryTypeId in interface DLFileEntryModel

Parameters:

fileEntryTypeId - the file entry type ID of this document library file entry

getVersion

public String getVersion()

Returns the version of this document library file entry.

Specified by:

getVersion in interface DLFileEntryModel

Returns:

the version of this document library file entry

setVersion

public void setVersion(String version)

Sets the version of this document library file entry.

Specified by:

setVersion in interface DLFileEntryModel

Parameters:

version - the version of this document library file entry

getSize

public long getSize()

Returns the size of this document library file entry.

Specified by:

getSize in interface DLFileEntryModel

Returns:

the size of this document library file entry

setSize

public void setSize(long size)

Sets the size of this document library file entry.

Specified by:

setSize in interface DLFileEntryModel

Parameters:

size - the size of this document library file entry

getReadCount

public int getReadCount()

Returns the read count of this document library file entry.

Specified by:

getReadCount in interface DLFileEntryModel

Returns:

the read count of this document library file entry

setReadCount

public void setReadCount(int readCount)

Sets the read count of this document library file entry.

Specified by:

setReadCount in interface DLFileEntryModel

Parameters:

readCount - the read count of this document library file entry

getSmallImageId

public long getSmallImageId()

Returns the small image ID of this document library file entry.

Specified by:

getSmallImageId in interface DLFileEntryModel

Returns:

the small image ID of this document library file entry

setSmallImageId

public void setSmallImageId(long smallImageId)

Sets the small image ID of this document library file entry.

Specified by:

setSmallImageId in interface DLFileEntryModel

Parameters:

smallImageId - the small image ID of this document library file entry

getLargeImageId

public long getLargeImageId()

Returns the large image ID of this document library file entry.

Specified by:

getLargeImageId in interface DLFileEntryModel

Returns:

the large image ID of this document library file entry

setLargeImageId

public void setLargeImageId(long largeImageId)

Sets the large image ID of this document library file entry.

Specified by:

setLargeImageId in interface DLFileEntryModel

Parameters:

largeImageId - the large image ID of this document library file entry

getCustom1ImageId

public long getCustom1ImageId()

Returns the custom1 image ID of this document library file entry.

Specified by:

getCustom1ImageId in interface DLFileEntryModel

Returns:

the custom1 image ID of this document library file entry

setCustom1ImageId

public void setCustom1ImageId(long custom1ImageId)

Sets the custom1 image ID of this document library file entry.

Specified by:

setCustom1ImageId in interface DLFileEntryModel

Parameters:

custom1ImageId - the custom1 image ID of this document library file entry

getCustom2ImageId

public long getCustom2ImageId()

Returns the custom2 image ID of this document library file entry.

Specified by:

getCustom2ImageId in interface DLFileEntryModel

Returns:

the custom2 image ID of this document library file entry

setCustom2ImageId

public void setCustom2ImageId(long custom2ImageId)

Sets the custom2 image ID of this document library file entry.

Specified by:

setCustom2ImageId in interface DLFileEntryModel

Parameters:

custom2ImageId - the custom2 image ID of this document library file entry

getManualCheckInRequired

public boolean getManualCheckInRequired()

Returns the manual check in required of this document library file entry.

Specified by:

getManualCheckInRequired in interface DLFileEntryModel

Returns:

the manual check in required of this document library file entry

isManualCheckInRequired

public boolean isManualCheckInRequired()

Returns true if this document library file entry is manual check in required.

Specified by:

isManualCheckInRequired in interface DLFileEntryModel

Returns:

true if this document library file entry is manual check in required; false otherwise

setManualCheckInRequired

public void setManualCheckInRequired(boolean manualCheckInRequired)

Sets whether this document library file entry is manual check in required.

Specified by:

setManualCheckInRequired in interface DLFileEntryModel

Parameters:

manualCheckInRequired - the manual check in required of this document library file entry

getStatus

public int getStatus()

Returns the status of this document library file entry.

Specified by:

getStatus in interface TrashedModel

Specified by:

getStatus in interface DLFileEntryModel

Returns:

the status of this document library file entry

getTrashEntry

public TrashEntry getTrashEntry()
                         throws PortalException,
                                SystemException

Returns the trash entry created when this document library file entry was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this document library file entry.

Specified by:

getTrashEntry in interface TrashedModel

Specified by:

getTrashEntry in interface DLFileEntryModel

Returns:

the trash entry created when this document library file entry was moved to the Recycle Bin

Throws:

SystemException - if a system exception occurred

PortalException

getTrashEntryClassPK

public long getTrashEntryClassPK()

Returns the class primary key of the trash entry for this document library file entry.

Specified by:

getTrashEntryClassPK in interface TrashedModel

Specified by:

getTrashEntryClassPK in interface DLFileEntryModel

Returns:

the class primary key of the trash entry for this document library file entry

getTrashHandler

public TrashHandler getTrashHandler()

Returns the trash handler for this document library file entry.

Specified by:

getTrashHandler in interface TrashedModel

Specified by:

getTrashHandler in interface DLFileEntryModel

Returns:

the trash handler for this document library file entry

isInTrash

public boolean isInTrash()

Returns true if this document library file entry is in the Recycle Bin.

Specified by:

isInTrash in interface TrashedModel

Specified by:

isInTrash in interface DLFileEntryModel

Returns:

true if this document library file entry is in the Recycle Bin; false otherwise

isInTrashContainer

public boolean isInTrashContainer()

Returns true if the parent of this document library file entry is in the Recycle Bin.

Specified by:

isInTrashContainer in interface TrashedModel

Specified by:

isInTrashContainer in interface DLFileEntryModel

Returns:

true if the parent of this document library file entry is in the Recycle Bin; false otherwise

Throws:

SystemException - if a system exception occurred

isNew

public boolean isNew()

Description copied from interface: BaseModel

Returns true if this model instance does not yet exist in the database.

Specified by:

isNew in interface BaseModel<DLFileEntry>

Specified by:

isNew in interface DLFileEntryModel

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

public void setNew(boolean n)

Description copied from interface: BaseModel

Sets whether this model instance does not yet exist in the database.

Specified by:

setNew in interface BaseModel<DLFileEntry>

Specified by:

setNew in interface DLFileEntryModel

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

public boolean isCachedModel()

Description copied from interface: BaseModel

Returns true if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<DLFileEntry>

Specified by:

isCachedModel in interface DLFileEntryModel

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

public void setCachedModel(boolean cachedModel)

Description copied from interface: BaseModel

Sets whether this model instance was retrieved from the entity cache.

Specified by:

setCachedModel in interface BaseModel<DLFileEntry>

Specified by:

setCachedModel in interface DLFileEntryModel

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

public boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<DLFileEntry>

Specified by:

isEscapedModel in interface DLFileEntryModel

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<DLFileEntry>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Specified by:

getPrimaryKeyObj in interface TreeModel

Specified by:

getPrimaryKeyObj in interface DLFileEntryModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

public void setPrimaryKeyObj(Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<DLFileEntry>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Specified by:

setPrimaryKeyObj in interface DLFileEntryModel

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<DLFileEntry>

Specified by:

getExpandoBridge in interface ClassedModel

Specified by:

getExpandoBridge in interface DLFileEntryModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<DLFileEntry>

Specified by:

setExpandoBridgeAttributes in interface DLFileEntryModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<DLFileEntry>

Specified by:

setExpandoBridgeAttributes in interface DLFileEntryModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ServiceContext serviceContext)

Description copied from interface: BaseModel

Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:

setExpandoBridgeAttributes in interface BaseModel<DLFileEntry>

Specified by:

setExpandoBridgeAttributes in interface DLFileEntryModel

Parameters:

serviceContext - the service context to be applied

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

public Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<DLFileEntry>

Specified by:

clone in interface StagedModel

Specified by:

clone in interface DLFileEntryModel

Overrides:

clone in class Object

Returns:

the shallow clone of this model instance

compareTo

public int compareTo(DLFileEntry dlFileEntry)

Specified by:

compareTo in interface DLFileEntryModel

Specified by:

compareTo in interface Comparable<DLFileEntry>

hashCode

public int hashCode()

Specified by:

hashCode in interface DLFileEntryModel

Overrides:

hashCode in class Object

toCacheModel

public CacheModel<DLFileEntry> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<DLFileEntry>

Specified by:

toCacheModel in interface DLFileEntryModel

Returns:

the cache model object

toEscapedModel

public DLFileEntry toEscapedModel()

Description copied from interface: BaseModel

Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface BaseModel<DLFileEntry>

Specified by:

toEscapedModel in interface DLFileEntryModel

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

public DLFileEntry toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<DLFileEntry>

Specified by:

toUnescapedModel in interface DLFileEntryModel

toString

public String toString()

Specified by:

toString in interface DLFileEntryModel

Overrides:

toString in class Object

toXmlString

public String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<DLFileEntry>

Specified by:

toXmlString in interface DLFileEntryModel

Returns:

the XML representation of this model instance

persist

public void persist()
             throws SystemException

Description copied from interface: PersistedModel

Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:

persist in interface PersistedModel

Throws:

SystemException - if a system exception occurred

updateTreePath

public void updateTreePath(String treePath)
                    throws SystemException

Specified by:

updateTreePath in interface TreeModel

Throws:

SystemException

buildTreePath

public String buildTreePath()
                     throws PortalException,
                            SystemException

Specified by:

buildTreePath in interface TreeModel

Specified by:

buildTreePath in interface DLFileEntry

Throws:

PortalException

SystemException

getContentStream

public InputStream getContentStream()
                             throws PortalException,
                                    SystemException

Specified by:

getContentStream in interface DLFileEntry

Throws:

PortalException

SystemException

getContentStream

public InputStream getContentStream(String version)
                             throws PortalException,
                                    SystemException

Specified by:

getContentStream in interface DLFileEntry

Throws:

PortalException

SystemException

getDataRepositoryId

public long getDataRepositoryId()

Specified by:

getDataRepositoryId in interface DLFileEntry

getExtraSettingsProperties

public UnicodeProperties getExtraSettingsProperties()

Specified by:

getExtraSettingsProperties in interface DLFileEntry

getFieldsMap

public Map<String,Fields> getFieldsMap(long fileVersionId)
                                throws PortalException,
                                       SystemException

Specified by:

getFieldsMap in interface DLFileEntry

Throws:

PortalException

SystemException

getFileVersion

public DLFileVersion getFileVersion()
                             throws PortalException,
                                    SystemException

Specified by:

getFileVersion in interface DLFileEntry

Throws:

PortalException

SystemException

getFileVersion

public DLFileVersion getFileVersion(String version)
                             throws PortalException,
                                    SystemException

Specified by:

getFileVersion in interface DLFileEntry

Throws:

PortalException

SystemException

getFileVersions

public List<DLFileVersion> getFileVersions(int status)
                                    throws SystemException

Specified by:

getFileVersions in interface DLFileEntry

Throws:

SystemException

getFileVersionsCount

public int getFileVersionsCount(int status)
                         throws SystemException

Specified by:

getFileVersionsCount in interface DLFileEntry

Throws:

SystemException

getFolder

public DLFolder getFolder()
                   throws PortalException,
                          SystemException

Specified by:

getFolder in interface DLFileEntry

Throws:

PortalException

SystemException

getIcon

public String getIcon()

Specified by:

getIcon in interface DLFileEntry

getLatestFileVersion

public DLFileVersion getLatestFileVersion(boolean trusted)
                                   throws PortalException,
                                          SystemException

Specified by:

getLatestFileVersion in interface DLFileEntry

Throws:

PortalException

SystemException

getLock

public Lock getLock()

Specified by:

getLock in interface DLFileEntry

getLuceneProperties

public String getLuceneProperties()

Specified by:

getLuceneProperties in interface DLFileEntry

getVersionUserId

public long getVersionUserId()

Deprecated. As of 6.2.0, replaced by DLFileVersionModel.getUserId()

Specified by:

getVersionUserId in interface DLFileEntry

getVersionUserName

public String getVersionUserName()

Deprecated. As of 6.2.0, replaced by DLFileVersionModel.getUserName()

Specified by:

getVersionUserName in interface DLFileEntry

getVersionUserUuid

public String getVersionUserUuid()

Deprecated. As of 6.2.0, replaced by DLFileVersionModel.getUserUuid()

Specified by:

getVersionUserUuid in interface DLFileEntry

hasLock

public boolean hasLock()

Specified by:

hasLock in interface DLFileEntry

isCheckedOut

public boolean isCheckedOut()

Specified by:

isCheckedOut in interface DLFileEntry

isInHiddenFolder

public boolean isInHiddenFolder()

Specified by:

isInHiddenFolder in interface DLFileEntry

isInTrashExplicitly

public boolean isInTrashExplicitly()
                            throws SystemException

Specified by:

isInTrashExplicitly in interface DLFileEntry

Throws:

SystemException

setExtraSettingsProperties

public void setExtraSettingsProperties(UnicodeProperties extraSettingsProperties)

Specified by:

setExtraSettingsProperties in interface DLFileEntry

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getStagedModelType

public StagedModelType getStagedModelType()

Specified by:

getStagedModelType in interface StagedModel

getWrappedDLFileEntry

public DLFileEntry getWrappedDLFileEntry()

Deprecated. As of 6.1.0, replaced by getWrappedModel()

getWrappedModel

public DLFileEntry getWrappedModel()

Specified by:

getWrappedModel in interface ModelWrapper<DLFileEntry>

resetOriginalValues

public void resetOriginalValues()

Description copied from interface: BaseModel

Reset all original fields to current values.

Specified by:

resetOriginalValues in interface BaseModel<DLFileEntry>