com.liferay.portlet.journal.model
Interface JournalTemplateModel

All Superinterfaces:

AuditedModel, BaseModel<JournalTemplate>, ClassedModel, Cloneable, Comparable<JournalTemplate>, GroupedModel, Serializable

All Known Subinterfaces:

JournalTemplate

All Known Implementing Classes:

JournalTemplateWrapper

public interface JournalTemplateModel
extends BaseModel<JournalTemplate>, GroupedModel

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

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

See Also:

JournalTemplate, JournalTemplateImpl, JournalTemplateModelImpl

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(JournalTemplate journalTemplate)
boolean	getCacheable() Returns the cacheable of this journal template.
long	getCompanyId() Returns the company ID of this journal template.
Date	getCreateDate() Returns the create date of this journal template.
String	getDescription() Returns the description of this journal template.
String	getDescription(Locale locale) Returns the localized description of this journal template in the language.
String	getDescription(Locale locale, boolean useDefault) Returns the localized description of this journal template 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 template in the language.
String	getDescription(String languageId, boolean useDefault) Returns the localized description of this journal template 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 template.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
long	getGroupId() Returns the group ID of this journal template.
long	getId() Returns the ID of this journal template.
String	getLangType() Returns the lang type of this journal template.
Date	getModifiedDate() Returns the modified date of this journal template.
String	getName() Returns the name of this journal template.
String	getName(Locale locale) Returns the localized name of this journal template in the language.
String	getName(Locale locale, boolean useDefault) Returns the localized name of this journal template in the language, optionally using the default language if no localization exists for the requested language.
String	getName(String languageId) Returns the localized name of this journal template in the language.
String	getName(String languageId, boolean useDefault) Returns the localized name of this journal template in the language, optionally using the default language if no localization exists for the requested language.
String	getNameCurrentLanguageId()
String	getNameCurrentValue()
Map<Locale,String>	getNameMap() Returns a map of the locales and localized names of this journal template.
long	getPrimaryKey() Returns the primary key of this journal template.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
boolean	getSmallImage() Returns the small image of this journal template.
long	getSmallImageId() Returns the small image ID of this journal template.
String	getSmallImageURL() Returns the small image u r l of this journal template.
String	getStructureId() Returns the structure ID of this journal template.
String	getTemplateId() Returns the template ID of this journal template.
long	getUserId() Returns the user ID of this journal template.
String	getUserName() Returns the user name of this journal template.
String	getUserUuid() Returns the user uuid of this journal template.
String	getUuid() Returns the uuid of this journal template.
String	getXsl() Returns the xsl of this journal template.
int	hashCode()
boolean	isCacheable() Returns true if this journal template is cacheable.
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
boolean	isSmallImage() Returns true if this journal template is small image.
void	prepareLocalizedFieldsForImport(Locale defaultImportLocale)
void	setCacheable(boolean cacheable) Sets whether this journal template is cacheable.
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 template.
void	setCreateDate(Date createDate) Sets the create date of this journal template.
void	setDescription(String description) Sets the description of this journal template.
void	setDescription(String description, Locale locale) Sets the localized description of this journal template in the language.
void	setDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this journal template 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 template from the map of locales and localized descriptions.
void	setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this journal template from the map of locales and localized descriptions, and sets the default locale.
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setGroupId(long groupId) Sets the group ID of this journal template.
void	setId(long id) Sets the ID of this journal template.
void	setLangType(String langType) Sets the lang type of this journal template.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this journal template.
void	setName(String name) Sets the name of this journal template.
void	setName(String name, Locale locale) Sets the localized name of this journal template in the language.
void	setName(String name, Locale locale, Locale defaultLocale) Sets the localized name of this journal template in the language, and sets the default locale.
void	setNameCurrentLanguageId(String languageId)
void	setNameMap(Map<Locale,String> nameMap) Sets the localized names of this journal template from the map of locales and localized names.
void	setNameMap(Map<Locale,String> nameMap, Locale defaultLocale) Sets the localized names of this journal template from the map of locales and localized names, and sets the default locale.
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 template.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setSmallImage(boolean smallImage) Sets whether this journal template is small image.
void	setSmallImageId(long smallImageId) Sets the small image ID of this journal template.
void	setSmallImageURL(String smallImageURL) Sets the small image u r l of this journal template.
void	setStructureId(String structureId) Sets the structure ID of this journal template.
void	setTemplateId(String templateId) Sets the template ID of this journal template.
void	setUserId(long userId) Sets the user ID of this journal template.
void	setUserName(String userName) Sets the user name of this journal template.
void	setUserUuid(String userUuid) Sets the user uuid of this journal template.
void	setUuid(String uuid) Sets the uuid of this journal template.
void	setXsl(String xsl) Sets the xsl of this journal template.
CacheModel<JournalTemplate>	toCacheModel() Returns a cache model object for this entity used by entity cache.
JournalTemplate	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
JournalTemplate	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

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this journal template.

Returns:

the primary key of this journal template

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this journal template.

Parameters:

primaryKey - the primary key of this journal template

