|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JournalArticleModel
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
.
JournalArticle
,
JournalArticleImpl
,
JournalArticleModelImpl
Method Summary | |
---|---|
Object |
clone()
Creates a shallow clone of this model instance. |
int |
compareTo(JournalArticle journalArticle)
|
boolean |
getApproved()
Deprecated. Renamed to isApproved() |
String |
getArticleId()
Returns the article ID of this journal article. |
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. |
Date |
getCreateDate()
Returns the create date of this journal article. |
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. |
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 |
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. |
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. |
void |
prepareLocalizedFieldsForImport(Locale defaultImportLocale)
|
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 |
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 |
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 interface com.liferay.portal.model.BaseModel |
---|
getModelAttributes, resetOriginalValues, setModelAttributes |
Methods inherited from interface com.liferay.portal.model.ClassedModel |
---|
getModelClass, getModelClassName |
Method Detail |
---|
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this journal article@AutoEscape String getUuid()
void setUuid(String uuid)
uuid
- the uuid of this journal articlelong getId()
void setId(long id)
id
- the ID of this journal articlelong getResourcePrimKey()
getResourcePrimKey
in interface ResourcedModel
void setResourcePrimKey(long resourcePrimKey)
resourcePrimKey
- the resource prim key of this journal articleboolean isResourceMain()
isResourceMain
in interface ResourcedModel
long getGroupId()
getGroupId
in interface GroupedModel
void setGroupId(long groupId)
setGroupId
in interface GroupedModel
groupId
- the group ID of this journal articlelong getCompanyId()
getCompanyId
in interface AuditedModel
void setCompanyId(long companyId)
setCompanyId
in interface AuditedModel
companyId
- the company ID of this journal articlelong getUserId()
getUserId
in interface AuditedModel
void setUserId(long userId)
setUserId
in interface AuditedModel
userId
- the user ID of this journal articleString getUserUuid() throws SystemException
getUserUuid
in interface AuditedModel
SystemException
- if a system exception occurredvoid setUserUuid(String userUuid)
setUserUuid
in interface AuditedModel
userUuid
- the user uuid of this journal article@AutoEscape String getUserName()
getUserName
in interface AuditedModel
void setUserName(String userName)
setUserName
in interface AuditedModel
userName
- the user name of this journal articleDate getCreateDate()
getCreateDate
in interface AuditedModel
void setCreateDate(Date createDate)
setCreateDate
in interface AuditedModel
createDate
- the create date of this journal articleDate getModifiedDate()
getModifiedDate
in interface AuditedModel
void setModifiedDate(Date modifiedDate)
setModifiedDate
in interface AuditedModel
modifiedDate
- the modified date of this journal articleString getClassName()
getClassName
in interface AttachedModel
void setClassName(String className)
long getClassNameId()
getClassNameId
in interface AttachedModel
void setClassNameId(long classNameId)
setClassNameId
in interface AttachedModel
classNameId
- the class name ID of this journal articlelong getClassPK()
getClassPK
in interface AttachedModel
void setClassPK(long classPK)
setClassPK
in interface AttachedModel
classPK
- the class p k of this journal articleString getArticleId()
void setArticleId(String articleId)
articleId
- the article ID of this journal articledouble getVersion()
void setVersion(double version)
version
- the version of this journal articleString getTitle()
@AutoEscape String getTitle(Locale locale)
locale
- the locale of the language
@AutoEscape String getTitle(Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language
useDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape String getTitle(String languageId)
languageId
- the ID of the language
@AutoEscape String getTitle(String languageId, boolean useDefault)
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language
@AutoEscape String getTitleCurrentLanguageId()
@AutoEscape String getTitleCurrentValue()
Map<Locale,String> getTitleMap()
void setTitle(String title)
title
- the title of this journal articlevoid setTitle(String title, Locale locale)
title
- the localized title of this journal articlelocale
- the locale of the languagevoid setTitle(String title, Locale locale, Locale defaultLocale)
title
- the localized title of this journal articlelocale
- the locale of the languagedefaultLocale
- the default localevoid setTitleCurrentLanguageId(String languageId)
void setTitleMap(Map<Locale,String> titleMap)
titleMap
- the locales and localized titles of this journal articlevoid setTitleMap(Map<Locale,String> titleMap, Locale defaultLocale)
titleMap
- the locales and localized titles of this journal articledefaultLocale
- the default locale@AutoEscape String getUrlTitle()
void setUrlTitle(String urlTitle)
urlTitle
- the url title of this journal articleString getDescription()
@AutoEscape String getDescription(Locale locale)
locale
- the locale of the language
@AutoEscape String getDescription(Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language
useDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape String getDescription(String languageId)
languageId
- the ID of the language
@AutoEscape String getDescription(String languageId, boolean useDefault)
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language
@AutoEscape String getDescriptionCurrentLanguageId()
@AutoEscape String getDescriptionCurrentValue()
Map<Locale,String> getDescriptionMap()
void setDescription(String description)
description
- the description of this journal articlevoid setDescription(String description, Locale locale)
description
- the localized description of this journal articlelocale
- the locale of the languagevoid setDescription(String description, Locale locale, Locale defaultLocale)
description
- the localized description of this journal articlelocale
- the locale of the languagedefaultLocale
- the default localevoid setDescriptionCurrentLanguageId(String languageId)
void setDescriptionMap(Map<Locale,String> descriptionMap)
descriptionMap
- the locales and localized descriptions of this journal articlevoid setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
descriptionMap
- the locales and localized descriptions of this journal articledefaultLocale
- the default locale@AutoEscape String getContent()
void setContent(String content)
content
- the content of this journal article@AutoEscape String getType()
void setType(String type)
type
- the type of this journal articleString getStructureId()
void setStructureId(String structureId)
structureId
- the structure ID of this journal articleString getTemplateId()
void setTemplateId(String templateId)
templateId
- the template ID of this journal article@AutoEscape String getLayoutUuid()
void setLayoutUuid(String layoutUuid)
layoutUuid
- the layout uuid of this journal articleDate getDisplayDate()
void setDisplayDate(Date displayDate)
displayDate
- the display date of this journal articleDate getExpirationDate()
void setExpirationDate(Date expirationDate)
expirationDate
- the expiration date of this journal articleDate getReviewDate()
void setReviewDate(Date reviewDate)
reviewDate
- the review date of this journal articleboolean getIndexable()
boolean isIndexable()
true
if this journal article is indexable.
true
if this journal article is indexable; false
otherwisevoid setIndexable(boolean indexable)
indexable
- the indexable of this journal articleboolean getSmallImage()
boolean isSmallImage()
true
if this journal article is small image.
true
if this journal article is small image; false
otherwisevoid setSmallImage(boolean smallImage)
smallImage
- the small image of this journal articlelong getSmallImageId()
void setSmallImageId(long smallImageId)
smallImageId
- the small image ID of this journal article@AutoEscape String getSmallImageURL()
void setSmallImageURL(String smallImageURL)
smallImageURL
- the small image u r l of this journal articleint getStatus()
getStatus
in interface WorkflowedModel
void setStatus(int status)
setStatus
in interface WorkflowedModel
status
- the status of this journal articlelong getStatusByUserId()
getStatusByUserId
in interface WorkflowedModel
void setStatusByUserId(long statusByUserId)
setStatusByUserId
in interface WorkflowedModel
statusByUserId
- the status by user ID of this journal articleString getStatusByUserUuid() throws SystemException
SystemException
- if a system exception occurredvoid setStatusByUserUuid(String statusByUserUuid)
statusByUserUuid
- the status by user uuid of this journal article@AutoEscape String getStatusByUserName()
getStatusByUserName
in interface WorkflowedModel
void setStatusByUserName(String statusByUserName)
setStatusByUserName
in interface WorkflowedModel
statusByUserName
- the status by user name of this journal articleDate getStatusDate()
getStatusDate
in interface WorkflowedModel
void setStatusDate(Date statusDate)
setStatusDate
in interface WorkflowedModel
statusDate
- the status date of this journal articleboolean getApproved()
isApproved()
boolean isApproved()
true
if this journal article is approved.
isApproved
in interface WorkflowedModel
true
if this journal article is approved; false
otherwiseboolean isDenied()
true
if this journal article is denied.
true
if this journal article is denied; false
otherwiseboolean isDraft()
true
if this journal article is a draft.
isDraft
in interface WorkflowedModel
true
if this journal article is a draft; false
otherwiseboolean isExpired()
true
if this journal article is expired.
isExpired
in interface WorkflowedModel
true
if this journal article is expired; false
otherwiseboolean isInactive()
true
if this journal article is inactive.
true
if this journal article is inactive; false
otherwiseboolean isIncomplete()
true
if this journal article is incomplete.
true
if this journal article is incomplete; false
otherwiseboolean isPending()
true
if this journal article is pending.
isPending
in interface WorkflowedModel
true
if this journal article is pending; false
otherwiseboolean isScheduled()
true
if this journal article is scheduled.
true
if this journal article is scheduled; false
otherwiseboolean isNew()
BaseModel
true
if this model instance does not yet exist in
the database.
isNew
in interface BaseModel<JournalArticle>
true
if this model instance does not yet exist in
the database; false
otherwisevoid setNew(boolean n)
BaseModel
setNew
in interface BaseModel<JournalArticle>
n
- whether this model instance does not yet exist in the databaseboolean isCachedModel()
BaseModel
true
if this model instance was retrieved from the
entity cache.
isCachedModel
in interface BaseModel<JournalArticle>
true
if this model instance was retrieved from the
entity cache; false
otherwiseBaseModel.setCachedModel(boolean)
void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel
in interface BaseModel<JournalArticle>
cachedModel
- whether this model instance was retrieved from the
entity cacheEntityCache
boolean isEscapedModel()
BaseModel
true
if this model instance is escaped.
isEscapedModel
in interface BaseModel<JournalArticle>
true
if this model instance is escaped;
false
otherwiseSerializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj
in interface BaseModel<JournalArticle>
getPrimaryKeyObj
in interface ClassedModel
void setPrimaryKeyObj(Serializable primaryKeyObj)
BaseModel
setPrimaryKeyObj
in interface BaseModel<JournalArticle>
setPrimaryKeyObj
in interface ClassedModel
primaryKeyObj
- the primary key of this model instanceExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge
in interface BaseModel<JournalArticle>
getExpandoBridge
in interface ClassedModel
void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes
in interface BaseModel<JournalArticle>
serviceContext
- the service contextServiceContext.getExpandoBridgeAttributes(
)
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws LocaleException
LocaleException
Object clone()
BaseModel
clone
in interface BaseModel<JournalArticle>
int compareTo(JournalArticle journalArticle)
compareTo
in interface Comparable<JournalArticle>
int hashCode()
hashCode
in class Object
CacheModel<JournalArticle> toCacheModel()
BaseModel
toCacheModel
in interface BaseModel<JournalArticle>
JournalArticle toEscapedModel()
BaseModel
AutoEscapeBeanHandler
.
toEscapedModel
in interface BaseModel<JournalArticle>
AutoEscapeBeanHandler
JournalArticle toUnescapedModel()
toUnescapedModel
in interface BaseModel<JournalArticle>
String toString()
toString
in class Object
String toXmlString()
BaseModel
toXmlString
in interface BaseModel<JournalArticle>
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |