com.liferay.portlet.documentlibrary.model
Interface DLFileEntryModel

All Superinterfaces:

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

All Known Subinterfaces:

DLFileEntry

All Known Implementing Classes:

DLFileEntryWrapper

@ProviderType
public interface DLFileEntryModel
extends AttachedModel, BaseModel<DLFileEntry>, StagedGroupedModel, TrashedModel

The base model interface for the DLFileEntry service. Represents a row in the "DLFileEntry" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation DLFileEntryModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in DLFileEntryImpl.

See Also:

DLFileEntry, DLFileEntryImpl, DLFileEntryModelImpl

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(DLFileEntry dlFileEntry)
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.
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.
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.
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.
long	getFolderId() Returns the folder ID of this document library file entry.
long	getGroupId() Returns the group ID of this document library file entry.
long	getLargeImageId() Returns the large image ID of this document library file entry.
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.
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.
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.
int	hashCode()
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Returns true if this model instance is escaped.
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	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	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	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	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.

Methods inherited from interface com.liferay.portal.model.BaseModel

getModelAttributes, resetOriginalValues, setModelAttributes

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

getModelClass, getModelClassName

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

getStagedModelType

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this document library file entry.

Returns:

the primary key of this document library file entry

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this document library file entry.

Parameters:

primaryKey - the primary key of this document library file entry

getUuid

@AutoEscape
String getUuid()

Returns the uuid of this document library file entry.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this document library file entry

setUuid

void setUuid(String uuid)

Sets the uuid of this document library file entry.

Specified by:

setUuid in interface StagedModel

Parameters:

uuid - the uuid of this document library file entry

getFileEntryId

long getFileEntryId()

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

Returns:

the file entry ID of this document library file entry

setFileEntryId

void setFileEntryId(long fileEntryId)

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

Parameters:

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

getGroupId

long getGroupId()

Returns the group ID of this document library file entry.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this document library file entry

setGroupId

void setGroupId(long groupId)

Sets the group ID of this document library file entry.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this document library file entry

getCompanyId

long getCompanyId()

Returns the company ID of this document library file entry.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface StagedModel

Returns:

the company ID of this document library file entry

setCompanyId

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

Parameters:

companyId - the company ID of this document library file entry

getUserId

long getUserId()

Returns the user ID of this document library file entry.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this document library file entry

setUserId

void setUserId(long userId)

Sets the user ID of this document library file entry.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this document library file entry

getUserUuid

String getUserUuid()
                   throws SystemException

Returns the user uuid of this document library file entry.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this document library file entry

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this document library file entry.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this document library file entry

getUserName

@AutoEscape
String getUserName()

Returns the user name of this document library file entry.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this document library file entry

setUserName

void setUserName(String userName)

Sets the user name of this document library file entry.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this document library file entry

getCreateDate

Date getCreateDate()

Returns the create date of this document library file entry.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this document library file entry

setCreateDate

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

Parameters:

createDate - the create date of this document library file entry

getModifiedDate

Date getModifiedDate()

Returns the modified date of this document library file entry.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this document library file entry

setModifiedDate

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

Parameters:

modifiedDate - the modified date of this document library file entry

getClassName

String getClassName()

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

Specified by:

getClassName in interface TypedModel

Returns:

the fully qualified class name of this document library file entry

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()

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

Specified by:

getClassNameId in interface TypedModel

Returns:

the class name ID of this document library file entry

setClassNameId

void setClassNameId(long classNameId)

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

Specified by:

setClassNameId in interface TypedModel

Parameters:

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

getClassPK

long getClassPK()

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

Specified by:

getClassPK in interface AttachedModel

Returns:

the class p k of this document library file entry

setClassPK

void setClassPK(long classPK)

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

Specified by:

setClassPK in interface AttachedModel

Parameters:

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

getRepositoryId

long getRepositoryId()

Returns the repository ID of this document library file entry.

Returns:

the repository ID of this document library file entry

setRepositoryId

void setRepositoryId(long repositoryId)

Sets the repository ID of this document library file entry.

Parameters:

repositoryId - the repository ID of this document library file entry

getFolderId

long getFolderId()

Returns the folder ID of this document library file entry.

Returns:

the folder ID of this document library file entry

setFolderId

void setFolderId(long folderId)

Sets the folder ID of this document library file entry.

Parameters:

folderId - the folder ID of this document library file entry

getTreePath

@AutoEscape
String getTreePath()

Returns the tree path of this document library file entry.

Returns:

the tree path of this document library file entry

setTreePath

void setTreePath(String treePath)

Sets the tree path of this document library file entry.

Parameters:

treePath - the tree path of this document library file entry

getName

@AutoEscape
String getName()

Returns the name of this document library file entry.

Returns:

the name of this document library file entry

setName

void setName(String name)

Sets the name of this document library file entry.

Parameters:

name - the name of this document library file entry

getExtension

