Liferay 6.2-ce-ga5

com.liferay.portlet.wiki.model
Interface WikiPageModel

All Superinterfaces:
AuditedModel, BaseModel<WikiPage>, ClassedModel, Cloneable, Comparable<WikiPage>, GroupedModel, ResourcedModel, Serializable, StagedGroupedModel, StagedModel, TrashedModel, WorkflowedModel
All Known Subinterfaces:
WikiPage
All Known Implementing Classes:
WikiPageWrapper

@ProviderType
public interface WikiPageModel
extends BaseModel<WikiPage>, ResourcedModel, StagedGroupedModel, TrashedModel, WorkflowedModel

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.

See Also:
WikiPage, WikiPageImpl, WikiPageModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(WikiPage wikiPage)
           
 boolean getApproved()
          Deprecated. As of 6.1.0, replaced by isApproved()
 long getCompanyId()
          Returns the company ID of this wiki page.
 String getContent()
          Returns the content of this wiki page.
 Date getCreateDate()
          Returns the create date of this wiki page.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 String getFormat()
          Returns the format of this wiki page.
 long getGroupId()
          Returns the group ID of this wiki page.
 boolean getHead()
          Returns the head of this wiki page.
 boolean getMinorEdit()
          Returns the minor edit of this wiki page.
 Date getModifiedDate()
          Returns the modified date of this wiki page.
 long getNodeId()
          Returns the node ID of this wiki page.
 long getPageId()
          Returns the page ID of this wiki page.
 String getParentTitle()
          Returns the parent title of this wiki page.
 long getPrimaryKey()
          Returns the primary key of this wiki page.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 String getRedirectTitle()
          Returns the redirect title of this wiki page.
 long getResourcePrimKey()
          Returns the resource prim key of this wiki page.
 int getStatus()
          Returns the status of this wiki page.
 long getStatusByUserId()
          Returns the status by user ID of this wiki page.
 String getStatusByUserName()
          Returns the status by user name of this wiki page.
 String getStatusByUserUuid()
          Returns the status by user uuid of this wiki page.
 Date getStatusDate()
          Returns the status date of this wiki page.
 String getSummary()
          Returns the summary of this wiki page.
 String getTitle()
          Returns the title of this wiki page.
 TrashEntry getTrashEntry()
          Returns the trash entry created when this wiki page was moved to the Recycle Bin.
 long getTrashEntryClassPK()
          Returns the class primary key of the trash entry for this wiki page.
 TrashHandler getTrashHandler()
          Returns the trash handler for this wiki page.
 long getUserId()
          Returns the user ID of this wiki page.
 String getUserName()
          Returns the user name of this wiki page.
 String getUserUuid()
          Returns the user uuid of this wiki page.
 String getUuid()
          Returns the uuid of this wiki page.
 double getVersion()
          Returns the version of this wiki page.
 int hashCode()
           
 boolean isApproved()
          Returns true if this wiki page is approved.
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isDenied()
          Returns true if this wiki page is denied.
 boolean isDraft()
          Returns true if this wiki page is a draft.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isExpired()
          Returns true if this wiki page is expired.
 boolean isHead()
          Returns true if this wiki page is head.
 boolean isInactive()
          Returns true if this wiki page is inactive.
 boolean isIncomplete()
          Returns true if this wiki page is incomplete.
 boolean isInTrash()
          Returns true if this wiki page is in the Recycle Bin.
 boolean isInTrashContainer()
          Returns true if the parent of this wiki page is in the Recycle Bin.
 boolean isMinorEdit()
          Returns true if this wiki page is minor edit.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isPending()
          Returns true if this wiki page is pending.
 boolean isResourceMain()
           
 boolean isScheduled()
          Returns true if this wiki page 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 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 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 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 wiki page is head.
 void setMinorEdit(boolean minorEdit)
          Sets whether this wiki page 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 primaryKey)
          Sets the primary key of this wiki page.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 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.
 CacheModel<WikiPage> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 WikiPage toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 WikiPage 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 wiki page.

Returns:
the primary key of this wiki page

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this wiki page.

Parameters:
primaryKey - the primary key of this wiki page

getUuid

@AutoEscape
String getUuid()
Returns the uuid of this wiki page.

Specified by:
getUuid in interface StagedModel
Returns:
the uuid of this wiki page

