Liferay 6.1.2-ce-ga3

com.liferay.portlet.documentlibrary.model
Interface DLFileVersionModel

All Superinterfaces:
AuditedModel, BaseModel<DLFileVersion>, ClassedModel, Cloneable, Comparable<DLFileVersion>, GroupedModel, Serializable, WorkflowedModel
All Known Subinterfaces:
DLFileVersion
All Known Implementing Classes:
DLFileVersionWrapper

public interface DLFileVersionModel
extends BaseModel<DLFileVersion>, GroupedModel, WorkflowedModel

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 DLFileVersionModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in DLFileVersionImpl.

See Also:
DLFileVersion, DLFileVersionImpl, DLFileVersionModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(DLFileVersion dlFileVersion)
           
 boolean getApproved()
          Deprecated. Renamed to isApproved()
 String getChangeLog()
          Returns the change log of this document library file version.
 long getCompanyId()
          Returns the company ID of this document library file version.
 Date getCreateDate()
          Returns the create date of this document library file version.
 String getDescription()
          Returns the description of this document library file version.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 String getExtension()
          Returns the extension of this document library file version.
 String getExtraSettings()
          Returns the extra settings of this document library file version.
 long getFileEntryId()
          Returns the file entry ID of this document library file version.
 long getFileEntryTypeId()
          Returns the file entry type ID of this document library file version.
 long getFileVersionId()
          Returns the file version ID of this document library file version.
 long getFolderId()
          Returns the folder ID of this document library file version.
 long getGroupId()
          Returns the group ID of this document library file version.
 String getMimeType()
          Returns the mime type of this document library file version.
 Date getModifiedDate()
          Returns the modified date of this document library file version.
 long getPrimaryKey()
          Returns the primary key of this document library file version.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getRepositoryId()
          Returns the repository ID of this document library file version.
 long getSize()
          Returns the size of this document library file version.
 int getStatus()
          Returns the status of this document library file version.
 long getStatusByUserId()
          Returns the status by user ID of this document library file version.
 String getStatusByUserName()
          Returns the status by user name of this document library file version.
 String getStatusByUserUuid()
          Returns the status by user uuid of this document library file version.
 Date getStatusDate()
          Returns the status date of this document library file version.
 String getTitle()
          Returns the title of this document library file version.
 long getUserId()
          Returns the user ID of this document library file version.
 String getUserName()
          Returns the user name of this document library file version.
 String getUserUuid()
          Returns the user uuid of this document library file version.
 String getUuid()
          Returns the uuid of this document library file version.
 String getVersion()
          Returns the version of this document library file version.
 int hashCode()
           
 boolean isApproved()
          Returns true if this document library file version is approved.
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isDenied()
          Returns true if this document library file version is denied.
 boolean isDraft()
          Returns true if this document library file version is a draft.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isExpired()
          Returns true if this document library file version is expired.
 boolean isInactive()
          Returns true if this document library file version is inactive.
 boolean isIncomplete()
          Returns true if this document library file version is incomplete.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isPending()
          Returns true if this document library file version is pending.
 boolean isScheduled()
          Returns true if this document library file version is scheduled.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setChangeLog(String changeLog)
          Sets the change log of this document library file version.
 void setCompanyId(long companyId)
          Sets the company ID of this document library file version.
 void setCreateDate(Date createDate)
          Sets the create date of this document library file version.
 void setDescription(String description)
          Sets the description of this document library file version.
 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 version.
 void setExtraSettings(String extraSettings)
          Sets the extra settings of this document library file version.
 void setFileEntryId(long fileEntryId)
          Sets the file entry ID of this document library file version.
 void setFileEntryTypeId(long fileEntryTypeId)
          Sets the file entry type ID of this document library file version.
 void setFileVersionId(long fileVersionId)
          Sets the file version ID of this document library file version.
 void setFolderId(long folderId)
          Sets the folder ID of this document library file version.
 void setGroupId(long groupId)
          Sets the group ID of this document library file version.
 void setMimeType(String mimeType)
          Sets the mime type of this document library file version.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this document library file version.
 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 version.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setRepositoryId(long repositoryId)
          Sets the repository ID of this document library file version.
 void setSize(long size)
          Sets the size of this document library file version.
 void setStatus(int status)
          Sets the status of this document library file version.
 void setStatusByUserId(long statusByUserId)
          Sets the status by user ID of this document library file version.
 void setStatusByUserName(String statusByUserName)
          Sets the status by user name of this document library file version.
 void setStatusByUserUuid(String statusByUserUuid)
          Sets the status by user uuid of this document library file version.
 void setStatusDate(Date statusDate)
          Sets the status date of this document library file version.
 void setTitle(String title)
          Sets the title of this document library file version.
 void setUserId(long userId)
          Sets the user ID of this document library file version.
 void setUserName(String userName)
          Sets the user name of this document library file version.
 void setUserUuid(String userUuid)
          Sets the user uuid of this document library file version.
 void setUuid(String uuid)
          Sets the uuid of this document library file version.
 void setVersion(String version)
          Sets the version of this document library file version.
 CacheModel<DLFileVersion> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 DLFileVersion toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 DLFileVersion 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
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this document library file version.

