com.liferay.portlet.bookmarks.model
Interface BookmarksEntryModel

All Superinterfaces:

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

All Known Subinterfaces:

BookmarksEntry

All Known Implementing Classes:

BookmarksEntryWrapper

@ProviderType
public interface BookmarksEntryModel
extends BaseModel<BookmarksEntry>, StagedGroupedModel, TrashedModel, WorkflowedModel

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

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

See Also:

BookmarksEntry, BookmarksEntryImpl, BookmarksEntryModelImpl

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(BookmarksEntry bookmarksEntry)
boolean	getApproved() Deprecated. As of 6.1.0, replaced by isApproved()
long	getCompanyId() Returns the company ID of this bookmarks entry.
Date	getCreateDate() Returns the create date of this bookmarks entry.
String	getDescription() Returns the description of this bookmarks entry.
long	getEntryId() Returns the entry ID of this bookmarks entry.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
long	getFolderId() Returns the folder ID of this bookmarks entry.
long	getGroupId() Returns the group ID of this bookmarks entry.
Date	getModifiedDate() Returns the modified date of this bookmarks entry.
String	getName() Returns the name of this bookmarks entry.
long	getPrimaryKey() Returns the primary key of this bookmarks entry.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
int	getPriority() Returns the priority of this bookmarks entry.
long	getResourceBlockId() Returns the resource block ID of this bookmarks entry.
int	getStatus() Returns the status of this bookmarks entry.
long	getStatusByUserId() Returns the status by user ID of this bookmarks entry.
String	getStatusByUserName() Returns the status by user name of this bookmarks entry.
String	getStatusByUserUuid() Returns the status by user uuid of this bookmarks entry.
Date	getStatusDate() Returns the status date of this bookmarks entry.
TrashEntry	getTrashEntry() Returns the trash entry created when this bookmarks entry was moved to the Recycle Bin.
long	getTrashEntryClassPK() Returns the class primary key of the trash entry for this bookmarks entry.
TrashHandler	getTrashHandler() Returns the trash handler for this bookmarks entry.
String	getTreePath() Returns the tree path of this bookmarks entry.
String	getUrl() Returns the url of this bookmarks entry.
long	getUserId() Returns the user ID of this bookmarks entry.
String	getUserName() Returns the user name of this bookmarks entry.
String	getUserUuid() Returns the user uuid of this bookmarks entry.
String	getUuid() Returns the uuid of this bookmarks entry.
int	getVisits() Returns the visits of this bookmarks entry.
int	hashCode()
boolean	isApproved() Returns true if this bookmarks entry is approved.
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isDenied() Returns true if this bookmarks entry is denied.
boolean	isDraft() Returns true if this bookmarks entry is a draft.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isExpired() Returns true if this bookmarks entry is expired.
boolean	isInactive() Returns true if this bookmarks entry is inactive.
boolean	isIncomplete() Returns true if this bookmarks entry is incomplete.
boolean	isInTrash() Returns true if this bookmarks entry is in the Recycle Bin.
boolean	isInTrashContainer() Returns true if the parent of this bookmarks entry 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 entry is pending.
boolean	isScheduled() Returns true if this bookmarks entry 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 entry.
void	setCreateDate(Date createDate) Sets the create date of this bookmarks entry.
void	setDescription(String description) Sets the description of this bookmarks entry.
void	setEntryId(long entryId) Sets the entry ID of this bookmarks entry.
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 entry.
void	setGroupId(long groupId) Sets the group ID of this bookmarks entry.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this bookmarks entry.
void	setName(String name) Sets the name of this bookmarks entry.
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 bookmarks entry.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setPriority(int priority) Sets the priority of this bookmarks entry.
void	setResourceBlockId(long resourceBlockId) Sets the resource block ID of this bookmarks entry.
void	setStatus(int status) Sets the status of this bookmarks entry.
void	setStatusByUserId(long statusByUserId) Sets the status by user ID of this bookmarks entry.
void	setStatusByUserName(String statusByUserName) Sets the status by user name of this bookmarks entry.
void	setStatusByUserUuid(String statusByUserUuid) Sets the status by user uuid of this bookmarks entry.
void	setStatusDate(Date statusDate) Sets the status date of this bookmarks entry.
void	setTreePath(String treePath) Sets the tree path of this bookmarks entry.
void	setUrl(String url) Sets the url of this bookmarks entry.
void	setUserId(long userId) Sets the user ID of this bookmarks entry.
void	setUserName(String userName) Sets the user name of this bookmarks entry.
void	setUserUuid(String userUuid) Sets the user uuid of this bookmarks entry.
void	setUuid(String uuid) Sets the uuid of this bookmarks entry.
void	setVisits(int visits) Sets the visits of this bookmarks entry.
CacheModel<BookmarksEntry>	toCacheModel() Returns a cache model object for this entity used by entity cache.
BookmarksEntry	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
BookmarksEntry	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

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

getStagedModelType

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this bookmarks entry.

