Liferay 6.1.2-ce-ga3

com.liferay.portlet.documentlibrary.model
Interface DLFolderModel

All Superinterfaces:
AuditedModel, BaseModel<DLFolder>, ClassedModel, Cloneable, Comparable<DLFolder>, GroupedModel, Serializable
All Known Subinterfaces:
DLFolder
All Known Implementing Classes:
DLFolderWrapper

public interface DLFolderModel
extends BaseModel<DLFolder>, GroupedModel

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

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

See Also:
DLFolder, DLFolderImpl, DLFolderModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(DLFolder dlFolder)
           
 long getCompanyId()
          Returns the company ID of this document library folder.
 Date getCreateDate()
          Returns the create date of this document library folder.
 long getDefaultFileEntryTypeId()
          Returns the default file entry type ID of this document library folder.
 String getDescription()
          Returns the description of this document library folder.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getFolderId()
          Returns the folder ID of this document library folder.
 long getGroupId()
          Returns the group ID of this document library folder.
 Date getLastPostDate()
          Returns the last post date of this document library folder.
 Date getModifiedDate()
          Returns the modified date of this document library folder.
 boolean getMountPoint()
          Returns the mount point of this document library folder.
 String getName()
          Returns the name of this document library folder.
 boolean getOverrideFileEntryTypes()
          Returns the override file entry types of this document library folder.
 long getParentFolderId()
          Returns the parent folder ID of this document library folder.
 long getPrimaryKey()
          Returns the primary key of this document library folder.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getRepositoryId()
          Returns the repository ID of this document library folder.
 long getUserId()
          Returns the user ID of this document library folder.
 String getUserName()
          Returns the user name of this document library folder.
 String getUserUuid()
          Returns the user uuid of this document library folder.
 String getUuid()
          Returns the uuid of this document library folder.
 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 isMountPoint()
          Returns true if this document library folder is mount point.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isOverrideFileEntryTypes()
          Returns true if this document library folder is override file entry types.
 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 document library folder.
 void setCreateDate(Date createDate)
          Sets the create date of this document library folder.
 void setDefaultFileEntryTypeId(long defaultFileEntryTypeId)
          Sets the default file entry type ID of this document library folder.
 void setDescription(String description)
          Sets the description of this document library folder.
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setFolderId(long folderId)
          Sets the folder ID of this document library folder.
 void setGroupId(long groupId)
          Sets the group ID of this document library folder.
 void setLastPostDate(Date lastPostDate)
          Sets the last post date of this document library folder.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this document library folder.
 void setMountPoint(boolean mountPoint)
          Sets whether this document library folder is mount point.
 void setName(String name)
          Sets the name of this document library folder.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setOverrideFileEntryTypes(boolean overrideFileEntryTypes)
          Sets whether this document library folder is override file entry types.
 void setParentFolderId(long parentFolderId)
          Sets the parent folder ID of this document library folder.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this document library folder.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setRepositoryId(long repositoryId)
          Sets the repository ID of this document library folder.
 void setUserId(long userId)
          Sets the user ID of this document library folder.
 void setUserName(String userName)
          Sets the user name of this document library folder.
 void setUserUuid(String userUuid)
          Sets the user uuid of this document library folder.
 void setUuid(String uuid)
          Sets the uuid of this document library folder.
 CacheModel<DLFolder> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 DLFolder toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 DLFolder 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 folder.

Returns:
the primary key of this document library folder

setPrimaryKey

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

Parameters:
primaryKey - the primary key of this document library folder

getUuid

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

Returns:
the uuid of this document library folder

setUuid

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

Parameters:
uuid - the uuid of this document library folder

getFolderId

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

Returns:
the folder ID of this document library folder

setFolderId

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

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

getGroupId

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

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

setGroupId

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

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

getCompanyId

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

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

setCompanyId

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

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

getUserId

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

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

setUserId

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

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

getUserUuid

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

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

setUserUuid

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

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

getUserName

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

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

setUserName

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

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

getCreateDate

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

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

setCreateDate

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

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

getModifiedDate

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

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

setModifiedDate

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

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

getRepositoryId

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

Returns:
the repository ID of this document library folder

setRepositoryId

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

Parameters:
repositoryId - the repository ID of this document library folder

getMountPoint

boolean getMountPoint()
Returns the mount point of this document library folder.

Returns:
the mount point of this document library folder

isMountPoint

boolean isMountPoint()
Returns true if this document library folder is mount point.

Returns:
true if this document library folder is mount point; false otherwise

setMountPoint

void setMountPoint(boolean mountPoint)
Sets whether this document library folder is mount point.

Parameters:
mountPoint - the mount point of this document library folder

getParentFolderId

long getParentFolderId()
Returns the parent folder ID of this document library folder.

Returns:
the parent folder ID of this document library folder

setParentFolderId

void setParentFolderId(long parentFolderId)
Sets the parent folder ID of this document library folder.

Parameters:
parentFolderId - the parent folder ID of this document library folder

getName

@AutoEscape
String getName()
Returns the name of this document library folder.

Returns:
the name of this document library folder

setName

void setName(String name)
Sets the name of this document library folder.

Parameters:
name - the name of this document library folder

getDescription

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

Returns:
the description of this document library folder

setDescription

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

Parameters:
description - the description of this document library folder

getLastPostDate

Date getLastPostDate()
Returns the last post date of this document library folder.

Returns:
the last post date of this document library folder

setLastPostDate

void setLastPostDate(Date lastPostDate)
Sets the last post date of this document library folder.

Parameters:
lastPostDate - the last post date of this document library folder

getDefaultFileEntryTypeId

long getDefaultFileEntryTypeId()
Returns the default file entry type ID of this document library folder.

Returns:
the default file entry type ID of this document library folder

setDefaultFileEntryTypeId

void setDefaultFileEntryTypeId(long defaultFileEntryTypeId)
Sets the default file entry type ID of this document library folder.

Parameters:
defaultFileEntryTypeId - the default file entry type ID of this document library folder

getOverrideFileEntryTypes

boolean getOverrideFileEntryTypes()
Returns the override file entry types of this document library folder.

Returns:
the override file entry types of this document library folder

isOverrideFileEntryTypes

boolean isOverrideFileEntryTypes()
Returns true if this document library folder is override file entry types.

Returns:
true if this document library folder is override file entry types; false otherwise

setOverrideFileEntryTypes

void setOverrideFileEntryTypes(boolean overrideFileEntryTypes)
Sets whether this document library folder is override file entry types.

Parameters:
overrideFileEntryTypes - the override file entry types of this document library folder

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<DLFolder>
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<DLFolder>
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<DLFolder>
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<DLFolder>
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<DLFolder>
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<DLFolder>
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<DLFolder>
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<DLFolder>
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<DLFolder>
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<DLFolder>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(DLFolder dlFolder)
Specified by:
compareTo in interface Comparable<DLFolder>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

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

toUnescapedModel

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

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

Liferay 6.1.2-ce-ga3