Liferay 6.1.2-ce-ga3

com.liferay.portlet.journal.model
Class JournalArticleWrapper

java.lang.Object
  extended by com.liferay.portlet.journal.model.JournalArticleWrapper
All Implemented Interfaces:
AttachedModel, AuditedModel, BaseModel<JournalArticle>, ClassedModel, GroupedModel, ModelWrapper<JournalArticle>, PersistedModel, ResourcedModel, WorkflowedModel, JournalArticle, JournalArticleModel, Serializable, Cloneable, Comparable<JournalArticle>

public class JournalArticleWrapper
extends Object
implements JournalArticle, ModelWrapper<JournalArticle>

This class is a wrapper for JournalArticle.

See Also:
JournalArticle, Serialized Form
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
JournalArticleWrapper(JournalArticle journalArticle)
           
 
Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(JournalArticle journalArticle)
           
 boolean equals(Object obj)
           
 boolean getApproved()
          Deprecated. Renamed to isApproved()
 String getArticleId()
          Returns the article ID of this journal article.
 JournalArticleResource getArticleResource()
           
 String getArticleResourceUuid()
           
 String[] getAvailableLocales()
           
 String getClassName()
          Returns the fully qualified class name of this journal article.
 long getClassNameId()
          Returns the class name ID of this journal article.
 long getClassPK()
          Returns the class p k of this journal article.
 long getCompanyId()
          Returns the company ID of this journal article.
 String getContent()
          Returns the content of this journal article.
 String getContentByLocale(String languageId)
           
 Date getCreateDate()
          Returns the create date of this journal article.
 String getDefaultLocale()
           
 String getDescription()
          Returns the description of this journal article.
 String getDescription(Locale locale)
          Returns the localized description of this journal article in the language.
 String getDescription(Locale locale, boolean useDefault)
          Returns the localized description of this journal article in the language, optionally using the default language if no localization exists for the requested language.
 String getDescription(String languageId)
          Returns the localized description of this journal article in the language.
 String getDescription(String languageId, boolean useDefault)
          Returns the localized description of this journal article in the language, optionally using the default language if no localization exists for the requested language.
 String getDescriptionCurrentLanguageId()
           
 String getDescriptionCurrentValue()
           
 Map<Locale,String> getDescriptionMap()
          Returns a map of the locales and localized descriptions of this journal article.
 Date getDisplayDate()
          Returns the display date of this journal article.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 Date getExpirationDate()
          Returns the expiration date of this journal article.
 long getGroupId()
          Returns the group ID of this journal article.
 long getId()
          Returns the ID of this journal article.
 boolean getIndexable()
          Returns the indexable of this journal article.
 String getLayoutUuid()
          Returns the layout uuid of this journal article.
 Map<String,Object> getModelAttributes()
           
 Class<?> getModelClass()
           
 String getModelClassName()
           
 Date getModifiedDate()
          Returns the modified date of this journal article.
 long getPrimaryKey()
          Returns the primary key of this journal article.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getResourcePrimKey()
          Returns the resource prim key of this journal article.
 Date getReviewDate()
          Returns the review date of this journal article.
 boolean getSmallImage()
          Returns the small image of this journal article.
 long getSmallImageId()
          Returns the small image ID of this journal article.
 String getSmallImageType()
           
 String getSmallImageURL()
          Returns the small image u r l of this journal article.
 int getStatus()
          Returns the status of this journal article.
 long getStatusByUserId()
          Returns the status by user ID of this journal article.
 String getStatusByUserName()
          Returns the status by user name of this journal article.
 String getStatusByUserUuid()
          Returns the status by user uuid of this journal article.
 Date getStatusDate()
          Returns the status date of this journal article.
 String getStructureId()
          Returns the structure ID of this journal article.
 String getTemplateId()
          Returns the template ID of this journal article.
 String getTitle()
          Returns the title of this journal article.
 String getTitle(Locale locale)
          Returns the localized title of this journal article in the language.
 String getTitle(Locale locale, boolean useDefault)
          Returns the localized title of this journal article in the language, optionally using the default language if no localization exists for the requested language.
 String getTitle(String languageId)
          Returns the localized title of this journal article in the language.
 String getTitle(String languageId, boolean useDefault)
          Returns the localized title of this journal article in the language, optionally using the default language if no localization exists for the requested language.
 String getTitleCurrentLanguageId()
           
 String getTitleCurrentValue()
           
 Map<Locale,String> getTitleMap()
          Returns a map of the locales and localized titles of this journal article.
 String getType()
          Returns the type of this journal article.
 String getUrlTitle()
          Returns the url title of this journal article.
 long getUserId()
          Returns the user ID of this journal article.
 String getUserName()
          Returns the user name of this journal article.
 String getUserUuid()
          Returns the user uuid of this journal article.
 String getUuid()
          Returns the uuid of this journal article.
 double getVersion()
          Returns the version of this journal article.
 JournalArticle getWrappedJournalArticle()
          Deprecated. Renamed to getWrappedModel()
 JournalArticle getWrappedModel()
           
 int hashCode()
           
 boolean isApproved()
          Returns true if this journal article is approved.
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isDenied()
          Returns true if this journal article is denied.
 boolean isDraft()
          Returns true if this journal article is a draft.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isExpired()
          Returns true if this journal article is expired.
 boolean isInactive()
          Returns true if this journal article is inactive.
 boolean isIncomplete()
          Returns true if this journal article is incomplete.
 boolean isIndexable()
          Returns true if this journal article is indexable.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isPending()
          Returns true if this journal article is pending.
 boolean isResourceMain()
           
 boolean isScheduled()
          Returns true if this journal article is scheduled.
 boolean isSmallImage()
          Returns true if this journal article is small image.
 boolean isTemplateDriven()
           
 void persist()
          Updates this model instance in the database or adds it if it does not yet exist.
 void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
           
 void resetOriginalValues()
          Reset all original fields to current values.
 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 setClassName(String className)
           
 void setClassNameId(long classNameId)
          Sets the class name ID of this journal article.
 void setClassPK(long classPK)
          Sets the class p k of this journal article.
 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 setDescription(String description, Locale locale)
          Sets the localized description of this journal article in the language.
 void setDescription(String description, Locale locale, Locale defaultLocale)
          Sets the localized description of this journal article in the language, and sets the default locale.
 void setDescriptionCurrentLanguageId(String languageId)
           
 void setDescriptionMap(Map<Locale,String> descriptionMap)
          Sets the localized descriptions of this journal article from the map of locales and localized descriptions.
 void setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
          Sets the localized descriptions of this journal article from the map of locales and localized descriptions, and sets the default locale.
 void setDisplayDate(Date displayDate)
          Sets the display date of this journal article.
 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 journal article is indexable.
 void setLayoutUuid(String layoutUuid)
          Sets the layout uuid of this journal article.
 void setModelAttributes(Map<String,Object> attributes)
           
 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 primaryKey)
          Sets the primary key of this journal article.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 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 journal article is small image.
 void setSmallImageId(long smallImageId)
          Sets the small image ID of this journal article.
 void setSmallImageType(String smallImageType)
           
 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 setTitle(String title, Locale locale)
          Sets the localized title of this journal article in the language.
 void setTitle(String title, Locale locale, Locale defaultLocale)
          Sets the localized title of this journal article in the language, and sets the default locale.
 void setTitleCurrentLanguageId(String languageId)
           
 void setTitleMap(Map<Locale,String> titleMap)
          Sets the localized titles of this journal article from the map of locales and localized titles.
 void setTitleMap(Map<Locale,String> titleMap, Locale defaultLocale)
          Sets the localized titles of this journal article from the map of locales and localized titles, and sets the default locale.
 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.
 CacheModel<JournalArticle> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 JournalArticle toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 JournalArticle toUnescapedModel()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JournalArticleWrapper

