com.liferay.portlet.documentlibrary.model
Interface DLFileVersionModel

All Superinterfaces:

BaseModel<DLFileVersion>, java.lang.Cloneable, java.lang.Comparable<DLFileVersion>, java.io.Serializable

All Known Subinterfaces:

DLFileVersion

All Known Implementing Classes:

DLFileVersionWrapper

public interface DLFileVersionModel
extends BaseModel<DLFileVersion>

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

This interface and its corresponding implementation com.liferay.portlet.documentlibrary.model.impl.DLFileVersionModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.portlet.documentlibrary.model.impl.DLFileVersionImpl.

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

Author:

Brian Wing Shun Chan

See Also:

DLFileVersion, com.liferay.portlet.documentlibrary.model.impl.DLFileVersionImpl, com.liferay.portlet.documentlibrary.model.impl.DLFileVersionModelImpl

Generated:

Method Summary

java.lang.Object	clone() Creates a shallow clone of this model instance.
int	compareTo(DLFileVersion dlFileVersion)
java.lang.String	getChangeLog() Gets the change log of this d l file version.
long	getCompanyId() Gets the company id of this d l file version.
java.util.Date	getCreateDate() Gets the create date of this d l file version.
java.lang.String	getDescription() Gets the description of this d l file version.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
java.lang.String	getExtension() Gets the extension of this d l file version.
java.lang.String	getExtraSettings() Gets the extra settings of this d l file version.
long	getFileVersionId() Gets the file version id of this d l file version.
long	getFolderId() Gets the folder id of this d l file version.
long	getGroupId() Gets the group id of this d l file version.
java.lang.String	getName() Gets the name of this d l file version.
long	getPrimaryKey() Gets the primary key of this d l file version.
java.io.Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getSize() Gets the size of this d l file version.
int	getStatus() Gets the status of this d l file version.
long	getStatusByUserId() Gets the status by user id of this d l file version.
java.lang.String	getStatusByUserName() Gets the status by user name of this d l file version.
java.lang.String	getStatusByUserUuid() Gets the status by user uuid of this d l file version.
java.util.Date	getStatusDate() Gets the status date of this d l file version.
java.lang.String	getTitle() Gets the title of this d l file version.
long	getUserId() Gets the user id of this d l file version.
java.lang.String	getUserName() Gets the user name of this d l file version.
java.lang.String	getUserUuid() Gets the user uuid of this d l file version.
java.lang.String	getVersion() Gets the version of this d l file version.
int	hashCode()
boolean	isApproved() Determines if this d l file version is approved.
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isDraft() Determines if this d l file version is a draft.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isExpired() Determines if this d l file version is expired.
boolean	isNew() Determines if this model instance does not yet exist in the database.
boolean	isPending() Determines if this d l file version is pending.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setChangeLog(java.lang.String changeLog) Sets the change log of this d l file version.
void	setCompanyId(long companyId) Sets the company id of this d l file version.
void	setCreateDate(java.util.Date createDate) Sets the create date of this d l file version.
void	setDescription(java.lang.String description) Sets the description of this d l file version.
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(java.lang.String extension) Sets the extension of this d l file version.
void	setExtraSettings(java.lang.String extraSettings) Sets the extra settings of this d l file version.
void	setFileVersionId(long fileVersionId) Sets the file version id of this d l file version.
void	setFolderId(long folderId) Sets the folder id of this d l file version.
void	setGroupId(long groupId) Sets the group id of this d l file version.
void	setName(java.lang.String name) Sets the name of this d l file version.
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 version
void	setSize(long size) Sets the size of this d l file version.
void	setStatus(int status) Sets the status of this d l file version.
void	setStatusByUserId(long statusByUserId) Sets the status by user id of this d l file version.
void	setStatusByUserName(java.lang.String statusByUserName) Sets the status by user name of this d l file version.
void	setStatusByUserUuid(java.lang.String statusByUserUuid) Sets the status by user uuid of this d l file version.
void	setStatusDate(java.util.Date statusDate) Sets the status date of this d l file version.
void	setTitle(java.lang.String title) Sets the title of this d l file version.
void	setUserId(long userId) Sets the user id of this d l file version.
void	setUserName(java.lang.String userName) Sets the user name of this d l file version.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this d l file version.
void	setVersion(java.lang.String version) Sets the version of this d l file version.
DLFileVersion	toEscapedModel() Gets a copy of this d l file version as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
java.lang.String	toString()
java.lang.String	toXmlString() Gets the XML representation of this model instance.

Method Detail

getPrimaryKey

long getPrimaryKey()

Gets the primary key of this d l file version.

Returns:

the primary key of this d l file version

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this d l file version

Parameters:

pk - the primary key of this d l file version

getFileVersionId

long getFileVersionId()

Gets the file version id of this d l file version.

Returns:

the file version id of this d l file version

setFileVersionId

void setFileVersionId(long fileVersionId)

Sets the file version id of this d l file version.

Parameters:

fileVersionId - the file version id of this d l file version

getGroupId

long getGroupId()

Gets the group id of this d l file version.

Returns:

the group id of this d l file version

setGroupId

void setGroupId(long groupId)

Sets the group id of this d l file version.

Parameters:

groupId - the group id of this d l file version

getCompanyId

long getCompanyId()

Gets the company id of this d l file version.

Returns:

the company id of this d l file version

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this d l file version.

Parameters:

companyId - the company id of this d l file version

getUserId

long getUserId()

Gets the user id of this d l file version.

Returns:

the user id of this d l file version

setUserId

void setUserId(long userId)

Sets the user id of this d l file version.

Parameters:

userId - the user id of this d l file version

getUserUuid

java.lang.String getUserUuid()
                             throws SystemException

Gets the user uuid of this d l file version.

