com.liferay.portlet.wiki.model
Interface WikiPageModel

All Superinterfaces:

BaseModel<WikiPage>, Cloneable, Comparable<WikiPage>, Serializable

All Known Subinterfaces:

WikiPage

All Known Implementing Classes:

WikiPageImpl, WikiPageModelImpl, WikiPageWrapper

public interface WikiPageModel
extends BaseModel<WikiPage>

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

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

Never modify or reference this interface directly. All methods that expect a wiki page model instance should use the WikiPage interface instead.

See Also:

WikiPage, WikiPageImpl, WikiPageModelImpl

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(WikiPage wikiPage)
long	getCompanyId() Gets the company id of this wiki page.
String	getContent() Gets the content of this wiki page.
Date	getCreateDate() Gets the create date of this wiki page.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
String	getFormat() Gets the format of this wiki page.
long	getGroupId() Gets the group id of this wiki page.
boolean	getHead() Gets the head of this wiki page.
boolean	getMinorEdit() Gets the minor edit of this wiki page.
Date	getModifiedDate() Gets the modified date of this wiki page.
long	getNodeId() Gets the node id of this wiki page.
long	getPageId() Gets the page id of this wiki page.
String	getParentTitle() Gets the parent title of this wiki page.
long	getPrimaryKey() Gets the primary key of this wiki page.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
String	getRedirectTitle() Gets the redirect title of this wiki page.
long	getResourcePrimKey() Gets the resource prim key of this wiki page.
int	getStatus() Gets the status of this wiki page.
long	getStatusByUserId() Gets the status by user id of this wiki page.
String	getStatusByUserName() Gets the status by user name of this wiki page.
String	getStatusByUserUuid() Gets the status by user uuid of this wiki page.
Date	getStatusDate() Gets the status date of this wiki page.
String	getSummary() Gets the summary of this wiki page.
String	getTitle() Gets the title of this wiki page.
long	getUserId() Gets the user id of this wiki page.
String	getUserName() Gets the user name of this wiki page.
String	getUserUuid() Gets the user uuid of this wiki page.
String	getUuid() Gets the uuid of this wiki page.
double	getVersion() Gets the version of this wiki page.
int	hashCode()
boolean	isApproved() Determines whether this wiki page is approved.
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isDraft() Determines whether this wiki page is a draft.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isExpired() Determines whether this wiki page is expired.
boolean	isHead() Determines whether this wiki page is head.
boolean	isMinorEdit() Determines whether this wiki page is minor edit.
boolean	isNew() Determines if this model instance does not yet exist in the database.
boolean	isPending() Determines whether this wiki page is pending.
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 wiki page.
void	setContent(String content) Sets the content of this wiki page.
void	setCreateDate(Date createDate) Sets the create date of this wiki page.
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	setFormat(String format) Sets the format of this wiki page.
void	setGroupId(long groupId) Sets the group id of this wiki page.
void	setHead(boolean head) Sets whether this {$entity.humanName} is head.
void	setMinorEdit(boolean minorEdit) Sets whether this {$entity.humanName} is minor edit.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this wiki page.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setNodeId(long nodeId) Sets the node id of this wiki page.
void	setPageId(long pageId) Sets the page id of this wiki page.
void	setParentTitle(String parentTitle) Sets the parent title of this wiki page.
void	setPrimaryKey(long pk) Sets the primary key of this wiki page
void	setRedirectTitle(String redirectTitle) Sets the redirect title of this wiki page.
void	setResourcePrimKey(long resourcePrimKey) Sets the resource prim key of this wiki page.
void	setStatus(int status) Sets the status of this wiki page.
void	setStatusByUserId(long statusByUserId) Sets the status by user id of this wiki page.
void	setStatusByUserName(String statusByUserName) Sets the status by user name of this wiki page.
void	setStatusByUserUuid(String statusByUserUuid) Sets the status by user uuid of this wiki page.
void	setStatusDate(Date statusDate) Sets the status date of this wiki page.
void	setSummary(String summary) Sets the summary of this wiki page.
void	setTitle(String title) Sets the title of this wiki page.
void	setUserId(long userId) Sets the user id of this wiki page.
void	setUserName(String userName) Sets the user name of this wiki page.
void	setUserUuid(String userUuid) Sets the user uuid of this wiki page.
void	setUuid(String uuid) Sets the uuid of this wiki page.
void	setVersion(double version) Sets the version of this wiki page.
WikiPage	toEscapedModel() Gets a copy of this wiki page 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 wiki page.