public JournalArticleWrapper(JournalArticle journalArticle)
Method Detail

getModelClass

public Class<?> getModelClass()
Specified by:
getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()
Specified by:
getModelClassName in interface ClassedModel

getModelAttributes

public Map<String,Object> getModelAttributes()
Specified by:
getModelAttributes in interface BaseModel<JournalArticle>

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)
Specified by:
setModelAttributes in interface BaseModel<JournalArticle>

getPrimaryKey

public long getPrimaryKey()
Returns the primary key of this journal article.

Specified by:
getPrimaryKey in interface JournalArticleModel
Returns:
the primary key of this journal article

setPrimaryKey

public void setPrimaryKey(long primaryKey)
Sets the primary key of this journal article.

Specified by:
setPrimaryKey in interface JournalArticleModel
Parameters:
primaryKey - the primary key of this journal article

getUuid

public String getUuid()
Returns the uuid of this journal article.

Specified by:
getUuid in interface JournalArticleModel
Returns:
the uuid of this journal article

setUuid

public void setUuid(String uuid)
Sets the uuid of this journal article.

Specified by:
setUuid in interface JournalArticleModel
Parameters:
uuid - the uuid of this journal article

getId

public long getId()
Returns the ID of this journal article.

Specified by:
getId in interface JournalArticleModel
Returns:
the ID of this journal article