Returns:

the user uuid of this d l file version

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this d l file version.

Parameters:

userUuid - the user uuid of this d l file version

getUserName

@AutoEscape
java.lang.String getUserName()

Gets the user name of this d l file version.

Returns:

the user name of this d l file version

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this d l file version.

Parameters:

userName - the user name of this d l file version

getCreateDate

java.util.Date getCreateDate()

Gets the create date of this d l file version.

Returns:

the create date of this d l file version

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this d l file version.

Parameters:

createDate - the create date of this d l file version

getFolderId

long getFolderId()

Gets the folder id of this d l file version.

Returns:

the folder id of this d l file version

setFolderId

void setFolderId(long folderId)

Sets the folder id of this d l file version.

Parameters:

folderId - the folder id of this d l file version

getName

@AutoEscape
java.lang.String getName()

Gets the name of this d l file version.

Returns:

the name of this d l file version

setName

void setName(java.lang.String name)

Sets the name of this d l file version.

Parameters:

name - the name of this d l file version

getExtension

@AutoEscape
java.lang.String getExtension()

Gets the extension of this d l file version.

Returns:

the extension of this d l file version

setExtension

void setExtension(java.lang.String extension)

Sets the extension of this d l file version.

Parameters:

extension - the extension of this d l file version

getTitle

@AutoEscape
java.lang.String getTitle()

Gets the title of this d l file version.

Returns:

the title of this d l file version

setTitle

void setTitle(java.lang.String title)

Sets the title of this d l file version.

Parameters:

title - the title of this d l file version

getDescription

@AutoEscape
java.lang.String getDescription()

Gets the description of this d l file version.

Returns:

the description of this d l file version

setDescription

void setDescription(java.lang.String description)

Sets the description of this d l file version.

Parameters:

description - the description of this d l file version

getChangeLog

@AutoEscape
java.lang.String getChangeLog()

Gets the change log of this d l file version.

Returns:

the change log of this d l file version

setChangeLog

void setChangeLog(java.lang.String changeLog)

Sets the change log of this d l file version.

Parameters:

changeLog - the change log of this d l file version

getExtraSettings

@AutoEscape
java.lang.String getExtraSettings()

Gets the extra settings of this d l file version.

Returns:

the extra settings of this d l file version

setExtraSettings

void setExtraSettings(java.lang.String extraSettings)

Sets the extra settings of this d l file version.

Parameters:

extraSettings - the extra settings of this d l file version

getVersion

@AutoEscape
java.lang.String getVersion()

Gets the version of this d l file version.

Returns:

the version of this d l file version

setVersion

void setVersion(java.lang.String version)

Sets the version of this d l file version.

Parameters:

version - the version of this d l file version

getSize

long getSize()

Gets the size of this d l file version.

Returns:

the size of this d l file version

setSize

void setSize(long size)

Sets the size of this d l file version.

Parameters:

size - the size of this d l file version

getStatus

int getStatus()

Gets the status of this d l file version.

Returns:

the status of this d l file version

setStatus

void setStatus(int status)

Sets the status of this d l file version.

Parameters:

status - the status of this d l file version

getStatusByUserId

long getStatusByUserId()

Gets the status by user id of this d l file version.

Returns:

the status by user id of this d l file version

setStatusByUserId

void setStatusByUserId(long statusByUserId)

Sets the status by user id of this d l file version.

Parameters:

statusByUserId - the status by user id of this d l file version

getStatusByUserUuid

java.lang.String getStatusByUserUuid()
                                     throws SystemException

Gets the status by user uuid of this d l file version.

Returns:

the status by user uuid of this d l file version

Throws:

SystemException - if a system exception occurred

setStatusByUserUuid

void setStatusByUserUuid(java.lang.String statusByUserUuid)

Sets the status by user uuid of this d l file version.

Parameters:

statusByUserUuid - the status by user uuid of this d l file version

getStatusByUserName

@AutoEscape
java.lang.String getStatusByUserName()

Gets the status by user name of this d l file version.

Returns:

the status by user name of this d l file version

setStatusByUserName

void setStatusByUserName(java.lang.String statusByUserName)

Sets the status by user name of this d l file version.

Parameters:

statusByUserName - the status by user name of this d l file version

getStatusDate

java.util.Date getStatusDate()

Gets the status date of this d l file version.

Returns:

the status date of this d l file version

setStatusDate

void setStatusDate(java.util.Date statusDate)

Sets the status date of this d l file version.

Parameters:

statusDate - the status date of this d l file version

isApproved

boolean isApproved()

Determines if this d l file version is approved.

Returns:

true if this d l file version is approved; false otherwise

isDraft

boolean isDraft()

Determines if this d l file version is a draft.

Returns:

true if this d l file version is a draft; false otherwise

isExpired

boolean isExpired()

Determines if this d l file version is expired.

Returns:

true if this d l file version is expired; false otherwise

isPending

boolean isPending()

Determines if this d l file version is pending.

Returns:

true if this d l file version is pending; false otherwise

toEscapedModel

DLFileVersion toEscapedModel()

Gets a copy of this d l file version 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<DLFileVersion>

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<DLFileVersion>

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<DLFileVersion>

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<DLFileVersion>

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<DLFileVersion>

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<DLFileVersion>

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

java.io.Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<DLFileVersion>

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<DLFileVersion>

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<DLFileVersion>

Parameters:

serviceContext - the service context to retrieve the expando bridge attributes from

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

java.lang.Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<DLFileVersion>

Returns:

the shallow clone of this model instance

compareTo

int compareTo(DLFileVersion dlFileVersion)

Specified by:

compareTo in interface java.lang.Comparable<DLFileVersion>

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXmlString

java.lang.String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<DLFileVersion>

Returns:

the XML representation of this model instance