com.liferay.portlet.bookmarks.model
Interface BookmarksFolderModel

All Superinterfaces:

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

All Known Subinterfaces:

BookmarksFolder

All Known Implementing Classes:

BookmarksFolderWrapper

public interface BookmarksFolderModel
extends BaseModel<BookmarksFolder>

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

This interface and its corresponding implementation com.liferay.portlet.bookmarks.model.impl.BookmarksFolderModelImpl 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.bookmarks.model.impl.BookmarksFolderImpl.

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

Author:

Brian Wing Shun Chan

See Also:

BookmarksFolder, com.liferay.portlet.bookmarks.model.impl.BookmarksFolderImpl, com.liferay.portlet.bookmarks.model.impl.BookmarksFolderModelImpl

Generated:

Method Summary

java.lang.Object	clone() Creates a shallow clone of this model instance.
int	compareTo(BookmarksFolder bookmarksFolder)
long	getCompanyId() Gets the company id of this bookmarks folder.
java.util.Date	getCreateDate() Gets the create date of this bookmarks folder.
java.lang.String	getDescription() Gets the description of this bookmarks folder.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
long	getFolderId() Gets the folder id of this bookmarks folder.
long	getGroupId() Gets the group id of this bookmarks folder.
java.util.Date	getModifiedDate() Gets the modified date of this bookmarks folder.
java.lang.String	getName() Gets the name of this bookmarks folder.
long	getParentFolderId() Gets the parent folder id of this bookmarks folder.
long	getPrimaryKey() Gets the primary key of this bookmarks folder.
java.io.Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getUserId() Gets the user id of this bookmarks folder.
java.lang.String	getUserUuid() Gets the user uuid of this bookmarks folder.
java.lang.String	getUuid() Gets the uuid of this bookmarks 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 bookmarks folder.
void	setCreateDate(java.util.Date createDate) Sets the create date of this bookmarks folder.
void	setDescription(java.lang.String description) Sets the description of this bookmarks 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 bookmarks folder.
void	setGroupId(long groupId) Sets the group id of this bookmarks folder.
void	setModifiedDate(java.util.Date modifiedDate) Sets the modified date of this bookmarks folder.
void	setName(java.lang.String name) Sets the name of this bookmarks 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 bookmarks folder.
void	setPrimaryKey(long pk) Sets the primary key of this bookmarks folder
void	setUserId(long userId) Sets the user id of this bookmarks folder.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this bookmarks folder.
void	setUuid(java.lang.String uuid) Sets the uuid of this bookmarks folder.
BookmarksFolder	toEscapedModel() Gets a copy of this bookmarks folder 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 bookmarks folder.

Returns:

the primary key of this bookmarks folder

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this bookmarks folder

Parameters:

pk - the primary key of this bookmarks folder

getUuid

@AutoEscape
java.lang.String getUuid()

Gets the uuid of this bookmarks folder.

Returns:

the uuid of this bookmarks folder

setUuid

void setUuid(java.lang.String uuid)

Sets the uuid of this bookmarks folder.

Parameters:

uuid - the uuid of this bookmarks folder

getFolderId

long getFolderId()

Gets the folder id of this bookmarks folder.

Returns:

the folder id of this bookmarks folder

setFolderId

void setFolderId(long folderId)

Sets the folder id of this bookmarks folder.

Parameters:

folderId - the folder id of this bookmarks folder

getGroupId

long getGroupId()

Gets the group id of this bookmarks folder.

Returns:

the group id of this bookmarks folder

setGroupId

void setGroupId(long groupId)

Sets the group id of this bookmarks folder.

Parameters:

groupId - the group id of this bookmarks folder

getCompanyId

long getCompanyId()

Gets the company id of this bookmarks folder.

Returns:

the company id of this bookmarks folder

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this bookmarks folder.

Parameters:

companyId - the company id of this bookmarks folder

getUserId

long getUserId()

Gets the user id of this bookmarks folder.

Returns:

the user id of this bookmarks folder

setUserId

void setUserId(long userId)

Sets the user id of this bookmarks folder.

Parameters:

userId - the user id of this bookmarks folder

getUserUuid

java.lang.String getUserUuid()
                             throws SystemException

Gets the user uuid of this bookmarks folder.

Returns:

the user uuid of this bookmarks folder

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this bookmarks folder.

Parameters:

userUuid - the user uuid of this bookmarks folder

getCreateDate

java.util.Date getCreateDate()

Gets the create date of this bookmarks folder.

Returns:

the create date of this bookmarks folder

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this bookmarks folder.

Parameters:

createDate - the create date of this bookmarks folder

getModifiedDate

java.util.Date getModifiedDate()

Gets the modified date of this bookmarks folder.

Returns:

the modified date of this bookmarks folder

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this bookmarks folder.

Parameters:

modifiedDate - the modified date of this bookmarks folder

getParentFolderId

long getParentFolderId()

Gets the parent folder id of this bookmarks folder.

Returns:

the parent folder id of this bookmarks folder

setParentFolderId

void setParentFolderId(long parentFolderId)

Sets the parent folder id of this bookmarks folder.

Parameters:

parentFolderId - the parent folder id of this bookmarks folder

getName

@AutoEscape
java.lang.String getName()

Gets the name of this bookmarks folder.

Returns:

the name of this bookmarks folder

setName

void setName(java.lang.String name)

Sets the name of this bookmarks folder.

Parameters:

name - the name of this bookmarks folder

getDescription

@AutoEscape
java.lang.String getDescription()

Gets the description of this bookmarks folder.

Returns:

the description of this bookmarks folder

setDescription

void setDescription(java.lang.String description)

Sets the description of this bookmarks folder.

Parameters:

description - the description of this bookmarks folder

toEscapedModel

BookmarksFolder toEscapedModel()

Gets a copy of this bookmarks 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<BookmarksFolder>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(BookmarksFolder bookmarksFolder)

Specified by:

compareTo in interface java.lang.Comparable<BookmarksFolder>

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

Returns:

the XML representation of this model instance