Liferay 6.0.5

com.liferay.portlet.documentlibrary.model
Interface DLFileEntryModel

All Superinterfaces:
BaseModel<DLFileEntry>, Cloneable, Comparable<DLFileEntry>, Serializable
All Known Subinterfaces:
DLFileEntry
All Known Implementing Classes:
DLFileEntryImpl, DLFileEntryModelImpl, DLFileEntryWrapper

public interface DLFileEntryModel
extends BaseModel<DLFileEntry>

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.

Never modify or reference this interface directly. All methods that expect a d l file entry model instance should use the DLFileEntry interface instead.

See Also:
DLFileEntry, DLFileEntryImpl, DLFileEntryModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(DLFileEntry dlFileEntry)
           
 long getCompanyId()
          Gets the company id of this d l file entry.
 Date getCreateDate()
          Gets the create date of this d l file entry.
 String getDescription()
          Gets the description of this d l file entry.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getExtension()
          Gets the extension of this d l file entry.
 String getExtraSettings()
          Gets the extra settings of this d l file entry.
 long getFileEntryId()
          Gets the file entry id of this d l file entry.
 long getFolderId()
          Gets the folder id of this d l file entry.
 long getGroupId()
          Gets the group id of this d l file entry.
 Date getModifiedDate()
          Gets the modified date of this d l file entry.
 String getName()
          Gets the name of this d l file entry.
 long getPrimaryKey()
          Gets the primary key of this d l file entry.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 int getReadCount()
          Gets the read count of this d l file entry.
 long getSize()
          Gets the size of this d l file entry.
 String getTitle()
          Gets the title of this d l file entry.
 long getUserId()
          Gets the user id of this d l file entry.
 String getUserName()
          Gets the user name of this d l file entry.
 String getUserUuid()
          Gets the user uuid of this d l file entry.
 String getUuid()
          Gets the uuid of this d l file entry.
 String getVersion()
          Gets the version of this d l file entry.
 long getVersionUserId()
          Gets the version user id of this d l file entry.
 String getVersionUserName()
          Gets the version user name of this d l file entry.
 String getVersionUserUuid()
          Gets the version user uuid of this d l file entry.
 int hashCode()
           
 boolean isCachedModel()
          Determines if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Determines if this model instance is escaped.
 boolean isNew()
          Determines 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 setCompanyId(long companyId)
          Sets the company id of this d l file entry.
 void setCreateDate(Date createDate)
          Sets the create date of this d l file entry.
 void setDescription(String description)
          Sets the description of this d l file entry.
 void setEscapedModel(boolean escapedModel)
          Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
 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 d l file entry.
 void setExtraSettings(String extraSettings)
          Sets the extra settings of this d l file entry.
 void setFileEntryId(long fileEntryId)
          Sets the file entry id of this d l file entry.
 void setFolderId(long folderId)
          Sets the folder id of this d l file entry.
 void setGroupId(long groupId)
          Sets the group id of this d l file entry.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this d l file entry.
 void setName(String name)
          Sets the name of this d l file entry.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPrimaryKey(long pk)
          Sets the primary key of this d l file entry
 void setReadCount(int readCount)
          Sets the read count of this d l file entry.
 void setSize(long size)
          Sets the size of this d l file entry.
 void setTitle(String title)
          Sets the title of this d l file entry.
 void setUserId(long userId)
          Sets the user id of this d l file entry.
 void setUserName(String userName)
          Sets the user name of this d l file entry.
 void setUserUuid(String userUuid)
          Sets the user uuid of this d l file entry.
 void setUuid(String uuid)
          Sets the uuid of this d l file entry.
 void setVersion(String version)
          Sets the version of this d l file entry.
 void setVersionUserId(long versionUserId)
          Sets the version user id of this d l file entry.
 void setVersionUserName(String versionUserName)
          Sets the version user name of this d l file entry.
 void setVersionUserUuid(String versionUserUuid)
          Sets the version user uuid of this d l file entry.
 DLFileEntry toEscapedModel()
          Gets a copy of this d l file entry as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Gets the primary key of this d l file entry.

Returns:
the primary key of this d l file entry

setPrimaryKey

void setPrimaryKey(long pk)
Sets the primary key of this d l file entry

Parameters:
pk - the primary key of this d l file entry

getUuid

@AutoEscape
String getUuid()
Gets the uuid of this d l file entry.

Returns:
the uuid of this d l file entry

setUuid

void setUuid(String uuid)
Sets the uuid of this d l file entry.

Parameters:
uuid - the uuid of this d l file entry

getFileEntryId

long getFileEntryId()
Gets the file entry id of this d l file entry.

Returns:
the file entry id of this d l file entry

setFileEntryId

void setFileEntryId(long fileEntryId)
Sets the file entry id of this d l file entry.

Parameters:
fileEntryId - the file entry id of this d l file entry

getGroupId

long getGroupId()
Gets the group id of this d l file entry.

Returns:
the group id of this d l file entry

setGroupId

void setGroupId(long groupId)
Sets the group id of this d l file entry.

Parameters:
groupId - the group id of this d l file entry

getCompanyId

long getCompanyId()
Gets the company id of this d l file entry.

Returns:
the company id of this d l file entry

setCompanyId