Returns:

the primary key of this wiki page

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this wiki page

Parameters:

pk - the primary key of this wiki page

getUuid

@AutoEscape
String getUuid()

Gets the uuid of this wiki page.

Returns:

the uuid of this wiki page

setUuid

void setUuid(String uuid)

Sets the uuid of this wiki page.

Parameters:

uuid - the uuid of this wiki page

getPageId

long getPageId()

Gets the page id of this wiki page.

Returns:

the page id of this wiki page

setPageId

void setPageId(long pageId)

Sets the page id of this wiki page.

Parameters:

pageId - the page id of this wiki page

getResourcePrimKey

long getResourcePrimKey()

Gets the resource prim key of this wiki page.

Returns:

the resource prim key of this wiki page

setResourcePrimKey

void setResourcePrimKey(long resourcePrimKey)

Sets the resource prim key of this wiki page.

Parameters:

resourcePrimKey - the resource prim key of this wiki page

getGroupId

long getGroupId()

Gets the group id of this wiki page.

Returns:

the group id of this wiki page

setGroupId

void setGroupId(long groupId)

Sets the group id of this wiki page.

Parameters:

groupId - the group id of this wiki page

getCompanyId

long getCompanyId()

Gets the company id of this wiki page.

Returns:

the company id of this wiki page

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this wiki page.

Parameters:

companyId - the company id of this wiki page

getUserId

long getUserId()

Gets the user id of this wiki page.

Returns:

the user id of this wiki page

setUserId

void setUserId(long userId)

Sets the user id of this wiki page.

Parameters:

userId - the user id of this wiki page

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this wiki page.

Returns:

the user uuid of this wiki page

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this wiki page.

Parameters:

userUuid - the user uuid of this wiki page

getUserName

@AutoEscape
String getUserName()

Gets the user name of this wiki page.

Returns:

the user name of this wiki page

setUserName

void setUserName(String userName)

Sets the user name of this wiki page.

Parameters:

userName - the user name of this wiki page

getCreateDate

Date getCreateDate()

Gets the create date of this wiki page.

Returns:

the create date of this wiki page

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this wiki page.

Parameters:

createDate - the create date of this wiki page

getModifiedDate

Date getModifiedDate()

Gets the modified date of this wiki page.

Returns:

the modified date of this wiki page

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this wiki page.

Parameters:

modifiedDate - the modified date of this wiki page

getNodeId

long getNodeId()

Gets the node id of this wiki page.

Returns:

the node id of this wiki page

setNodeId

void setNodeId(long nodeId)

Sets the node id of this wiki page.

Parameters:

nodeId - the node id of this wiki page

getTitle

@AutoEscape
String getTitle()

Gets the title of this wiki page.

Returns:

the title of this wiki page

setTitle

void setTitle(String title)

Sets the title of this wiki page.

Parameters:

title - the title of this wiki page

getVersion

double getVersion()

Gets the version of this wiki page.

Returns:

the version of this wiki page

setVersion

void setVersion(double version)

Sets the version of this wiki page.

Parameters:

version - the version of this wiki page

getMinorEdit

boolean getMinorEdit()

Gets the minor edit of this wiki page.

Returns:

the minor edit of this wiki page

isMinorEdit

boolean isMinorEdit()

Determines whether this wiki page is minor edit.

Returns:

whether this wiki page is minor edit

setMinorEdit

void setMinorEdit(boolean minorEdit)

Sets whether this {$entity.humanName} is minor edit.

Parameters:

minorEdit - the minor edit of this wiki page

getContent

@AutoEscape
String getContent()

Gets the content of this wiki page.

Returns:

the content of this wiki page

setContent

void setContent(String content)

Sets the content of this wiki page.

Parameters:

content - the content of this wiki page

getSummary

@AutoEscape
String getSummary()

Gets the summary of this wiki page.

Returns:

the summary of this wiki page

setSummary

void setSummary(String summary)

Sets the summary of this wiki page.

Parameters:

summary - the summary of this wiki page

getFormat

@AutoEscape
String getFormat()

Gets the format of this wiki page.

Returns:

the format of this wiki page

setFormat

void setFormat(String format)

Sets the format of this wiki page.

Parameters:

format - the format of this wiki page

getHead

boolean getHead()

Gets the head of this wiki page.

Returns:

the head of this wiki page

isHead

boolean isHead()

Determines whether this wiki page is head.

Returns:

whether this wiki page is head

setHead

void setHead(boolean head)

Sets whether this {$entity.humanName} is head.

Parameters:

head - the head of this wiki page

getParentTitle

@AutoEscape
String getParentTitle()

Gets the parent title of this wiki page.

Returns:

the parent title of this wiki page

setParentTitle

void setParentTitle(String parentTitle)

Sets the parent title of this wiki page.

Parameters:

parentTitle - the parent title of this wiki page

getRedirectTitle

@AutoEscape
String getRedirectTitle()

Gets the redirect title of this wiki page.

Returns:

the redirect title of this wiki page

setRedirectTitle

void setRedirectTitle(String redirectTitle)

Sets the redirect title of this wiki page.

Parameters:

redirectTitle - the redirect title of this wiki page

getStatus

int getStatus()

Gets the status of this wiki page.

Returns:

the status of this wiki page

setStatus

void setStatus(int status)

Sets the status of this wiki page.

Parameters:

status - the status of this wiki page

getStatusByUserId

long getStatusByUserId()

Gets the status by user id of this wiki page.

Returns:

the status by user id of this wiki page

setStatusByUserId

void setStatusByUserId(long statusByUserId)

Sets the status by user id of this wiki page.

Parameters:

statusByUserId - the status by user id of this wiki page

getStatusByUserUuid

String getStatusByUserUuid()
                           throws SystemException

Gets the status by user uuid of this wiki page.

Returns:

the status by user uuid of this wiki page

Throws:

SystemException - if a system exception occurred

setStatusByUserUuid

void setStatusByUserUuid(String statusByUserUuid)

Sets the status by user uuid of this wiki page.

Parameters:

statusByUserUuid - the status by user uuid of this wiki page

getStatusByUserName

@AutoEscape
String getStatusByUserName()

Gets the status by user name of this wiki page.

Returns:

the status by user name of this wiki page

setStatusByUserName

void setStatusByUserName(String statusByUserName)

Sets the status by user name of this wiki page.

Parameters:

statusByUserName - the status by user name of this wiki page

getStatusDate

Date getStatusDate()

Gets the status date of this wiki page.

Returns:

the status date of this wiki page

setStatusDate

void setStatusDate(Date statusDate)

Sets the status date of this wiki page.

Parameters:

statusDate - the status date of this wiki page

isApproved

boolean isApproved()

Determines whether this wiki page is approved.

Returns:

true if this wiki page is approved; false otherwise

isDraft

boolean isDraft()

Determines whether this wiki page is a draft.

Returns:

true if this wiki page is a draft; false otherwise

isExpired

boolean isExpired()

Determines whether this wiki page is expired.

Returns:

true if this wiki page is expired; false otherwise

isPending

boolean isPending()

Determines whether this wiki page is pending.

Returns:

true if this wiki page is pending; false otherwise

toEscapedModel

WikiPage toEscapedModel()

Gets a copy of this wiki page 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<WikiPage>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(WikiPage wikiPage)

Specified by:

compareTo in interface Comparable<WikiPage>

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

Returns:

the XML representation of this model instance