com.liferay.portlet.journal.model
Interface JournalArticleModel

All Superinterfaces:

BaseModel<JournalArticle>, Cloneable, Comparable<JournalArticle>, Serializable

All Known Subinterfaces:

JournalArticle

All Known Implementing Classes:

JournalArticleImpl, JournalArticleModelImpl, JournalArticleWrapper

public interface JournalArticleModel
extends BaseModel<JournalArticle>

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

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

Never modify or reference this interface directly. All methods that expect a journal article model instance should use the JournalArticle interface instead.

See Also:

JournalArticle, JournalArticleImpl, JournalArticleModelImpl

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(JournalArticle journalArticle)
String	getArticleId() Gets the article id of this journal article.
long	getCompanyId() Gets the company id of this journal article.
String	getContent() Gets the content of this journal article.
Date	getCreateDate() Gets the create date of this journal article.
String	getDescription() Gets the description of this journal article.
Date	getDisplayDate() Gets the display date of this journal article.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
Date	getExpirationDate() Gets the expiration date of this journal article.
long	getGroupId() Gets the group id of this journal article.
long	getId() Gets the id of this journal article.
boolean	getIndexable() Gets the indexable of this journal article.
Date	getModifiedDate() Gets the modified date of this journal article.
long	getPrimaryKey() Gets the primary key of this journal article.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
long	getResourcePrimKey() Gets the resource prim key of this journal article.
Date	getReviewDate() Gets the review date of this journal article.
boolean	getSmallImage() Gets the small image of this journal article.
long	getSmallImageId() Gets the small image id of this journal article.
String	getSmallImageURL() Gets the small image u r l of this journal article.
int	getStatus() Gets the status of this journal article.
long	getStatusByUserId() Gets the status by user id of this journal article.
String	getStatusByUserName() Gets the status by user name of this journal article.
String	getStatusByUserUuid() Gets the status by user uuid of this journal article.
Date	getStatusDate() Gets the status date of this journal article.
String	getStructureId() Gets the structure id of this journal article.
String	getTemplateId() Gets the template id of this journal article.
String	getTitle() Gets the title of this journal article.
String	getType() Gets the type of this journal article.
String	getUrlTitle() Gets the url title of this journal article.
long	getUserId() Gets the user id of this journal article.
String	getUserName() Gets the user name of this journal article.
String	getUserUuid() Gets the user uuid of this journal article.
String	getUuid() Gets the uuid of this journal article.
double	getVersion() Gets the version of this journal article.
int	hashCode()
boolean	isApproved() Determines whether this journal article is approved.
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isDraft() Determines whether this journal article is a draft.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isExpired() Determines whether this journal article is expired.
boolean	isIndexable() Determines whether this journal article is indexable.
boolean	isNew() Determines if this model instance does not yet exist in the database.
boolean	isPending() Determines whether this journal article is pending.
boolean	isSmallImage() Determines whether this journal article is small image.
void	setArticleId(String articleId) Sets the article id of this journal article.
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 journal article.
void	setContent(String content) Sets the content of this journal article.
void	setCreateDate(Date createDate) Sets the create date of this journal article.
void	setDescription(String description) Sets the description of this journal article.
void	setDisplayDate(Date displayDate) Sets the display date of this journal article.
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	setExpirationDate(Date expirationDate) Sets the expiration date of this journal article.
void	setGroupId(long groupId) Sets the group id of this journal article.
void	setId(long id) Sets the id of this journal article.
void	setIndexable(boolean indexable) Sets whether this {$entity.humanName} is indexable.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this journal article.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrimaryKey(long pk) Sets the primary key of this journal article
void	setResourcePrimKey(long resourcePrimKey) Sets the resource prim key of this journal article.
void	setReviewDate(Date reviewDate) Sets the review date of this journal article.
void	setSmallImage(boolean smallImage) Sets whether this {$entity.humanName} is small image.
void	setSmallImageId(long smallImageId) Sets the small image id of this journal article.
void	setSmallImageURL(String smallImageURL) Sets the small image u r l of this journal article.
void	setStatus(int status) Sets the status of this journal article.
void	setStatusByUserId(long statusByUserId) Sets the status by user id of this journal article.
void	setStatusByUserName(String statusByUserName) Sets the status by user name of this journal article.
void	setStatusByUserUuid(String statusByUserUuid) Sets the status by user uuid of this journal article.
void	setStatusDate(Date statusDate) Sets the status date of this journal article.
void	setStructureId(String structureId) Sets the structure id of this journal article.
void	setTemplateId(String templateId) Sets the template id of this journal article.
void	setTitle(String title) Sets the title of this journal article.
void	setType(String type) Sets the type of this journal article.
void	setUrlTitle(String urlTitle) Sets the url title of this journal article.
void	setUserId(long userId) Sets the user id of this journal article.
void	setUserName(String userName) Sets the user name of this journal article.
void	setUserUuid(String userUuid) Sets the user uuid of this journal article.
void	setUuid(String uuid) Sets the uuid of this journal article.
void	setVersion(double version) Sets the version of this journal article.
JournalArticle	toEscapedModel() Gets a copy of this journal article 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 journal article.

