com.liferay.portlet.bookmarks.model
Interface BookmarksFolderModel

All Superinterfaces:

AuditedModel, BaseModel<BookmarksFolder>, ClassedModel, Cloneable, Comparable<BookmarksFolder>, ContainerModel, GroupedModel, Serializable, StagedGroupedModel, StagedModel, TrashedModel, WorkflowedModel

All Known Subinterfaces:

BookmarksFolder

All Known Implementing Classes:

BookmarksFolderWrapper

@ProviderType
public interface BookmarksFolderModel
extends BaseModel<BookmarksFolder>, ContainerModel, StagedGroupedModel, TrashedModel, WorkflowedModel

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

See Also:

BookmarksFolder, BookmarksFolderImpl, BookmarksFolderModelImpl

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(BookmarksFolder bookmarksFolder)
boolean	getApproved() Deprecated. As of 6.1.0, replaced by isApproved()
long	getCompanyId() Returns the company ID of this bookmarks folder.
long	getContainerModelId() Returns the container model ID of this bookmarks folder.
String	getContainerModelName() Returns the container name of this bookmarks folder.
Date	getCreateDate() Returns the create date of this bookmarks folder.
String	getDescription() Returns the description of this bookmarks folder.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
long	getFolderId() Returns the folder ID of this bookmarks folder.
long	getGroupId() Returns the group ID of this bookmarks folder.
Date	getModifiedDate() Returns the modified date of this bookmarks folder.
String	getName() Returns the name of this bookmarks folder.
long	getParentContainerModelId() Returns the parent container model ID of this bookmarks folder.
long	getParentFolderId() Returns the parent folder ID of this bookmarks folder.
long	getPrimaryKey() Returns the primary key of this bookmarks folder.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
long	getResourceBlockId() Returns the resource block ID of this bookmarks folder.
int	getStatus() Returns the status of this bookmarks folder.
long	getStatusByUserId() Returns the status by user ID of this bookmarks folder.
String	getStatusByUserName() Returns the status by user name of this bookmarks folder.
String	getStatusByUserUuid() Returns the status by user uuid of this bookmarks folder.
Date	getStatusDate() Returns the status date of this bookmarks folder.
TrashEntry	getTrashEntry() Returns the trash entry created when this bookmarks folder was moved to the Recycle Bin.
long	getTrashEntryClassPK() Returns the class primary key of the trash entry for this bookmarks folder.
TrashHandler	getTrashHandler() Returns the trash handler for this bookmarks folder.
String	getTreePath() Returns the tree path of this bookmarks folder.
long	getUserId() Returns the user ID of this bookmarks folder.
String	getUserName() Returns the user name of this bookmarks folder.
String	getUserUuid() Returns the user uuid of this bookmarks folder.
String	getUuid() Returns the uuid of this bookmarks folder.
int	hashCode()
boolean	isApproved() Returns true if this bookmarks folder is approved.
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isDenied() Returns true if this bookmarks folder is denied.
boolean	isDraft() Returns true if this bookmarks folder is a draft.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isExpired() Returns true if this bookmarks folder is expired.
boolean	isInactive() Returns true if this bookmarks folder is inactive.
boolean	isIncomplete() Returns true if this bookmarks folder is incomplete.
boolean	isInTrash() Returns true if this bookmarks folder is in the Recycle Bin.
boolean	isInTrashContainer() Returns true if the parent of this bookmarks folder is in the Recycle Bin.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
boolean	isPending() Returns true if this bookmarks folder is pending.
boolean	isScheduled() Returns true if this bookmarks folder is scheduled.
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	setContainerModelId(long containerModelId) Sets the container model ID of this bookmarks folder.
void	setCreateDate(Date createDate) Sets the create date of this bookmarks folder.
void	setDescription(String description) Sets the description of this bookmarks folder.
void	setExpandoBridgeAttributes(BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
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(Date modifiedDate) Sets the modified date of this bookmarks folder.
void	setName(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	setParentContainerModelId(long parentContainerModelId) Sets the parent container model ID of this bookmarks folder.
void	setParentFolderId(long parentFolderId) Sets the parent folder ID of this bookmarks folder.
void	setPrimaryKey(long primaryKey) Sets the primary key of this bookmarks folder.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setResourceBlockId(long resourceBlockId) Sets the resource block ID of this bookmarks folder.
void	setStatus(int status) Sets the status of this bookmarks folder.
void	setStatusByUserId(long statusByUserId) Sets the status by user ID of this bookmarks folder.
void	setStatusByUserName(String statusByUserName) Sets the status by user name of this bookmarks folder.
void	setStatusByUserUuid(String statusByUserUuid) Sets the status by user uuid of this bookmarks folder.
void	setStatusDate(Date statusDate) Sets the status date of this bookmarks folder.
void	setTreePath(String treePath) Sets the tree path of this bookmarks folder.
void	setUserId(long userId) Sets the user ID of this bookmarks folder.
void	setUserName(String userName) Sets the user name of this bookmarks folder.
void	setUserUuid(String userUuid) Sets the user uuid of this bookmarks folder.
void	setUuid(String uuid) Sets the uuid of this bookmarks folder.
CacheModel<BookmarksFolder>	toCacheModel() Returns a cache model object for this entity used by entity cache.
BookmarksFolder	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
BookmarksFolder	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.ContainerModel

getModelClass, getModelClassName

Methods inherited from interface com.liferay.portal.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface com.liferay.portal.model.StagedModel

getStagedModelType

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this bookmarks folder.

Returns:

the primary key of this bookmarks folder

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this bookmarks folder.

Parameters:

primaryKey - the primary key of this bookmarks folder

getUuid

@AutoEscape
String getUuid()

Returns the uuid of this bookmarks folder.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this bookmarks folder

setUuid

void setUuid(String uuid)

Sets the uuid of this bookmarks folder.

Specified by:

setUuid in interface StagedModel

Parameters:

uuid - the uuid of this bookmarks folder

getFolderId

long getFolderId()

Returns 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()

Returns the group ID of this bookmarks folder.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this bookmarks folder

setGroupId

void setGroupId(long groupId)

Sets the group ID of this bookmarks folder.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this bookmarks folder

getCompanyId

long getCompanyId()

Returns the company ID of this bookmarks folder.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface StagedModel

Returns:

the company ID of this bookmarks folder

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this bookmarks folder.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface StagedModel

Parameters:

companyId - the company ID of this bookmarks folder

getUserId

long getUserId()

Returns the user ID of this bookmarks folder.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this bookmarks folder

setUserId

void setUserId(long userId)

Sets the user ID of this bookmarks folder.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this bookmarks folder

getUserUuid

String getUserUuid()
                   throws SystemException

Returns the user uuid of this bookmarks folder.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this bookmarks folder

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this bookmarks folder.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this bookmarks folder

getUserName

@AutoEscape
String getUserName()

Returns the user name of this bookmarks folder.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this bookmarks folder

setUserName

void setUserName(String userName)

Sets the user name of this bookmarks folder.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this bookmarks folder

getCreateDate

Date getCreateDate()

Returns the create date of this bookmarks folder.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this bookmarks folder

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this bookmarks folder.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this bookmarks folder

getModifiedDate

Date getModifiedDate()

Returns the modified date of this bookmarks folder.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this bookmarks folder

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this bookmarks folder.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Parameters:

modifiedDate - the modified date of this bookmarks folder

getResourceBlockId

long getResourceBlockId()

Returns the resource block ID of this bookmarks folder.

Returns:

the resource block ID of this bookmarks folder

setResourceBlockId

void setResourceBlockId(long resourceBlockId)

Sets the resource block ID of this bookmarks folder.

Parameters:

resourceBlockId - the resource block ID of this bookmarks folder

getParentFolderId

long getParentFolderId()

Returns 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

getTreePath

@AutoEscape
String getTreePath()

Returns the tree path of this bookmarks folder.

Returns:

the tree path of this bookmarks folder

setTreePath

void setTreePath(String treePath)

Sets the tree path of this bookmarks folder.

Parameters:

treePath - the tree path of this bookmarks folder

getName

@AutoEscape
String getName()

Returns the name of this bookmarks folder.

Returns:

the name of this bookmarks folder

setName

void setName(String name)

Sets the name of this bookmarks folder.

Parameters:

name - the name of this bookmarks folder

getDescription

@AutoEscape
String getDescription()

Returns the description of this bookmarks folder.

Returns:

the description of this bookmarks folder

setDescription

void setDescription(String description)

Sets the description of this bookmarks folder.

Parameters:

description - the description of this bookmarks folder

getStatus

int getStatus()

Returns the status of this bookmarks folder.

Specified by:

getStatus in interface TrashedModel

Specified by:

getStatus in interface WorkflowedModel

Returns:

the status of this bookmarks folder

setStatus

void setStatus(int status)

Sets the status of this bookmarks folder.

Specified by:

setStatus in interface WorkflowedModel

Parameters:

status - the status of this bookmarks folder

getStatusByUserId

long getStatusByUserId()

Returns the status by user ID of this bookmarks folder.

Specified by:

getStatusByUserId in interface WorkflowedModel

Returns:

the status by user ID of this bookmarks folder

setStatusByUserId

void setStatusByUserId(long statusByUserId)

Sets the status by user ID of this bookmarks folder.

Specified by:

setStatusByUserId in interface WorkflowedModel

Parameters:

statusByUserId - the status by user ID of this bookmarks folder

getStatusByUserUuid

String getStatusByUserUuid()
                           throws SystemException

Returns the status by user uuid of this bookmarks folder.

Specified by:

getStatusByUserUuid in interface WorkflowedModel

Returns:

the status by user uuid of this bookmarks folder

Throws:

SystemException - if a system exception occurred

setStatusByUserUuid

void setStatusByUserUuid(String statusByUserUuid)

Sets the status by user uuid of this bookmarks folder.

Specified by:

setStatusByUserUuid in interface WorkflowedModel

Parameters:

statusByUserUuid - the status by user uuid of this bookmarks folder

getStatusByUserName

@AutoEscape
String getStatusByUserName()

Returns the status by user name of this bookmarks folder.

Specified by:

getStatusByUserName in interface WorkflowedModel

Returns:

the status by user name of this bookmarks folder

setStatusByUserName

void setStatusByUserName(String statusByUserName)

Sets the status by user name of this bookmarks folder.

Specified by:

setStatusByUserName in interface WorkflowedModel

Parameters:

statusByUserName - the status by user name of this bookmarks folder

getStatusDate

Date getStatusDate()

Returns the status date of this bookmarks folder.

Specified by:

getStatusDate in interface WorkflowedModel

Returns:

the status date of this bookmarks folder

setStatusDate

void setStatusDate(Date statusDate)

Sets the status date of this bookmarks folder.

Specified by:

setStatusDate in interface WorkflowedModel

Parameters:

statusDate - the status date of this bookmarks folder

getTrashEntry

TrashEntry getTrashEntry()
                         throws PortalException,
                                SystemException

Returns the trash entry created when this bookmarks folder was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this bookmarks folder.

Specified by:

getTrashEntry in interface TrashedModel

Returns:

the trash entry created when this bookmarks folder was moved to the Recycle Bin

Throws:

SystemException - if a system exception occurred

PortalException

getTrashEntryClassPK

long getTrashEntryClassPK()

Returns the class primary key of the trash entry for this bookmarks folder.

Specified by:

getTrashEntryClassPK in interface TrashedModel

Returns:

the class primary key of the trash entry for this bookmarks folder

getTrashHandler

TrashHandler getTrashHandler()

Returns the trash handler for this bookmarks folder.

Specified by:

getTrashHandler in interface TrashedModel

Returns:

the trash handler for this bookmarks folder

isInTrash

boolean isInTrash()

Returns true if this bookmarks folder is in the Recycle Bin.

Specified by:

isInTrash in interface TrashedModel

Returns:

true if this bookmarks folder is in the Recycle Bin; false otherwise

isInTrashContainer

boolean isInTrashContainer()

Returns true if the parent of this bookmarks folder is in the Recycle Bin.

Specified by:

isInTrashContainer in interface TrashedModel

Returns:

true if the parent of this bookmarks folder is in the Recycle Bin; false otherwise

Throws:

SystemException - if a system exception occurred

getApproved

boolean getApproved()

Deprecated. As of 6.1.0, replaced by isApproved()

Specified by:

getApproved in interface WorkflowedModel

isApproved

boolean isApproved()

Returns true if this bookmarks folder is approved.

Specified by:

isApproved in interface WorkflowedModel

Returns:

true if this bookmarks folder is approved; false otherwise

isDenied

boolean isDenied()

Returns true if this bookmarks folder is denied.

Specified by:

isDenied in interface WorkflowedModel

Returns:

true if this bookmarks folder is denied; false otherwise

isDraft

boolean isDraft()

Returns true if this bookmarks folder is a draft.

Specified by:

isDraft in interface WorkflowedModel

Returns:

true if this bookmarks folder is a draft; false otherwise

isExpired

boolean isExpired()

Returns true if this bookmarks folder is expired.

Specified by:

isExpired in interface WorkflowedModel

Returns:

true if this bookmarks folder is expired; false otherwise

isInactive

boolean isInactive()

Returns true if this bookmarks folder is inactive.

Specified by:

isInactive in interface WorkflowedModel

Returns:

true if this bookmarks folder is inactive; false otherwise

isIncomplete

boolean isIncomplete()

Returns true if this bookmarks folder is incomplete.

Specified by:

isIncomplete in interface WorkflowedModel

Returns:

true if this bookmarks folder is incomplete; false otherwise

isPending

boolean isPending()

Returns true if this bookmarks folder is pending.

Specified by:

isPending in interface WorkflowedModel

Returns:

true if this bookmarks folder is pending; false otherwise

isScheduled

boolean isScheduled()

Returns true if this bookmarks folder is scheduled.

Specified by:

isScheduled in interface WorkflowedModel

Returns:

true if this bookmarks folder is scheduled; false otherwise

getContainerModelId

long getContainerModelId()

Returns the container model ID of this bookmarks folder.

Specified by:

getContainerModelId in interface ContainerModel

Returns:

the container model ID of this bookmarks folder

setContainerModelId

void setContainerModelId(long containerModelId)

Sets the container model ID of this bookmarks folder.

Specified by:

setContainerModelId in interface ContainerModel

Parameters:

containerModelId - the container model ID of this bookmarks folder

getContainerModelName

String getContainerModelName()

Returns the container name of this bookmarks folder.

Specified by:

getContainerModelName in interface ContainerModel

Returns:

the container name of this bookmarks folder

getParentContainerModelId

long getParentContainerModelId()

Returns the parent container model ID of this bookmarks folder.

Specified by:

getParentContainerModelId in interface ContainerModel

Returns:

the parent container model ID of this bookmarks folder

setParentContainerModelId

void setParentContainerModelId(long parentContainerModelId)

Sets the parent container model ID of this bookmarks folder.

Specified by:

setParentContainerModelId in interface ContainerModel

Parameters:

parentContainerModelId - the parent container model ID of this bookmarks 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<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

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

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<BookmarksFolder>

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

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

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

Specified by:

getExpandoBridge in interface ClassedModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<BookmarksFolder>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<BookmarksFolder>

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

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

Specified by:

clone in interface StagedModel

Returns:

the shallow clone of this model instance

compareTo

int compareTo(BookmarksFolder bookmarksFolder)

Specified by:

compareTo in interface Comparable<BookmarksFolder>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

CacheModel<BookmarksFolder> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<BookmarksFolder>

Returns:

the cache model object

toEscapedModel

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

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

BookmarksFolder toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<BookmarksFolder>

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

Returns:

the XML representation of this model instance