Returns:

the primary key of this bookmarks entry

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this bookmarks entry.

Parameters:

primaryKey - the primary key of this bookmarks entry

getUuid

@AutoEscape
String getUuid()

Returns the uuid of this bookmarks entry.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this bookmarks entry

setUuid

void setUuid(String uuid)

Sets the uuid of this bookmarks entry.

Specified by:

setUuid in interface StagedModel

Parameters:

uuid - the uuid of this bookmarks entry

getEntryId

long getEntryId()

Returns the entry ID of this bookmarks entry.

Returns:

the entry ID of this bookmarks entry

setEntryId

void setEntryId(long entryId)

Sets the entry ID of this bookmarks entry.

Parameters:

entryId - the entry ID of this bookmarks entry

getGroupId

long getGroupId()

Returns the group ID of this bookmarks entry.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this bookmarks entry

setGroupId

void setGroupId(long groupId)

Sets the group ID of this bookmarks entry.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this bookmarks entry

getCompanyId

long getCompanyId()

Returns the company ID of this bookmarks entry.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface StagedModel

Returns:

the company ID of this bookmarks entry

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this bookmarks entry.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface StagedModel

Parameters:

companyId - the company ID of this bookmarks entry

getUserId

long getUserId()

Returns the user ID of this bookmarks entry.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this bookmarks entry

setUserId

void setUserId(long userId)

Sets the user ID of this bookmarks entry.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this bookmarks entry

getUserUuid

String getUserUuid()
                   throws SystemException

Returns the user uuid of this bookmarks entry.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this bookmarks entry

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this bookmarks entry.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this bookmarks entry

getUserName

@AutoEscape
String getUserName()

Returns the user name of this bookmarks entry.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this bookmarks entry

setUserName

void setUserName(String userName)

Sets the user name of this bookmarks entry.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this bookmarks entry

getCreateDate

Date getCreateDate()

Returns the create date of this bookmarks entry.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this bookmarks entry

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this bookmarks entry.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this bookmarks entry

getModifiedDate

Date getModifiedDate()

Returns the modified date of this bookmarks entry.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this bookmarks entry

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this bookmarks entry.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Parameters:

modifiedDate - the modified date of this bookmarks entry

getResourceBlockId

long getResourceBlockId()

Returns the resource block ID of this bookmarks entry.

Returns:

the resource block ID of this bookmarks entry

setResourceBlockId

void setResourceBlockId(long resourceBlockId)

Sets the resource block ID of this bookmarks entry.

Parameters:

resourceBlockId - the resource block ID of this bookmarks entry

getFolderId

long getFolderId()

Returns the folder ID of this bookmarks entry.

Returns:

the folder ID of this bookmarks entry

setFolderId

void setFolderId(long folderId)

Sets the folder ID of this bookmarks entry.

Parameters:

folderId - the folder ID of this bookmarks entry

getTreePath

@AutoEscape
String getTreePath()

Returns the tree path of this bookmarks entry.

Returns:

the tree path of this bookmarks entry

setTreePath

void setTreePath(String treePath)

Sets the tree path of this bookmarks entry.

Parameters:

treePath - the tree path of this bookmarks entry

getName

@AutoEscape
String getName()

Returns the name of this bookmarks entry.

Returns:

the name of this bookmarks entry

setName

void setName(String name)

Sets the name of this bookmarks entry.

Parameters:

name - the name of this bookmarks entry

getUrl

@AutoEscape
String getUrl()

Returns the url of this bookmarks entry.

Returns:

the url of this bookmarks entry

setUrl

void setUrl(String url)

Sets the url of this bookmarks entry.

Parameters:

url - the url of this bookmarks entry

getDescription

@AutoEscape
String getDescription()

Returns the description of this bookmarks entry.

Returns:

the description of this bookmarks entry

setDescription

void setDescription(String description)

Sets the description of this bookmarks entry.

Parameters:

description - the description of this bookmarks entry

getVisits

int getVisits()

Returns the visits of this bookmarks entry.

Returns:

the visits of this bookmarks entry

setVisits

void setVisits(int visits)

Sets the visits of this bookmarks entry.

Parameters:

visits - the visits of this bookmarks entry

getPriority

int getPriority()

Returns the priority of this bookmarks entry.

Returns:

the priority of this bookmarks entry

setPriority

void setPriority(int priority)

Sets the priority of this bookmarks entry.

Parameters:

priority - the priority of this bookmarks entry

getStatus

int getStatus()

Returns the status of this bookmarks entry.

Specified by:

getStatus in interface TrashedModel

Specified by:

getStatus in interface WorkflowedModel

Returns:

the status of this bookmarks entry

setStatus

void setStatus(int status)

Sets the status of this bookmarks entry.

Specified by:

setStatus in interface WorkflowedModel

Parameters:

status - the status of this bookmarks entry

getStatusByUserId

long getStatusByUserId()

Returns the status by user ID of this bookmarks entry.