Returns:
the primary key of this document library file version

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this document library file version.

Parameters:
primaryKey - the primary key of this document library file version

getUuid

@AutoEscape
String getUuid()
Returns the uuid of this document library file version.

Returns:
the uuid of this document library file version

setUuid

void setUuid(String uuid)
Sets the uuid of this document library file version.

Parameters:
uuid - the uuid of this document library file version

getFileVersionId

long getFileVersionId()
Returns the file version ID of this document library file version.

Returns:
the file version ID of this document library file version

setFileVersionId

void setFileVersionId(long fileVersionId)
Sets the file version ID of this document library file version.

Parameters:
fileVersionId - the file version ID of this document library file version

getGroupId

long getGroupId()
Returns the group ID of this document library file version.

Specified by:
getGroupId in interface GroupedModel
Returns:
the group ID of this document library file version

setGroupId

void setGroupId(long groupId)
Sets the group ID of this document library file version.

Specified by:
setGroupId in interface GroupedModel
Parameters:
groupId - the group ID of this document library file version

getCompanyId

long getCompanyId()
Returns the company ID of this document library file version.

Specified by:
getCompanyId in interface AuditedModel
Returns:
the company ID of this document library file version

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this document library file version.

Specified by:
setCompanyId in interface AuditedModel
Parameters:
companyId - the company ID of this document library file version

getUserId

long getUserId()
Returns the user ID of this document library file version.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this document library file version

setUserId

void setUserId(long userId)
Sets the user ID of this document library file version.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this document library file version

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this document library file version.

Specified by:
getUserUuid in interface AuditedModel
Returns:
the user uuid of this document library file version
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this document library file version.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this document library file version

getUserName

@AutoEscape
String getUserName()
Returns the user name of this document library file version.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this document library file version

setUserName

void setUserName(String userName)
Sets the user name of this document library file version.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this document library file version

getCreateDate

Date getCreateDate()
Returns the create date of this document library file version.

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this document library file version

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this document library file version.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this document library file version

getModifiedDate

Date getModifiedDate()
Returns the modified date of this document library file version.

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this document library file version

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this document library file version.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this document library file version

getRepositoryId

long getRepositoryId()
Returns the repository ID of this document library file version.

Returns:
the repository ID of this document library file version

setRepositoryId

void setRepositoryId(long repositoryId)
Sets the repository ID of this document library file version.

Parameters:
repositoryId - the repository ID of this document library file version

getFolderId

long getFolderId()
Returns the folder ID of this document library file version.

Returns:
the folder ID of this document library file version

setFolderId

void setFolderId(long folderId)
Sets the folder ID of this document library file version.

Parameters:
folderId - the folder ID of this document library file version

getFileEntryId

long getFileEntryId()
Returns the file entry ID of this document library file version.

Returns:
the file entry ID of this document library file version

setFileEntryId

void setFileEntryId(long fileEntryId)
Sets the file entry ID of this document library file version.

Parameters:
fileEntryId - the file entry ID of this document library file version

getExtension

@AutoEscape
String getExtension()
Returns the extension of this document library file version.

Returns:
the extension of this document library file version

setExtension

void setExtension(String extension)
Sets the extension of this document library file version.

Parameters:
extension - the extension of this document library file version

getMimeType

@AutoEscape
String getMimeType()
Returns the mime type of this document library file version.

Returns:
the mime type of this document library file version

setMimeType

void setMimeType(String mimeType)
Sets the mime type of this document library file version.

Parameters:
mimeType - the mime type of this document library file version

getTitle

@AutoEscape
String getTitle()
Returns the title of this document library file version.

Returns:
the title of this document library file version

setTitle

void setTitle(String title)
Sets the title of this document library file version.

Parameters:
title - the title of this document library file version

getDescription

@AutoEscape
String getDescription()
Returns the description of this document library file version.

Returns:
the description of this document library file version

setDescription

void setDescription(String description)
Sets the description of this document library file version.

Parameters:
description - the description of this document library file version

getChangeLog

@AutoEscape
String getChangeLog()
Returns the change log of this document library file version.

Returns:
the change log of this document library file version

setChangeLog

void setChangeLog(String changeLog)
Sets the change log of this document library file version.

Parameters:
changeLog - the change log of this document library file version

getExtraSettings

@AutoEscape
String getExtraSettings()
Returns the extra settings of this document library file version.

Returns:
the extra settings of this document library file version

setExtraSettings

void setExtraSettings(String extraSettings)
Sets the extra settings of this document library file version.

Parameters:
extraSettings - the extra settings of this document library file version