setUuid

void setUuid(String uuid)
Sets the uuid of this wiki page.

Specified by:
setUuid in interface StagedModel
Parameters:
uuid - the uuid of this wiki page

getPageId

long getPageId()
Returns 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()
Returns the resource prim key of this wiki page.

Specified by:
getResourcePrimKey in interface ResourcedModel
Returns:
the resource prim key of this wiki page

setResourcePrimKey

void setResourcePrimKey(long resourcePrimKey)
Sets the resource prim key of this wiki page.

Specified by:
setResourcePrimKey in interface ResourcedModel
Parameters:
resourcePrimKey - the resource prim key of this wiki page

isResourceMain

boolean isResourceMain()
Specified by:
isResourceMain in interface ResourcedModel

getGroupId

long getGroupId()
Returns the group ID of this wiki page.

Specified by:
getGroupId in interface GroupedModel
Returns:
the group ID of this wiki page

setGroupId

void setGroupId(long groupId)
Sets the group ID of this wiki page.

Specified by:
setGroupId in interface GroupedModel
Parameters:
groupId - the group ID of this wiki page

getCompanyId

long getCompanyId()
Returns the company ID of this wiki page.

Specified by:
getCompanyId in interface AuditedModel
Specified by:
getCompanyId in interface StagedModel
Returns:
the company ID of this wiki page

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this wiki page.

Specified by:
setCompanyId in interface AuditedModel
Specified by:
setCompanyId in interface StagedModel
Parameters:
companyId - the company ID of this wiki page

getUserId

long getUserId()
Returns the user ID of this wiki page.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this wiki page

setUserId

void setUserId(long userId)
Sets the user ID of this wiki page.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this wiki page

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this wiki page.

Specified by:
getUserUuid in interface AuditedModel
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.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this wiki page

getUserName

@AutoEscape
String getUserName()
Returns the user name of this wiki page.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this wiki page

setUserName

void setUserName(String userName)
Sets the user name of this wiki page.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this wiki page

getCreateDate

Date getCreateDate()
Returns the create date of this wiki page.

Specified by:
getCreateDate in interface AuditedModel
Specified by:
getCreateDate in interface StagedModel
Returns:
the create date of this wiki page

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this wiki page.

Specified by:
setCreateDate in interface AuditedModel
Specified by:
setCreateDate in interface StagedModel
Parameters:
createDate - the create date of this wiki page

getModifiedDate

Date getModifiedDate()
Returns the modified date of this wiki page.

Specified by:
getModifiedDate in interface AuditedModel
Specified by:
getModifiedDate in interface StagedModel
Returns:
the modified date of this wiki page

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this wiki page.

Specified by:
setModifiedDate in interface AuditedModel
Specified by:
setModifiedDate in interface StagedModel
Parameters:
modifiedDate - the modified date of this wiki page

getNodeId

long getNodeId()
Returns 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()
Returns 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()
Returns 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()
Returns the minor edit of this wiki page.

Returns:
the minor edit of this wiki page

isMinorEdit

boolean isMinorEdit()
Returns true if this wiki page is minor edit.

Returns:
true if this wiki page is minor edit; false otherwise

setMinorEdit

void setMinorEdit(boolean minorEdit)
Sets whether this wiki page is minor edit.

Parameters:
minorEdit - the minor edit of this wiki page

getContent

@AutoEscape
String getContent()
Returns 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()
Returns 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()
Returns 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()
Returns the head of this wiki page.

Returns:
the head of this wiki page

isHead

boolean isHead()
Returns true if this wiki page is head.

Returns:
true if this wiki page is head; false otherwise

setHead

void setHead(boolean head)
Sets whether this wiki page is head.

Parameters:
head - the head of this wiki page

getParentTitle

@AutoEscape
String getParentTitle()
Returns 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()
Returns 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()
Returns the status of this wiki page.

Specified by:
getStatus in interface TrashedModel
Specified by:
getStatus in interface WorkflowedModel
Returns:
the status of this wiki page

setStatus

void setStatus(int status)
Sets the status of this wiki page.

Specified by:
setStatus in interface WorkflowedModel
Parameters:
status - the status of this wiki page

getStatusByUserId

long getStatusByUserId()
Returns the status by user ID of this wiki page.