setId

public void setId(long id)
Sets the ID of this journal article.

Specified by:
setId in interface JournalArticleModel
Parameters:
id - the ID of this journal article

getResourcePrimKey

public long getResourcePrimKey()
Returns the resource prim key of this journal article.

Specified by:
getResourcePrimKey in interface ResourcedModel
Specified by:
getResourcePrimKey in interface JournalArticleModel
Returns:
the resource prim key of this journal article

setResourcePrimKey

public void setResourcePrimKey(long resourcePrimKey)
Sets the resource prim key of this journal article.

Specified by:
setResourcePrimKey in interface JournalArticleModel
Parameters:
resourcePrimKey - the resource prim key of this journal article

isResourceMain

public boolean isResourceMain()
Specified by:
isResourceMain in interface ResourcedModel
Specified by:
isResourceMain in interface JournalArticleModel

getGroupId

public long getGroupId()
Returns the group ID of this journal article.

Specified by:
getGroupId in interface GroupedModel
Specified by:
getGroupId in interface JournalArticleModel
Returns:
the group ID of this journal article

setGroupId

public void setGroupId(long groupId)
Sets the group ID of this journal article.

Specified by:
setGroupId in interface GroupedModel
Specified by:
setGroupId in interface JournalArticleModel
Parameters:
groupId - the group ID of this journal article

getCompanyId

public long getCompanyId()
Returns the company ID of this journal article.

Specified by:
getCompanyId in interface AuditedModel
Specified by:
getCompanyId in interface JournalArticleModel
Returns:
the company ID of this journal article

setCompanyId

public void setCompanyId(long companyId)
Sets the company ID of this journal article.

Specified by:
setCompanyId in interface AuditedModel
Specified by:
setCompanyId in interface JournalArticleModel
Parameters:
companyId - the company ID of this journal article

getUserId

public long getUserId()
Returns the user ID of this journal article.

Specified by:
getUserId in interface AuditedModel
Specified by:
getUserId in interface JournalArticleModel
Returns:
the user ID of this journal article

setUserId

public void setUserId(long userId)
Sets the user ID of this journal article.

Specified by:
setUserId in interface AuditedModel
Specified by:
setUserId in interface JournalArticleModel
Parameters:
userId - the user ID of this journal article

getUserUuid

public String getUserUuid()
                   throws SystemException
Returns the user uuid of this journal article.

Specified by:
getUserUuid in interface AuditedModel
Specified by:
getUserUuid in interface JournalArticleModel
Returns:
the user uuid of this journal article
Throws:
SystemException - if a system exception occurred

setUserUuid

public void setUserUuid(String userUuid)
Sets the user uuid of this journal article.

Specified by:
setUserUuid in interface AuditedModel
Specified by:
setUserUuid in interface JournalArticleModel
Parameters:
userUuid - the user uuid of this journal article

getUserName

public String getUserName()
Returns the user name of this journal article.

Specified by:
getUserName in interface AuditedModel
Specified by:
getUserName in interface JournalArticleModel
Returns:
the user name of this journal article

setUserName

public void setUserName(String userName)
Sets the user name of this journal article.

Specified by:
setUserName in interface AuditedModel
Specified by:
setUserName in interface JournalArticleModel
Parameters:
userName - the user name of this journal article

getCreateDate

public Date getCreateDate()
Returns the create date of this journal article.

Specified by:
getCreateDate in interface AuditedModel
Specified by:
getCreateDate in interface JournalArticleModel
Returns:
the create date of this journal article

setCreateDate

public void setCreateDate(Date createDate)
Sets the create date of this journal article.

Specified by:
setCreateDate in interface AuditedModel
Specified by:
setCreateDate in interface JournalArticleModel
Parameters:
createDate - the create date of this journal article

getModifiedDate

public Date getModifiedDate()
Returns the modified date of this journal article.

Specified by:
getModifiedDate in interface AuditedModel
Specified by:
getModifiedDate in interface JournalArticleModel
Returns:
the modified date of this journal article

setModifiedDate

public void setModifiedDate(Date modifiedDate)
Sets the modified date of this journal article.

Specified by:
setModifiedDate in interface AuditedModel
Specified by:
setModifiedDate in interface JournalArticleModel
Parameters:
modifiedDate - the modified date of this journal article

getClassName

public String getClassName()
Returns the fully qualified class name of this journal article.