Returns:

the primary key of this journal article

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this journal article

Parameters:

pk - the primary key of this journal article

getUuid

@AutoEscape
String getUuid()

Gets the uuid of this journal article.

Returns:

the uuid of this journal article

setUuid

void setUuid(String uuid)

Sets the uuid of this journal article.

Parameters:

uuid - the uuid of this journal article

getId

long getId()

Gets the id of this journal article.

Returns:

the id of this journal article

setId

void setId(long id)

Sets the id of this journal article.

Parameters:

id - the id of this journal article

getResourcePrimKey

long getResourcePrimKey()

Gets the resource prim key of this journal article.

Returns:

the resource prim key of this journal article

setResourcePrimKey

void setResourcePrimKey(long resourcePrimKey)

Sets the resource prim key of this journal article.

Parameters:

resourcePrimKey - the resource prim key of this journal article

getGroupId

long getGroupId()

Gets the group id of this journal article.

Returns:

the group id of this journal article

setGroupId

void setGroupId(long groupId)

Sets the group id of this journal article.

Parameters:

groupId - the group id of this journal article

getCompanyId

long getCompanyId()

Gets the company id of this journal article.

Returns:

the company id of this journal article

setCompanyId

void setCompanyId(long companyId)

Sets the company id of this journal article.

Parameters:

companyId - the company id of this journal article

getUserId

long getUserId()

Gets the user id of this journal article.

Returns:

the user id of this journal article

setUserId

void setUserId(long userId)

Sets the user id of this journal article.

Parameters:

userId - the user id of this journal article

getUserUuid

String getUserUuid()
                   throws SystemException

Gets the user uuid of this journal article.

Returns:

the user uuid of this journal article

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this journal article.

Parameters:

userUuid - the user uuid of this journal article

getUserName

@AutoEscape
String getUserName()

Gets the user name of this journal article.

Returns:

the user name of this journal article

setUserName

void setUserName(String userName)

Sets the user name of this journal article.

Parameters:

userName - the user name of this journal article

getCreateDate

Date getCreateDate()

Gets the create date of this journal article.

Returns:

the create date of this journal article

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this journal article.

Parameters:

createDate - the create date of this journal article

getModifiedDate

Date getModifiedDate()

Gets the modified date of this journal article.

Returns:

the modified date of this journal article

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this journal article.

Parameters:

modifiedDate - the modified date of this journal article

getArticleId

String getArticleId()

Gets the article id of this journal article.

Returns:

the article id of this journal article

setArticleId

void setArticleId(String articleId)

Sets the article id of this journal article.

Parameters:

articleId - the article id of this journal article

getVersion

double getVersion()

Gets the version of this journal article.

Returns:

the version of this journal article

setVersion

void setVersion(double version)

Sets the version of this journal article.

Parameters:

version - the version of this journal article

getTitle

@AutoEscape
String getTitle()

Gets the title of this journal article.

Returns:

the title of this journal article

setTitle

void setTitle(String title)

Sets the title of this journal article.

Parameters:

title - the title of this journal article

getUrlTitle

@AutoEscape
String getUrlTitle()

Gets the url title of this journal article.

Returns:

the url title of this journal article

setUrlTitle

void setUrlTitle(String urlTitle)

Sets the url title of this journal article.

Parameters:

urlTitle - the url title of this journal article

getDescription

@AutoEscape
String getDescription()

Gets the description of this journal article.

Returns:

the description of this journal article

setDescription

void setDescription(String description)

Sets the description of this journal article.

Parameters:

description - the description of this journal article

getContent

@AutoEscape
String getContent()

Gets the content of this journal article.

Returns:

the content of this journal article

setContent

void setContent(String content)

Sets the content of this journal article.

Parameters:

content - the content of this journal article

getType

@AutoEscape
String getType()

Gets the type of this journal article.

Returns:

the type of this journal article

setType

void setType(String type)

Sets the type of this journal article.

Parameters:

type - the type of this journal article

getStructureId

String getStructureId()

Gets the structure id of this journal article.

Returns:

the structure id of this journal article

setStructureId

void setStructureId(String structureId)

Sets the structure id of this journal article.

Parameters:

structureId - the structure id of this journal article