getFileEntryTypeId

long getFileEntryTypeId()
Returns the file entry type ID of this document library file version.

Returns:
the file entry type ID of this document library file version

setFileEntryTypeId

void setFileEntryTypeId(long fileEntryTypeId)
Sets the file entry type ID of this document library file version.

Parameters:
fileEntryTypeId - the file entry type ID of this document library file version

getVersion

@AutoEscape
String getVersion()
Returns the version of this document library file version.

Returns:
the version of this document library file version

setVersion

void setVersion(String version)
Sets the version of this document library file version.

Parameters:
version - the version of this document library file version

getSize

long getSize()
Returns the size of this document library file version.

Returns:
the size of this document library file version

setSize

void setSize(long size)
Sets the size of this document library file version.

Parameters:
size - the size of this document library file version

getStatus

int getStatus()
Returns the status of this document library file version.

Specified by:
getStatus in interface WorkflowedModel
Returns:
the status of this document library file version

setStatus

void setStatus(int status)
Sets the status of this document library file version.

Specified by:
setStatus in interface WorkflowedModel
Parameters:
status - the status of this document library file version

getStatusByUserId

long getStatusByUserId()
Returns the status by user ID of this document library file version.

Specified by:
getStatusByUserId in interface WorkflowedModel
Returns:
the status by user ID of this document library file version

setStatusByUserId

void setStatusByUserId(long statusByUserId)
Sets the status by user ID of this document library file version.

Specified by:
setStatusByUserId in interface WorkflowedModel
Parameters:
statusByUserId - the status by user ID of this document library file version

getStatusByUserUuid

String getStatusByUserUuid()
                           throws SystemException
Returns the status by user uuid of this document library file version.

Returns:
the status by user uuid of this document library file version
Throws:
SystemException - if a system exception occurred

setStatusByUserUuid

void setStatusByUserUuid(String statusByUserUuid)
Sets the status by user uuid of this document library file version.

Parameters:
statusByUserUuid - the status by user uuid of this document library file version

getStatusByUserName

@AutoEscape
String getStatusByUserName()
Returns the status by user name of this document library file version.

Specified by:
getStatusByUserName in interface WorkflowedModel
Returns:
the status by user name of this document library file version

setStatusByUserName

void setStatusByUserName(String statusByUserName)
Sets the status by user name of this document library file version.

Specified by:
setStatusByUserName in interface WorkflowedModel
Parameters:
statusByUserName - the status by user name of this document library file version

getStatusDate

Date getStatusDate()
Returns the status date of this document library file version.

Specified by:
getStatusDate in interface WorkflowedModel
Returns:
the status date of this document library file version

setStatusDate

void setStatusDate(Date statusDate)
Sets the status date of this document library file version.

Specified by:
setStatusDate in interface WorkflowedModel
Parameters:
statusDate - the status date of this document library file version

getApproved

boolean getApproved()
Deprecated. Renamed to isApproved()


isApproved

boolean isApproved()
Returns true if this document library file version is approved.

Specified by:
isApproved in interface WorkflowedModel
Returns:
true if this document library file version is approved; false otherwise

isDenied

boolean isDenied()
Returns true if this document library file version is denied.

Returns:
true if this document library file version is denied; false otherwise

isDraft

boolean isDraft()
Returns true if this document library file version is a draft.

Specified by:
isDraft in interface WorkflowedModel
Returns:
true if this document library file version is a draft; false otherwise

isExpired

boolean isExpired()
Returns true if this document library file version is expired.

Specified by:
isExpired in interface WorkflowedModel
Returns:
true if this document library file version is expired; false otherwise

isInactive

boolean isInactive()
Returns true if this document library file version is inactive.

Returns:
true if this document library file version is inactive; false otherwise

isIncomplete

boolean isIncomplete()
Returns true if this document library file version is incomplete.

Returns:
true if this document library file version is incomplete; false otherwise

isPending

boolean isPending()
Returns true if this document library file version is pending.

Specified by:
isPending in interface WorkflowedModel
Returns:
true if this document library file version is pending; false otherwise

isScheduled

boolean isScheduled()
Returns true if this document library file version is scheduled.

Returns:
true if this document library file version is scheduled; false otherwise

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<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
Returns true 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
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<DLFileVersion>
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<DLFileVersion>
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<DLFileVersion>
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<DLFileVersion>
Specified by:
getExpandoBridge in interface ClassedModel
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
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<DLFileVersion>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(DLFileVersion dlFileVersion)
Specified by:
compareTo in interface Comparable<DLFileVersion>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

CacheModel<DLFileVersion> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<DLFileVersion>
Returns:
the cache model object

toEscapedModel

DLFileVersion 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<DLFileVersion>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

DLFileVersion toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<DLFileVersion>

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<DLFileVersion>
Returns:
the XML representation of this model instance

Liferay 6.1.2-ce-ga3