Specified by:

getStatusByUserId in interface WorkflowedModel

Returns:

the status by user ID of this bookmarks entry

setStatusByUserId

void setStatusByUserId(long statusByUserId)

Sets the status by user ID of this bookmarks entry.

Specified by:

setStatusByUserId in interface WorkflowedModel

Parameters:

statusByUserId - the status by user ID of this bookmarks entry

getStatusByUserUuid

String getStatusByUserUuid()
                           throws SystemException

Returns the status by user uuid of this bookmarks entry.

Specified by:

getStatusByUserUuid in interface WorkflowedModel

Returns:

the status by user uuid of this bookmarks entry

Throws:

SystemException - if a system exception occurred

setStatusByUserUuid

void setStatusByUserUuid(String statusByUserUuid)

Sets the status by user uuid of this bookmarks entry.

Specified by:

setStatusByUserUuid in interface WorkflowedModel

Parameters:

statusByUserUuid - the status by user uuid of this bookmarks entry

getStatusByUserName

@AutoEscape
String getStatusByUserName()

Returns the status by user name of this bookmarks entry.

Specified by:

getStatusByUserName in interface WorkflowedModel

Returns:

the status by user name of this bookmarks entry

setStatusByUserName

void setStatusByUserName(String statusByUserName)

Sets the status by user name of this bookmarks entry.

Specified by:

setStatusByUserName in interface WorkflowedModel

Parameters:

statusByUserName - the status by user name of this bookmarks entry

getStatusDate

Date getStatusDate()

Returns the status date of this bookmarks entry.

Specified by:

getStatusDate in interface WorkflowedModel

Returns:

the status date of this bookmarks entry

setStatusDate

void setStatusDate(Date statusDate)

Sets the status date of this bookmarks entry.

Specified by:

setStatusDate in interface WorkflowedModel

Parameters:

statusDate - the status date of this bookmarks entry

getTrashEntry

TrashEntry getTrashEntry()
                         throws PortalException,
                                SystemException

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

Specified by:

getTrashEntry in interface TrashedModel

Returns:

the trash entry created when this bookmarks entry 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 entry.

Specified by:

getTrashEntryClassPK in interface TrashedModel

Returns:

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

getTrashHandler

TrashHandler getTrashHandler()

Returns the trash handler for this bookmarks entry.

Specified by:

getTrashHandler in interface TrashedModel

Returns:

the trash handler for this bookmarks entry

isInTrash

boolean isInTrash()

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

Specified by:

isInTrash in interface TrashedModel

Returns:

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

isInTrashContainer

boolean isInTrashContainer()

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

Specified by:

isInTrashContainer in interface TrashedModel

Returns:

true if the parent of this bookmarks entry 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 entry is approved.

Specified by:

isApproved in interface WorkflowedModel

Returns:

true if this bookmarks entry is approved; false otherwise

isDenied

boolean isDenied()

Returns true if this bookmarks entry is denied.

Specified by:

isDenied in interface WorkflowedModel

Returns:

true if this bookmarks entry is denied; false otherwise

isDraft

boolean isDraft()

Returns true if this bookmarks entry is a draft.

Specified by:

isDraft in interface WorkflowedModel

Returns:

true if this bookmarks entry is a draft; false otherwise

isExpired

boolean isExpired()

Returns true if this bookmarks entry is expired.

Specified by:

isExpired in interface WorkflowedModel

Returns:

true if this bookmarks entry is expired; false otherwise

isInactive

boolean isInactive()

Returns true if this bookmarks entry is inactive.

Specified by:

isInactive in interface WorkflowedModel

Returns:

true if this bookmarks entry is inactive; false otherwise

isIncomplete

boolean isIncomplete()

Returns true if this bookmarks entry is incomplete.

Specified by:

isIncomplete in interface WorkflowedModel

Returns:

true if this bookmarks entry is incomplete; false otherwise

isPending

boolean isPending()

Returns true if this bookmarks entry is pending.

Specified by:

isPending in interface WorkflowedModel

Returns:

true if this bookmarks entry is pending; false otherwise

isScheduled

boolean isScheduled()

Returns true if this bookmarks entry is scheduled.

Specified by:

isScheduled in interface WorkflowedModel

Returns:

true if this bookmarks entry 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<BookmarksEntry>

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

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

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

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

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

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

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

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

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<BookmarksEntry>

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

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

Specified by:

clone in interface StagedModel

Returns:

the shallow clone of this model instance

compareTo

int compareTo(BookmarksEntry bookmarksEntry)

Specified by:

compareTo in interface Comparable<BookmarksEntry>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

CacheModel<BookmarksEntry> toCacheModel()

Description copied from interface: BaseModel

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

Specified by:

toCacheModel in interface BaseModel<BookmarksEntry>

Returns:

the cache model object

toEscapedModel

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

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

BookmarksEntry toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<BookmarksEntry>

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

Returns:

the XML representation of this model instance