com.liferay.portlet.documentlibrary.model
Interface DLFolderModel

All Superinterfaces:

BaseModel<DLFolder>, Cloneable, Comparable<DLFolder>, Serializable

All Known Subinterfaces:

DLFolder

All Known Implementing Classes:

DLFolderImpl, DLFolderModelImpl, DLFolderWrapper

public interface DLFolderModel
extends BaseModel<DLFolder>

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.

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

See Also:

DLFolder, DLFolderImpl, DLFolderModelImpl

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(DLFolder dlFolder)
long	getCompanyId() Gets the company id of this d l folder.
Date	getCreateDate() Gets the create date of this d l folder.
String	getDescription() Gets the description of this d l folder.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getFolderId() Gets the folder id of this d l folder.
long	getGroupId() Gets the group id of this d l folder.
Date	getLastPostDate() Gets the last post date of this d l folder.
Date	getModifiedDate() Gets the modified date of this d l folder.
String	getName() Gets the name of this d l folder.
long	getParentFolderId() Gets the parent folder id of this d l folder.
long	getPrimaryKey() Gets the primary key of this d l folder.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getUserId() Gets the user id of this d l folder.
String	getUserName() Gets the user name of this d l folder.
String	getUserUuid() Gets the user uuid of this d l folder.
String	getUuid() Gets the uuid of this d l folder.
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 folder.
void	setCreateDate(Date createDate) Sets the create date of this d l folder.
void	setDescription(String description) Sets the description of this d l folder.
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	setFolderId(long folderId) Sets the folder id of this d l folder.
void	setGroupId(long groupId) Sets the group id of this d l folder.
void	setLastPostDate(Date lastPostDate) Sets the last post date of this d l folder.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this d l folder.
void	setName(String name) Sets the name of this d l folder.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setParentFolderId(long parentFolderId) Sets the parent folder id of this d l folder.
void	setPrimaryKey(long pk) Sets the primary key of this d l folder
void	setUserId(long userId) Sets the user id of this d l folder.
void	setUserName(String userName) Sets the user name of this d l folder.
void	setUserUuid(String userUuid) Sets the user uuid of this d l folder.
void	setUuid(String uuid) Sets the uuid of this d l folder.
DLFolder	toEscapedModel() Gets a copy of this d l folder 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 folder.

Returns:

the primary key of this d l folder

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this d l folder

Parameters:

pk - the primary key of this d l folder

getUuid

@AutoEscape
String getUuid()

Gets the uuid of this d l folder.

Returns:

the uuid of this d l folder

setUuid

void setUuid(String uuid)

Sets the uuid of this d l folder.

Parameters:

uuid - the uuid of this d l folder

getFolderId

long getFolderId()

Gets the folder id of this d l folder.

Returns:

the folder id of this d l folder

setFolderId

void setFolderId(long folderId)

Sets the folder id of this d l folder.

Parameters:

folderId - the folder id of this d l folder

getGroupId

long getGroupId()

Gets the group id of this d l folder.

Returns:

the group id of this d l folder

setGroupId

void setGroupId(long groupId)

Sets the group id of this d l folder.

Parameters:

groupId - the group id of this d l folder

getCompanyId

long getCompanyId()

Gets the company id of this d l folder.

Returns:

the company id of this d l folder

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this d l folder.

Parameters:

companyId - the company id of this d l folder

getUserId

long getUserId()

Gets the user id of this d l folder.

Returns:

the user id of this d l folder

setUserId

void setUserId(long userId)

Sets the user id of this d l folder.

Parameters:

userId - the user id of this d l folder

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this d l folder.

Returns:

the user uuid of this d l folder

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this d l folder.

Parameters:

userUuid - the user uuid of this d l folder

getUserName

@AutoEscape
String getUserName()

Gets the user name of this d l folder.

Returns:

the user name of this d l folder

setUserName

void setUserName(String userName)

Sets the user name of this d l folder.

Parameters:

userName - the user name of this d l folder

getCreateDate

Date getCreateDate()

Gets the create date of this d l folder.

Returns:

the create date of this d l folder

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this d l folder.

Parameters:

createDate - the create date of this d l folder

getModifiedDate

Date getModifiedDate()

Gets the modified date of this d l folder.

Returns:

the modified date of this d l folder

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this d l folder.

Parameters:

modifiedDate - the modified date of this d l folder

getParentFolderId

long getParentFolderId()

Gets the parent folder id of this d l folder.

Returns:

the parent folder id of this d l folder

setParentFolderId

void setParentFolderId(long parentFolderId)

Sets the parent folder id of this d l folder.

Parameters:

parentFolderId - the parent folder id of this d l folder

getName

@AutoEscape
String getName()

Gets the name of this d l folder.

Returns:

the name of this d l folder

setName

void setName(String name)

Sets the name of this d l folder.

Parameters:

name - the name of this d l folder

getDescription

@AutoEscape
String getDescription()

Gets the description of this d l folder.

Returns:

the description of this d l folder

setDescription

void setDescription(String description)

Sets the description of this d l folder.

Parameters:

description - the description of this d l folder

getLastPostDate

Date getLastPostDate()

Gets the last post date of this d l folder.

Returns:

the last post date of this d l folder

setLastPostDate

void setLastPostDate(Date lastPostDate)

Sets the last post date of this d l folder.

Parameters:

lastPostDate - the last post date of this d l folder

toEscapedModel

DLFolder toEscapedModel()

Gets a copy of this d l folder 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<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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<DLFolder>

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

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

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

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

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

Returns:

the XML representation of this model instance