void setCompanyId(long companyId)
Sets the company id of this d l file entry.

Parameters:
companyId - the company id of this d l file entry

getUserId

long getUserId()
Gets the user id of this d l file entry.

Returns:
the user id of this d l file entry

setUserId

void setUserId(long userId)
Sets the user id of this d l file entry.

Parameters:
userId - the user id of this d l file entry

getUserUuid

String getUserUuid()
                   throws SystemException
Gets the user uuid of this d l file entry.

Returns:
the user uuid of this d l file entry
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this d l file entry.

Parameters:
userUuid - the user uuid of this d l file entry

getUserName

@AutoEscape
String getUserName()
Gets the user name of this d l file entry.

Returns:
the user name of this d l file entry

setUserName

void setUserName(String userName)
Sets the user name of this d l file entry.

Parameters:
userName - the user name of this d l file entry

getVersionUserId

long getVersionUserId()
Gets the version user id of this d l file entry.

Returns:
the version user id of this d l file entry

setVersionUserId

void setVersionUserId(long versionUserId)
Sets the version user id of this d l file entry.

Parameters:
versionUserId - the version user id of this d l file entry

getVersionUserUuid

String getVersionUserUuid()
                          throws SystemException
Gets the version user uuid of this d l file entry.

Returns:
the version user uuid of this d l file entry
Throws:
SystemException - if a system exception occurred

setVersionUserUuid

void setVersionUserUuid(String versionUserUuid)
Sets the version user uuid of this d l file entry.

Parameters:
versionUserUuid - the version user uuid of this d l file entry

getVersionUserName

@AutoEscape
String getVersionUserName()
Gets the version user name of this d l file entry.

Returns:
the version user name of this d l file entry

setVersionUserName

void setVersionUserName(String versionUserName)
Sets the version user name of this d l file entry.

Parameters:
versionUserName - the version user name of this d l file entry

getCreateDate

Date getCreateDate()
Gets the create date of this d l file entry.

Returns:
the create date of this d l file entry

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this d l file entry.

Parameters:
createDate - the create date of this d l file entry

getModifiedDate

Date getModifiedDate()
Gets the modified date of this d l file entry.

Returns:
the modified date of this d l file entry

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this d l file entry.

Parameters:
modifiedDate - the modified date of this d l file entry

getFolderId

long getFolderId()
Gets the folder id of this d l file entry.

Returns:
the folder id of this d l file entry

setFolderId

void setFolderId(long folderId)
Sets the folder id of this d l file entry.

Parameters:
folderId - the folder id of this d l file entry

getName

@AutoEscape
String getName()
Gets the name of this d l file entry.

Returns:
the name of this d l file entry

setName

void setName(String name)
Sets the name of this d l file entry.

Parameters:
name - the name of this d l file entry

getExtension

@AutoEscape
String getExtension()
Gets the extension of this d l file entry.

Returns:
the extension of this d l file entry

setExtension

void setExtension(String extension)
Sets the extension of this d l file entry.

Parameters:
extension - the extension of this d l file entry

getTitle

@AutoEscape
String getTitle()
Gets the title of this d l file entry.

Returns:
the title of this d l file entry

setTitle

void setTitle(String title)
Sets the title of this d l file entry.

Parameters:
title - the title of this d l file entry

getDescription

@AutoEscape
String getDescription()
Gets the description of this d l file entry.

Returns:
the description of this d l file entry

setDescription

void setDescription(String description)
Sets the description of this d l file entry.

Parameters:
description - the description of this d l file entry

getExtraSettings

@AutoEscape
String getExtraSettings()
Gets the extra settings of this d l file entry.

Returns:
the extra settings of this d l file entry

setExtraSettings

void setExtraSettings(String extraSettings)
Sets the extra settings of this d l file entry.

Parameters:
extraSettings - the extra settings of this d l file entry

getVersion

@AutoEscape
String getVersion()
Gets the version of this d l file entry.

Returns:
the version of this d l file entry

setVersion

void setVersion(String version)
Sets the version of this d l file entry.

Parameters:
version - the version of this d l file entry

getSize

long getSize()
Gets the size of this d l file entry.

Returns:
the size of this d l file entry

setSize

void setSize(long size)
Sets the size of this d l file entry.

Parameters:
size - the size of this d l file entry

getReadCount

int getReadCount()
Gets the read count of this d l file entry.

Returns:
the read count of this d l file entry

setReadCount

void setReadCount(int readCount)
Sets the read count of this d l file entry.

Parameters:
readCount - the read count of this d l file entry

toEscapedModel

DLFileEntry toEscapedModel()
Gets a copy of this d l file entry as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

isNew

boolean isNew()
Description copied from interface: BaseModel
Determines 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
Determines 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
Determines if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<DLFileEntry>
Returns:
true if this model instance is escaped; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:
setEscapedModel in interface BaseModel<DLFileEntry>
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Gets the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<DLFileEntry>
Returns:
the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Gets the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<DLFileEntry>
Returns:
the expando bridge for this model instance

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 retrieve the expando bridge attributes from
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>
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

toString

String toString()
Overrides:
toString in class Object

toXmlString

String toXmlString()
Description copied from interface: BaseModel
Gets the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<DLFileEntry>
Returns:
the XML representation of this model instance

Liferay 6.0.5