Specified by:
getClassName in interface AttachedModel
Specified by:
getClassName in interface JournalArticleModel
Returns:
the fully qualified class name of this journal article

setClassName

public void setClassName(String className)
Specified by:
setClassName in interface JournalArticleModel

getClassNameId

public long getClassNameId()
Returns the class name ID of this journal article.

Specified by:
getClassNameId in interface AttachedModel
Specified by:
getClassNameId in interface JournalArticleModel
Returns:
the class name ID of this journal article

setClassNameId

public void setClassNameId(long classNameId)
Sets the class name ID of this journal article.

Specified by:
setClassNameId in interface AttachedModel
Specified by:
setClassNameId in interface JournalArticleModel
Parameters:
classNameId - the class name ID of this journal article

getClassPK

public long getClassPK()
Returns the class p k of this journal article.

Specified by:
getClassPK in interface AttachedModel
Specified by:
getClassPK in interface JournalArticleModel
Returns:
the class p k of this journal article

setClassPK

public void setClassPK(long classPK)
Sets the class p k of this journal article.

Specified by:
setClassPK in interface AttachedModel
Specified by:
setClassPK in interface JournalArticleModel
Parameters:
classPK - the class p k of this journal article

getArticleId

public String getArticleId()
Returns the article ID of this journal article.

Specified by:
getArticleId in interface JournalArticleModel
Returns:
the article ID of this journal article

setArticleId

public void setArticleId(String articleId)
Sets the article ID of this journal article.

Specified by:
setArticleId in interface JournalArticleModel
Parameters:
articleId - the article ID of this journal article

getVersion

public double getVersion()
Returns the version of this journal article.

Specified by:
getVersion in interface JournalArticleModel
Returns:
the version of this journal article

setVersion

public void setVersion(double version)
Sets the version of this journal article.

Specified by:
setVersion in interface JournalArticleModel
Parameters:
version - the version of this journal article

getTitle

public String getTitle()
Returns the title of this journal article.

Specified by:
getTitle in interface JournalArticleModel
Returns:
the title of this journal article

getTitle

public String getTitle(Locale locale)
Returns the localized title of this journal article in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getTitle in interface JournalArticleModel
Parameters:
locale - the locale of the language
Returns:
the localized title of this journal article

getTitle

public String getTitle(Locale locale,
                       boolean useDefault)
Returns the localized title of this journal article in the language, optionally using the default language if no localization exists for the requested language.

Specified by:
getTitle in interface JournalArticleModel
Parameters:
locale - the local of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized title of this journal article. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getTitle

public String getTitle(String languageId)
Returns the localized title of this journal article in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getTitle in interface JournalArticleModel
Parameters:
languageId - the ID of the language
Returns:
the localized title of this journal article

getTitle

public String getTitle(String languageId,
                       boolean useDefault)
Returns the localized title of this journal article in the language, optionally using the default language if no localization exists for the requested language.

Specified by:
getTitle in interface JournalArticleModel
Parameters:
languageId - the ID of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized title of this journal article

getTitleCurrentLanguageId

public String getTitleCurrentLanguageId()
Specified by:
getTitleCurrentLanguageId in interface JournalArticleModel

getTitleCurrentValue

public String getTitleCurrentValue()
Specified by:
getTitleCurrentValue in interface JournalArticleModel

getTitleMap

public Map<Locale,String> getTitleMap()
Returns a map of the locales and localized titles of this journal article.

Specified by:
getTitleMap in interface JournalArticle
Specified by:
getTitleMap in interface JournalArticleModel
Returns:
the locales and localized titles of this journal article

setTitle

public void setTitle(String title)
Sets the title of this journal article.

Specified by:
setTitle in interface JournalArticleModel
Parameters:
title - the title of this journal article

setTitle

public void setTitle(String title,
                     Locale locale)
Sets the localized title of this journal article in the language.

Specified by:
setTitle in interface JournalArticleModel
Parameters:
title - the localized title of this journal article
locale - the locale of the language

setTitle

public void setTitle(String title,
                     Locale locale,
                     Locale defaultLocale)
Sets the localized title of this journal article in the language, and sets the default locale.

Specified by:
setTitle in interface JournalArticleModel
Parameters:
title - the localized title of this journal article
locale - the locale of the language
defaultLocale - the default locale

setTitleCurrentLanguageId

public void setTitleCurrentLanguageId(String languageId)
Specified by:
setTitleCurrentLanguageId in interface JournalArticleModel

setTitleMap

public void setTitleMap(Map<Locale,String> titleMap)
Sets the localized titles of this journal article from the map of locales and localized titles.

Specified by:
setTitleMap in interface JournalArticleModel
Parameters:
titleMap - the locales and localized titles of this journal article

setTitleMap

public void setTitleMap(Map<Locale,String> titleMap,
                        Locale defaultLocale)
Sets the localized titles of this journal article from the map of locales and localized titles, and sets the default locale.

Specified by:
setTitleMap in interface JournalArticleModel
Parameters:
titleMap - the locales and localized titles of this journal article
defaultLocale - the default locale

getUrlTitle

public String getUrlTitle()
Returns the url title of this journal article.

Specified by:
getUrlTitle in interface JournalArticleModel
Returns:
the url title of this journal article

setUrlTitle

public void setUrlTitle(String urlTitle)
Sets the url title of this journal article.

Specified by:
setUrlTitle in interface JournalArticleModel
Parameters:
urlTitle - the url title of this journal article

getDescription

public String getDescription()
Returns the description of this journal article.

Specified by:
getDescription in interface JournalArticleModel
Returns:
the description of this journal article

getDescription

public String getDescription(Locale locale)
Returns the localized description of this journal article in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getDescription in interface JournalArticleModel
Parameters:
locale - the locale of the language
Returns:
the localized description of this journal article

getDescription

public String getDescription(Locale locale,
                             boolean useDefault)
Returns the localized description of this journal article in the language, optionally using the default language if no localization exists for the requested language.

Specified by:
getDescription in interface JournalArticleModel
Parameters:
locale - the local of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized description of this journal article. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getDescription

public String getDescription(String languageId)
Returns the localized description of this journal article in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getDescription in interface JournalArticleModel
Parameters:
languageId - the ID of the language
Returns:
the localized description of this journal article

getDescription

public String getDescription(String languageId,
                             boolean useDefault)
Returns the localized description of this journal article in the language, optionally using the default language if no localization exists for the requested language.

Specified by:
getDescription in interface JournalArticleModel
Parameters:
languageId - the ID of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized description of this journal article

getDescriptionCurrentLanguageId

public String getDescriptionCurrentLanguageId()
Specified by:
getDescriptionCurrentLanguageId in interface JournalArticleModel

getDescriptionCurrentValue

public String getDescriptionCurrentValue()
Specified by:
getDescriptionCurrentValue in interface JournalArticleModel

getDescriptionMap

public Map<Locale,String> getDescriptionMap()
Returns a map of the locales and localized descriptions of this journal article.

Specified by:
getDescriptionMap in interface JournalArticleModel
Returns:
the locales and localized descriptions of this journal article

setDescription

public void setDescription(String description)
Sets the description of this journal article.

Specified by:
setDescription in interface JournalArticleModel
Parameters:
description - the description of this journal article

setDescription

public void setDescription(String description,
                           Locale locale)
Sets the localized description of this journal article in the language.

Specified by:
setDescription in interface JournalArticleModel
Parameters:
description - the localized description of this journal article
locale - the locale of the language

setDescription

public void setDescription(String description,
                           Locale locale,
                           Locale defaultLocale)
Sets the localized description of this journal article in the language, and sets the default locale.

Specified by:
setDescription in interface JournalArticleModel
Parameters:
description - the localized description of this journal article
locale - the locale of the language
defaultLocale - the default locale

setDescriptionCurrentLanguageId

public void setDescriptionCurrentLanguageId(String languageId)
Specified by:
setDescriptionCurrentLanguageId in interface JournalArticleModel

setDescriptionMap

public void setDescriptionMap(Map<Locale,String> descriptionMap)
Sets the localized descriptions of this journal article from the map of locales and localized descriptions.

Specified by:
setDescriptionMap in interface JournalArticleModel
Parameters:
descriptionMap - the locales and localized descriptions of this journal article

setDescriptionMap

public void setDescriptionMap(Map<Locale,String> descriptionMap,
                              Locale defaultLocale)
Sets the localized descriptions of this journal article from the map of locales and localized descriptions, and sets the default locale.

Specified by:
setDescriptionMap in interface JournalArticleModel
Parameters:
descriptionMap - the locales and localized descriptions of this journal article
defaultLocale - the default locale

getContent

public String getContent()
Returns the content of this journal article.

Specified by:
getContent in interface JournalArticleModel
Returns:
the content of this journal article

setContent

public void setContent(String content)
Sets the content of this journal article.

Specified by:
setContent in interface JournalArticleModel
Parameters:
content - the content of this journal article

getType

public String getType()
Returns the type of this journal article.

Specified by:
getType in interface JournalArticleModel
Returns:
the type of this journal article

setType

public void setType(String type)
Sets the type of this journal article.

Specified by:
setType in interface JournalArticleModel
Parameters:
type - the type of this journal article

getStructureId

public String getStructureId()
Returns the structure ID of this journal article.

Specified by:
getStructureId in interface JournalArticleModel
Returns:
the structure ID of this journal article

setStructureId

public void setStructureId(String structureId)
Sets the structure ID of this journal article.

Specified by:
setStructureId in interface JournalArticleModel
Parameters:
structureId - the structure ID of this journal article

getTemplateId

public String getTemplateId()
Returns the template ID of this journal article.

Specified by:
getTemplateId in interface JournalArticleModel
Returns:
the template ID of this journal article

setTemplateId

public void setTemplateId(String templateId)
Sets the template ID of this journal article.

Specified by:
setTemplateId in interface JournalArticleModel
Parameters:
templateId - the template ID of this journal article

getLayoutUuid

public String getLayoutUuid()
Returns the layout uuid of this journal article.

Specified by:
getLayoutUuid in interface JournalArticleModel
Returns:
the layout uuid of this journal article

setLayoutUuid

public void setLayoutUuid(String layoutUuid)
Sets the layout uuid of this journal article.

Specified by:
setLayoutUuid in interface JournalArticleModel
Parameters:
layoutUuid - the layout uuid of this journal article

getDisplayDate

public Date getDisplayDate()
Returns the display date of this journal article.

Specified by:
getDisplayDate in interface JournalArticleModel
Returns:
the display date of this journal article

setDisplayDate

public void setDisplayDate(Date displayDate)
Sets the display date of this journal article.

Specified by:
setDisplayDate in interface JournalArticleModel
Parameters:
displayDate - the display date of this journal article

getExpirationDate

public Date getExpirationDate()
Returns the expiration date of this journal article.

Specified by:
getExpirationDate in interface JournalArticleModel
Returns:
the expiration date of this journal article

setExpirationDate

public void setExpirationDate(Date expirationDate)
Sets the expiration date of this journal article.

Specified by:
setExpirationDate in interface JournalArticleModel
Parameters:
expirationDate - the expiration date of this journal article

getReviewDate

public Date getReviewDate()
Returns the review date of this journal article.

Specified by:
getReviewDate in interface JournalArticleModel
Returns:
the review date of this journal article

setReviewDate

public void setReviewDate(Date reviewDate)
Sets the review date of this journal article.

Specified by:
setReviewDate in interface JournalArticleModel
Parameters:
reviewDate - the review date of this journal article

getIndexable

public boolean getIndexable()
Returns the indexable of this journal article.

Specified by:
getIndexable in interface JournalArticleModel
Returns:
the indexable of this journal article

isIndexable

public boolean isIndexable()
Returns true if this journal article is indexable.

Specified by:
isIndexable in interface JournalArticleModel
Returns:
true if this journal article is indexable; false otherwise

setIndexable

public void setIndexable(boolean indexable)
Sets whether this journal article is indexable.

Specified by:
setIndexable in interface JournalArticleModel
Parameters:
indexable - the indexable of this journal article

getSmallImage

public boolean getSmallImage()
Returns the small image of this journal article.

Specified by:
getSmallImage in interface JournalArticleModel
Returns:
the small image of this journal article

isSmallImage

public boolean isSmallImage()
Returns true if this journal article is small image.

Specified by:
isSmallImage in interface JournalArticleModel
Returns:
true if this journal article is small image; false otherwise

setSmallImage

public void setSmallImage(boolean smallImage)
Sets whether this journal article is small image.

Specified by:
setSmallImage in interface JournalArticleModel
Parameters:
smallImage - the small image of this journal article

getSmallImageId

public long getSmallImageId()
Returns the small image ID of this journal article.

Specified by:
getSmallImageId in interface JournalArticleModel
Returns:
the small image ID of this journal article

setSmallImageId

public void setSmallImageId(long smallImageId)
Sets the small image ID of this journal article.

Specified by:
setSmallImageId in interface JournalArticleModel
Parameters:
smallImageId - the small image ID of this journal article

getSmallImageURL

public String getSmallImageURL()
Returns the small image u r l of this journal article.

Specified by:
getSmallImageURL in interface JournalArticleModel
Returns:
the small image u r l of this journal article

setSmallImageURL