getTemplateId

String getTemplateId()

Gets the template id of this journal article.

Returns:

the template id of this journal article

setTemplateId

void setTemplateId(String templateId)

Sets the template id of this journal article.

Parameters:

templateId - the template id of this journal article

getDisplayDate

Date getDisplayDate()

Gets the display date of this journal article.

Returns:

the display date of this journal article

setDisplayDate

void setDisplayDate(Date displayDate)

Sets the display date of this journal article.

Parameters:

displayDate - the display date of this journal article

getExpirationDate

Date getExpirationDate()

Gets the expiration date of this journal article.

Returns:

the expiration date of this journal article

setExpirationDate

void setExpirationDate(Date expirationDate)

Sets the expiration date of this journal article.

Parameters:

expirationDate - the expiration date of this journal article

getReviewDate

Date getReviewDate()

Gets the review date of this journal article.

Returns:

the review date of this journal article

setReviewDate

void setReviewDate(Date reviewDate)

Sets the review date of this journal article.

Parameters:

reviewDate - the review date of this journal article

getIndexable

boolean getIndexable()

Gets the indexable of this journal article.

Returns:

the indexable of this journal article

isIndexable

boolean isIndexable()

Determines whether this journal article is indexable.

Returns:

whether this journal article is indexable

setIndexable

void setIndexable(boolean indexable)

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

Parameters:

indexable - the indexable of this journal article

getSmallImage

boolean getSmallImage()

Gets the small image of this journal article.

Returns:

the small image of this journal article

isSmallImage

boolean isSmallImage()

Determines whether this journal article is small image.

Returns:

whether this journal article is small image

setSmallImage

void setSmallImage(boolean smallImage)

Sets whether this {$entity.humanName} is small image.

Parameters:

smallImage - the small image of this journal article

getSmallImageId

long getSmallImageId()

Gets the small image id of this journal article.

Returns:

the small image id of this journal article

setSmallImageId

void setSmallImageId(long smallImageId)

Sets the small image id of this journal article.

Parameters:

smallImageId - the small image id of this journal article

getSmallImageURL

@AutoEscape
String getSmallImageURL()

Gets the small image u r l of this journal article.

Returns:

the small image u r l of this journal article

setSmallImageURL

void setSmallImageURL(String smallImageURL)

Sets the small image u r l of this journal article.

Parameters:

smallImageURL - the small image u r l of this journal article

getStatus

int getStatus()

Gets the status of this journal article.

Returns:

the status of this journal article

setStatus

void setStatus(int status)

Sets the status of this journal article.

Parameters:

status - the status of this journal article

getStatusByUserId

long getStatusByUserId()

Gets the status by user id of this journal article.

Returns:

the status by user id of this journal article

setStatusByUserId

void setStatusByUserId(long statusByUserId)

Sets the status by user id of this journal article.

Parameters:

statusByUserId - the status by user id of this journal article

getStatusByUserUuid

String getStatusByUserUuid()
                           throws SystemException

Gets the status by user uuid of this journal article.

Returns:

the status by user uuid of this journal article

Throws:

SystemException - if a system exception occurred

setStatusByUserUuid

void setStatusByUserUuid(String statusByUserUuid)

Sets the status by user uuid of this journal article.

Parameters:

statusByUserUuid - the status by user uuid of this journal article

getStatusByUserName

@AutoEscape
String getStatusByUserName()

Gets the status by user name of this journal article.

Returns:

the status by user name of this journal article

setStatusByUserName

void setStatusByUserName(String statusByUserName)

Sets the status by user name of this journal article.

Parameters:

statusByUserName - the status by user name of this journal article

getStatusDate

Date getStatusDate()

Gets the status date of this journal article.

Returns:

the status date of this journal article

setStatusDate

void setStatusDate(Date statusDate)

Sets the status date of this journal article.

Parameters:

statusDate - the status date of this journal article

isApproved

boolean isApproved()

Determines whether this journal article is approved.

Returns:

true if this journal article is approved; false otherwise

isDraft

boolean isDraft()

Determines whether this journal article is a draft.

Returns:

true if this journal article is a draft; false otherwise

isExpired

boolean isExpired()

Determines whether this journal article is expired.

Returns:

true if this journal article is expired; false otherwise

isPending

boolean isPending()

Determines whether this journal article is pending.

Returns:

true if this journal article is pending; false otherwise

toEscapedModel

JournalArticle toEscapedModel()

Gets a copy of this journal article 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<JournalArticle>

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

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

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

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

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

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

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

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(JournalArticle journalArticle)

Specified by:

compareTo in interface Comparable<JournalArticle>

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

Returns:

the XML representation of this model instance