Specified by:
getStatusByUserId in interface WorkflowedModel
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.

Specified by:
setStatusByUserId in interface WorkflowedModel
Parameters:
statusByUserId - the status by user ID of this wiki page

getStatusByUserUuid

String getStatusByUserUuid()
                           throws SystemException
Returns the status by user uuid of this wiki page.

Specified by:
getStatusByUserUuid in interface WorkflowedModel
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.

Specified by:
setStatusByUserUuid in interface WorkflowedModel
Parameters:
statusByUserUuid - the status by user uuid of this wiki page

getStatusByUserName

@AutoEscape
String getStatusByUserName()
Returns the status by user name of this wiki page.

Specified by:
getStatusByUserName in interface WorkflowedModel
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.

Specified by:
setStatusByUserName in interface WorkflowedModel
Parameters:
statusByUserName - the status by user name of this wiki page

getStatusDate

Date getStatusDate()
Returns the status date of this wiki page.

Specified by:
getStatusDate in interface WorkflowedModel
Returns:
the status date of this wiki page

setStatusDate

void setStatusDate(Date statusDate)
Sets the status date of this wiki page.

Specified by:
setStatusDate in interface WorkflowedModel
Parameters:
statusDate - the status date of this wiki page

getTrashEntry

TrashEntry getTrashEntry()
                         throws PortalException,
                                SystemException
Returns the trash entry created when this wiki page was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this wiki page.

Specified by:
getTrashEntry in interface TrashedModel
Returns:
the trash entry created when this wiki page 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 wiki page.

Specified by:
getTrashEntryClassPK in interface TrashedModel
Returns:
the class primary key of the trash entry for this wiki page

getTrashHandler

TrashHandler getTrashHandler()
Returns the trash handler for this wiki page.

Specified by:
getTrashHandler in interface TrashedModel
Returns:
the trash handler for this wiki page

isInTrash

boolean isInTrash()
Returns true if this wiki page is in the Recycle Bin.

Specified by:
isInTrash in interface TrashedModel
Returns:
true if this wiki page is in the Recycle Bin; false otherwise

isInTrashContainer

boolean isInTrashContainer()
Returns true if the parent of this wiki page is in the Recycle Bin.

Specified by:
isInTrashContainer in interface TrashedModel
Returns:
true if the parent of this wiki page 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 wiki page is approved.

Specified by:
isApproved in interface WorkflowedModel
Returns:
true if this wiki page is approved; false otherwise

isDenied

boolean isDenied()
Returns true if this wiki page is denied.

Specified by:
isDenied in interface WorkflowedModel
Returns:
true if this wiki page is denied; false otherwise

isDraft

boolean isDraft()
Returns true if this wiki page is a draft.

Specified by:
isDraft in interface WorkflowedModel
Returns:
true if this wiki page is a draft; false otherwise

isExpired

boolean isExpired()
Returns true if this wiki page is expired.

Specified by:
isExpired in interface WorkflowedModel
Returns:
true if this wiki page is expired; false otherwise

isInactive

boolean isInactive()
Returns true if this wiki page is inactive.

Specified by:
isInactive in interface WorkflowedModel
Returns:
true if this wiki page is inactive; false otherwise

isIncomplete

boolean isIncomplete()
Returns true if this wiki page is incomplete.

Specified by:
isIncomplete in interface WorkflowedModel
Returns:
true if this wiki page is incomplete; false otherwise

isPending

boolean isPending()
Returns true if this wiki page is pending.

Specified by:
isPending in interface WorkflowedModel
Returns:
true if this wiki page is pending; false otherwise

isScheduled

boolean isScheduled()
Returns true if this wiki page is scheduled.

Specified by:
isScheduled in interface WorkflowedModel
Returns:
true if this wiki page 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<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
Returns true 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
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<WikiPage>
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<WikiPage>
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<WikiPage>
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<WikiPage>
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<WikiPage>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<WikiPage>

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 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<WikiPage>
Specified by:
clone in interface StagedModel
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

toCacheModel

CacheModel<WikiPage> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<WikiPage>
Returns:
the cache model object

toEscapedModel

WikiPage 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<WikiPage>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

WikiPage toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<WikiPage>

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<WikiPage>
Returns:
the XML representation of this model instance

Liferay 6.2-ce-ga5