public void setSmallImageURL(String smallImageURL)
Sets the small image u r l of this journal article.

Specified by:
setSmallImageURL in interface JournalArticleModel
Parameters:
smallImageURL - the small image u r l of this journal article

getStatus

public int getStatus()
Returns the status of this journal article.

Specified by:
getStatus in interface WorkflowedModel
Specified by:
getStatus in interface JournalArticleModel
Returns:
the status of this journal article

setStatus

public void setStatus(int status)
Sets the status of this journal article.

Specified by:
setStatus in interface WorkflowedModel
Specified by:
setStatus in interface JournalArticleModel
Parameters:
status - the status of this journal article

getStatusByUserId

public long getStatusByUserId()
Returns the status by user ID of this journal article.

Specified by:
getStatusByUserId in interface WorkflowedModel
Specified by:
getStatusByUserId in interface JournalArticleModel
Returns:
the status by user ID of this journal article

setStatusByUserId

public void setStatusByUserId(long statusByUserId)
Sets the status by user ID of this journal article.

Specified by:
setStatusByUserId in interface WorkflowedModel
Specified by:
setStatusByUserId in interface JournalArticleModel
Parameters:
statusByUserId - the status by user ID of this journal article

getStatusByUserUuid

public String getStatusByUserUuid()
                           throws SystemException
Returns the status by user uuid of this journal article.

Specified by:
getStatusByUserUuid in interface JournalArticleModel
Returns:
the status by user uuid of this journal article
Throws:
SystemException - if a system exception occurred

setStatusByUserUuid

public void setStatusByUserUuid(String statusByUserUuid)
Sets the status by user uuid of this journal article.

Specified by:
setStatusByUserUuid in interface JournalArticleModel
Parameters:
statusByUserUuid - the status by user uuid of this journal article

getStatusByUserName

public String getStatusByUserName()
Returns the status by user name of this journal article.

Specified by:
getStatusByUserName in interface WorkflowedModel
Specified by:
getStatusByUserName in interface JournalArticleModel
Returns:
the status by user name of this journal article

setStatusByUserName

public void setStatusByUserName(String statusByUserName)
Sets the status by user name of this journal article.

Specified by:
setStatusByUserName in interface WorkflowedModel
Specified by:
setStatusByUserName in interface JournalArticleModel
Parameters:
statusByUserName - the status by user name of this journal article

getStatusDate

public Date getStatusDate()
Returns the status date of this journal article.

Specified by:
getStatusDate in interface WorkflowedModel
Specified by:
getStatusDate in interface JournalArticleModel
Returns:
the status date of this journal article

setStatusDate

public void setStatusDate(Date statusDate)
Sets the status date of this journal article.

Specified by:
setStatusDate in interface WorkflowedModel
Specified by:
setStatusDate in interface JournalArticleModel
Parameters:
statusDate - the status date of this journal article

getApproved

public boolean getApproved()
Deprecated. Renamed to isApproved()

Specified by:
getApproved in interface JournalArticleModel

isApproved

public boolean isApproved()
Returns true if this journal article is approved.

Specified by:
isApproved in interface WorkflowedModel
Specified by:
isApproved in interface JournalArticleModel
Returns:
true if this journal article is approved; false otherwise

isDenied

public boolean isDenied()
Returns true if this journal article is denied.

Specified by:
isDenied in interface JournalArticleModel
Returns:
true if this journal article is denied; false otherwise

isDraft

public boolean isDraft()
Returns true if this journal article is a draft.

Specified by:
isDraft in interface WorkflowedModel
Specified by:
isDraft in interface JournalArticleModel
Returns:
true if this journal article is a draft; false otherwise

isExpired

public boolean isExpired()
Returns true if this journal article is expired.

Specified by:
isExpired in interface WorkflowedModel
Specified by:
isExpired in interface JournalArticleModel
Returns:
true if this journal article is expired; false otherwise

isInactive

public boolean isInactive()
Returns true if this journal article is inactive.

Specified by:
isInactive in interface JournalArticleModel
Returns:
true if this journal article is inactive; false otherwise

isIncomplete

public boolean isIncomplete()
Returns true if this journal article is incomplete.

Specified by:
isIncomplete in interface JournalArticleModel
Returns:
true if this journal article is incomplete; false otherwise

isPending

public boolean isPending()
Returns true if this journal article is pending.

Specified by:
isPending in interface WorkflowedModel
Specified by:
isPending in interface JournalArticleModel
Returns:
true if this journal article is pending; false otherwise

isScheduled

public boolean isScheduled()
Returns true if this journal article is scheduled.