getUuid

@AutoEscape
String getUuid()

Returns the uuid of this journal template.

Returns:

the uuid of this journal template

setUuid

void setUuid(String uuid)

Sets the uuid of this journal template.

Parameters:

uuid - the uuid of this journal template

getId

long getId()

Returns the ID of this journal template.

Returns:

the ID of this journal template

setId

void setId(long id)

Sets the ID of this journal template.

Parameters:

id - the ID of this journal template

getGroupId

long getGroupId()

Returns the group ID of this journal template.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this journal template

setGroupId

void setGroupId(long groupId)

Sets the group ID of this journal template.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this journal template

getCompanyId

long getCompanyId()

Returns the company ID of this journal template.

Specified by:

getCompanyId in interface AuditedModel

Returns:

the company ID of this journal template

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this journal template.

Specified by:

setCompanyId in interface AuditedModel

Parameters:

companyId - the company ID of this journal template

getUserId

long getUserId()

Returns the user ID of this journal template.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this journal template

setUserId

void setUserId(long userId)

Sets the user ID of this journal template.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this journal template

getUserUuid

String getUserUuid()
                   throws SystemException

Returns the user uuid of this journal template.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this journal template

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this journal template.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this journal template

getUserName

@AutoEscape
String getUserName()

Returns the user name of this journal template.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this journal template

setUserName

void setUserName(String userName)

Sets the user name of this journal template.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this journal template

getCreateDate

Date getCreateDate()

Returns the create date of this journal template.

Specified by:

getCreateDate in interface AuditedModel

Returns:

the create date of this journal template

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this journal template.

Specified by:

setCreateDate in interface AuditedModel

Parameters:

createDate - the create date of this journal template

getModifiedDate

Date getModifiedDate()

Returns the modified date of this journal template.

Specified by:

getModifiedDate in interface AuditedModel

Returns:

the modified date of this journal template

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this journal template.

Specified by:

setModifiedDate in interface AuditedModel

Parameters:

modifiedDate - the modified date of this journal template

getTemplateId

String getTemplateId()

Returns the template ID of this journal template.

Returns:

the template ID of this journal template

setTemplateId

void setTemplateId(String templateId)

Sets the template ID of this journal template.

Parameters:

templateId - the template ID of this journal template

getStructureId

String getStructureId()

Returns the structure ID of this journal template.

Returns:

the structure ID of this journal template

setStructureId

void setStructureId(String structureId)

Sets the structure ID of this journal template.

Parameters:

structureId - the structure ID of this journal template

getName

String getName()

Returns the name of this journal template.

Returns:

the name of this journal template

getName

@AutoEscape
String getName(Locale locale)

Returns the localized name of this journal template in the language. Uses the default language if no localization exists for the requested language.

Parameters:

locale - the locale of the language

Returns:

the localized name of this journal template

getName

@AutoEscape
String getName(Locale locale,
                          boolean useDefault)

Returns the localized name of this journal template in the language, optionally using the default language if no localization exists for the requested language.

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 name of this journal template. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getName

@AutoEscape
String getName(String languageId)

Returns the localized name of this journal template in the language. Uses the default language if no localization exists for the requested language.

Parameters:

languageId - the ID of the language

Returns:

the localized name of this journal template

getName

@AutoEscape
String getName(String languageId,
                          boolean useDefault)

Returns the localized name of this journal template in the language, optionally using the default language if no localization exists for the requested language.

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 name of this journal template

getNameCurrentLanguageId

@AutoEscape
String getNameCurrentLanguageId()

getNameCurrentValue

@AutoEscape
String getNameCurrentValue()

getNameMap

Map<Locale,String> getNameMap()

Returns a map of the locales and localized names of this journal template.

Returns:

the locales and localized names of this journal template

setName

void setName(String name)

Sets the name of this journal template.

Parameters:

name - the name of this journal template

setName

void setName(String name,
             Locale locale)

Sets the localized name of this journal template in the language.

Parameters:

name - the localized name of this journal template

locale - the locale of the language

setName

void setName(String name,
             Locale locale,
             Locale defaultLocale)

Sets the localized name of this journal template in the language, and sets the default locale.

Parameters:

name - the localized name of this journal template

locale - the locale of the language

defaultLocale - the default locale

setNameCurrentLanguageId

void setNameCurrentLanguageId(String languageId)

setNameMap

void setNameMap(Map<Locale,String> nameMap)

Sets the localized names of this journal template from the map of locales and localized names.

Parameters:

nameMap - the locales and localized names of this journal template

setNameMap

void setNameMap(Map<Locale,String> nameMap,
                Locale defaultLocale)

Sets the localized names of this journal template from the map of locales and localized names, and sets the default locale.

Parameters:

nameMap - the locales and localized names of this journal template

defaultLocale - the default locale

getDescription

String getDescription()

Returns the description of this journal template.

Returns:

the description of this journal template

getDescription

@AutoEscape
String getDescription(Locale locale)

Returns the localized description of this journal template in the language. Uses the default language if no localization exists for the requested language.

Parameters:

locale - the locale of the language

Returns:

the localized description of this journal template

getDescription

@AutoEscape
String getDescription(Locale locale,
                                 boolean useDefault)

Returns the localized description of this journal template in the language, optionally using the default language if no localization exists for the requested language.

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 template. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getDescription

@AutoEscape
String getDescription(String languageId)

Returns the localized description of this journal template in the language. Uses the default language if no localization exists for the requested language.

Parameters:

languageId - the ID of the language

Returns:

the localized description of this journal template

getDescription

@AutoEscape
String getDescription(String languageId,
                                 boolean useDefault)

Returns the localized description of this journal template in the language, optionally using the default language if no localization exists for the requested language.

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 template

getDescriptionCurrentLanguageId

@AutoEscape
String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

@AutoEscape
String getDescriptionCurrentValue()

getDescriptionMap

Map<Locale,String> getDescriptionMap()

Returns a map of the locales and localized descriptions of this journal template.

Returns:

the locales and localized descriptions of this journal template

setDescription

void setDescription(String description)

Sets the description of this journal template.

Parameters:

description - the description of this journal template

setDescription

void setDescription(String description,
                    Locale locale)

Sets the localized description of this journal template in the language.

Parameters:

description - the localized description of this journal template

locale - the locale of the language

setDescription

void setDescription(String description,
                    Locale locale,
                    Locale defaultLocale)

Sets the localized description of this journal template in the language, and sets the default locale.

Parameters:

description - the localized description of this journal template

locale - the locale of the language

defaultLocale - the default locale

setDescriptionCurrentLanguageId

void setDescriptionCurrentLanguageId(String languageId)

setDescriptionMap

void setDescriptionMap(Map<Locale,String> descriptionMap)

Sets the localized descriptions of this journal template from the map of locales and localized descriptions.

Parameters:

descriptionMap - the locales and localized descriptions of this journal template

setDescriptionMap

void setDescriptionMap(Map<Locale,String> descriptionMap,
                       Locale defaultLocale)

Sets the localized descriptions of this journal template from the map of locales and localized descriptions, and sets the default locale.

Parameters:

descriptionMap - the locales and localized descriptions of this journal template

defaultLocale - the default locale

getXsl

@AutoEscape
String getXsl()

Returns the xsl of this journal template.

Returns:

the xsl of this journal template

setXsl

void setXsl(String xsl)

Sets the xsl of this journal template.

Parameters:

xsl - the xsl of this journal template

getLangType

@AutoEscape
String getLangType()

Returns the lang type of this journal template.

Returns:

the lang type of this journal template

setLangType

void setLangType(String langType)

Sets the lang type of this journal template.

Parameters:

langType - the lang type of this journal template

getCacheable

boolean getCacheable()

Returns the cacheable of this journal template.

Returns:

the cacheable of this journal template

isCacheable

boolean isCacheable()

Returns true if this journal template is cacheable.

Returns:

true if this journal template is cacheable; false otherwise

setCacheable

void setCacheable(boolean cacheable)

Sets whether this journal template is cacheable.

Parameters:

cacheable - the cacheable of this journal template

getSmallImage

boolean getSmallImage()

Returns the small image of this journal template.

Returns:

the small image of this journal template

isSmallImage

boolean isSmallImage()

Returns true if this journal template is small image.

Returns:

true if this journal template is small image; false otherwise

setSmallImage

void setSmallImage(boolean smallImage)

Sets whether this journal template is small image.

Parameters:

smallImage - the small image of this journal template

getSmallImageId

long getSmallImageId()

Returns the small image ID of this journal template.

Returns:

the small image ID of this journal template

setSmallImageId

void setSmallImageId(long smallImageId)

Sets the small image ID of this journal template.

Parameters:

smallImageId - the small image ID of this journal template

getSmallImageURL

@AutoEscape
String getSmallImageURL()

Returns the small image u r l of this journal template.

Returns:

the small image u r l of this journal template

setSmallImageURL

void setSmallImageURL(String smallImageURL)

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

Parameters:

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

isNew

boolean isNew()

Description copied from interface: BaseModel

Returns true if this model instance does not yet exist in the database.

Specified by:

isNew in interface BaseModel<JournalTemplate>

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

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()

Description copied from interface: BaseModel

Returns true if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<JournalTemplate>

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

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<JournalTemplate>

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<JournalTemplate>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<JournalTemplate>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<JournalTemplate>

Specified by:

getExpandoBridge in interface ClassedModel

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

Parameters:

serviceContext - the service context

See Also:

ServiceContext.getExpandoBridgeAttributes( )

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException

Throws:

LocaleException

clone

Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<JournalTemplate>

Returns:

the shallow clone of this model instance

compareTo

int compareTo(JournalTemplate journalTemplate)

Specified by:

compareTo in interface Comparable<JournalTemplate>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

CacheModel<JournalTemplate> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<JournalTemplate>

Returns:

the cache model object

toEscapedModel

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

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

JournalTemplate toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<JournalTemplate>

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<JournalTemplate>

Returns:

the XML representation of this model instance