@AutoEscape
String getExtension()

Returns the extension of this document library file entry.

Returns:

the extension of this document library file entry

setExtension

void setExtension(String extension)

Sets the extension of this document library file entry.

Parameters:

extension - the extension of this document library file entry

getMimeType

@AutoEscape
String getMimeType()

Returns the mime type of this document library file entry.

Returns:

the mime type of this document library file entry

setMimeType

void setMimeType(String mimeType)

Sets the mime type of this document library file entry.

Parameters:

mimeType - the mime type of this document library file entry

getTitle

@AutoEscape
String getTitle()

Returns the title of this document library file entry.

Returns:

the title of this document library file entry

setTitle

void setTitle(String title)

Sets the title of this document library file entry.

Parameters:

title - the title of this document library file entry

getDescription

@AutoEscape
String getDescription()

Returns the description of this document library file entry.

Returns:

the description of this document library file entry

setDescription

void setDescription(String description)

Sets the description of this document library file entry.

Parameters:

description - the description of this document library file entry

getExtraSettings

@AutoEscape
String getExtraSettings()

Returns the extra settings of this document library file entry.

Returns:

the extra settings of this document library file entry

setExtraSettings

void setExtraSettings(String extraSettings)

Sets the extra settings of this document library file entry.

Parameters:

extraSettings - the extra settings of this document library file entry

getFileEntryTypeId

long getFileEntryTypeId()

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

Returns:

the file entry type ID of this document library file entry

setFileEntryTypeId

void setFileEntryTypeId(long fileEntryTypeId)

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

Parameters:

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

getVersion

@AutoEscape
String getVersion()

Returns the version of this document library file entry.

Returns:

the version of this document library file entry

setVersion

void setVersion(String version)

Sets the version of this document library file entry.

Parameters:

version - the version of this document library file entry

getSize

long getSize()

Returns the size of this document library file entry.

Returns:

the size of this document library file entry

setSize

void setSize(long size)

Sets the size of this document library file entry.

Parameters:

size - the size of this document library file entry

getReadCount

int getReadCount()

Returns the read count of this document library file entry.

Returns:

the read count of this document library file entry

setReadCount

void setReadCount(int readCount)

Sets the read count of this document library file entry.

Parameters:

readCount - the read count of this document library file entry

getSmallImageId

long getSmallImageId()

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

Returns:

the small image ID of this document library file entry

setSmallImageId

void setSmallImageId(long smallImageId)

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

Parameters:

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

getLargeImageId

long getLargeImageId()

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

Returns:

the large image ID of this document library file entry

setLargeImageId

void setLargeImageId(long largeImageId)

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

Parameters:

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

getCustom1ImageId

long getCustom1ImageId()

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

Returns:

the custom1 image ID of this document library file entry

setCustom1ImageId

void setCustom1ImageId(long custom1ImageId)

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

Parameters:

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

getCustom2ImageId

long getCustom2ImageId()

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

Returns:

the custom2 image ID of this document library file entry

setCustom2ImageId

void setCustom2ImageId(long custom2ImageId)

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

Parameters:

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

getManualCheckInRequired

boolean getManualCheckInRequired()

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

Returns:

the manual check in required of this document library file entry

isManualCheckInRequired

boolean isManualCheckInRequired()

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

Returns:

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

setManualCheckInRequired

void setManualCheckInRequired(boolean manualCheckInRequired)

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

Parameters:

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

getStatus

int getStatus()

Returns the status of this document library file entry.

Specified by:

getStatus in interface TrashedModel

Returns:

the status of this document library file entry

getTrashEntry

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

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

long getTrashEntryClassPK()

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

Specified by:

getTrashEntryClassPK in interface TrashedModel

Returns:

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

getTrashHandler

TrashHandler getTrashHandler()

Returns the trash handler for this document library file entry.

Specified by:

getTrashHandler in interface TrashedModel

Returns:

the trash handler for this document library file entry

isInTrash

boolean isInTrash()

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

Specified by:

isInTrash in interface TrashedModel

Returns:

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

isInTrashContainer

boolean isInTrashContainer()

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

Specified by:

isInTrashContainer in interface TrashedModel

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

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>

Returns:

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

setNew

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>

Parameters:

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

isCachedModel

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>

Returns:

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

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

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>

Parameters:

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

See Also:

EntityCache

isEscapedModel

boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<DLFileEntry>

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

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

Returns:

the primary key of this model instance

setPrimaryKeyObj

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

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

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

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<DLFileEntry>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<DLFileEntry>

setExpandoBridgeAttributes

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>

Parameters:

serviceContext - the service context to be applied

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(DLFileEntry dlFileEntry)

Specified by:

compareTo in interface Comparable<DLFileEntry>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

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>

Returns:

the cache model object

toEscapedModel

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>

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

DLFileEntry toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<DLFileEntry>

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<DLFileEntry>

Returns:

the XML representation of this model instance