Specified by:
isScheduled in interface JournalArticleModel
Returns:
true if this journal article is scheduled; false otherwise

isNew

public 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<JournalArticle>
Specified by:
isNew in interface JournalArticleModel
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

public 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>
Specified by:
setNew in interface JournalArticleModel
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

public 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<JournalArticle>
Specified by:
isCachedModel in interface JournalArticleModel
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

public 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>
Specified by:
setCachedModel in interface JournalArticleModel
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

public boolean isEscapedModel()
Description copied from interface: BaseModel
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<JournalArticle>
Specified by:
isEscapedModel in interface JournalArticleModel
Returns:
true if this model instance is escaped; false otherwise

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Returns the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<JournalArticle>
Specified by:
getPrimaryKeyObj in interface ClassedModel
Specified by:
getPrimaryKeyObj in interface JournalArticleModel
Returns:
the primary key of this model instance

setPrimaryKeyObj

public void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface BaseModel<JournalArticle>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Specified by:
setPrimaryKeyObj in interface JournalArticleModel
Parameters:
primaryKeyObj - the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Returns the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<JournalArticle>
Specified by:
getExpandoBridge in interface ClassedModel
Specified by:
getExpandoBridge in interface JournalArticleModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

public 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>
Specified by:
setExpandoBridgeAttributes in interface JournalArticleModel
Parameters:
serviceContext - the service context
See Also:
ServiceContext.getExpandoBridgeAttributes( )

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException
Specified by:
prepareLocalizedFieldsForImport in interface JournalArticle
Specified by:
prepareLocalizedFieldsForImport in interface JournalArticleModel
Throws:
LocaleException

clone

public Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<JournalArticle>
Specified by:
clone in interface JournalArticleModel
Overrides:
clone in class Object
Returns:
the shallow clone of this model instance

compareTo

public int compareTo(JournalArticle journalArticle)
Specified by:
compareTo in interface JournalArticleModel
Specified by:
compareTo in interface Comparable<JournalArticle>

hashCode

public int hashCode()
Specified by:
hashCode in interface JournalArticleModel
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

public JournalArticle 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<JournalArticle>
Specified by:
toEscapedModel in interface JournalArticleModel
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

public JournalArticle toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<JournalArticle>
Specified by:
toUnescapedModel in interface JournalArticleModel

toString

public String toString()
Specified by:
toString in interface JournalArticleModel
Overrides:
toString in class Object

toXmlString

public String toXmlString()
Description copied from interface: BaseModel
Returns the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<JournalArticle>
Specified by:
toXmlString in interface JournalArticleModel
Returns:
the XML representation of this model instance

persist

public void persist()
             throws SystemException
Description copied from interface: PersistedModel
Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:
persist in interface PersistedModel
Throws:
SystemException - if a system exception occurred

getArticleResource

public JournalArticleResource getArticleResource()
                                          throws PortalException,
                                                 SystemException
Specified by:
getArticleResource in interface JournalArticle
Throws:
PortalException
SystemException

getArticleResourceUuid

public String getArticleResourceUuid()
                              throws PortalException,
                                     SystemException
Specified by:
getArticleResourceUuid in interface JournalArticle
Throws:
PortalException
SystemException

getAvailableLocales

public String[] getAvailableLocales()
Specified by:
getAvailableLocales in interface JournalArticle

getContentByLocale

public String getContentByLocale(String languageId)
Specified by:
getContentByLocale in interface JournalArticle

getDefaultLocale

public String getDefaultLocale()
Specified by:
getDefaultLocale in interface JournalArticle

getSmallImageType

public String getSmallImageType()
                         throws PortalException,
                                SystemException
Specified by:
getSmallImageType in interface JournalArticle
Throws:
PortalException
SystemException

isTemplateDriven

public boolean isTemplateDriven()
Specified by:
isTemplateDriven in interface JournalArticle

setSmallImageType

public void setSmallImageType(String smallImageType)
Specified by:
setSmallImageType in interface JournalArticle

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

getWrappedJournalArticle

public JournalArticle getWrappedJournalArticle()
Deprecated. Renamed to getWrappedModel()


getWrappedModel

public JournalArticle getWrappedModel()
Specified by:
getWrappedModel in interface ModelWrapper<JournalArticle>

resetOriginalValues

public void resetOriginalValues()
Description copied from interface: BaseModel
Reset all original fields to current values.

Specified by:
resetOriginalValues in interface BaseModel<JournalArticle>

Liferay 6.1.2-ce-ga3