@ProviderType public interface CommerceNotificationTemplateModel extends com.liferay.portal.kernel.model.BaseModel<CommerceNotificationTemplate>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel
This interface and its corresponding implementation com.liferay.commerce.notification.model.impl.CommerceNotificationTemplateModelImpl
exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.commerce.notification.model.impl.CommerceNotificationTemplateImpl
.
CommerceNotificationTemplate
Modifier and Type | Method and Description |
---|---|
CommerceNotificationTemplate |
cloneWithOriginalValues() |
java.lang.String[] |
getAvailableLanguageIds() |
java.lang.String |
getBcc()
Returns the bcc of this commerce notification template.
|
java.lang.String |
getBody()
Returns the body of this commerce notification template.
|
java.lang.String |
getBody(java.util.Locale locale)
Returns the localized body of this commerce notification template in the language.
|
java.lang.String |
getBody(java.util.Locale locale,
boolean useDefault)
Returns the localized body of this commerce notification template in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getBody(java.lang.String languageId)
Returns the localized body of this commerce notification template in the language.
|
java.lang.String |
getBody(java.lang.String languageId,
boolean useDefault)
Returns the localized body of this commerce notification template in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getBodyCurrentLanguageId() |
java.lang.String |
getBodyCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getBodyMap()
Returns a map of the locales and localized bodies of this commerce notification template.
|
java.lang.String |
getCc()
Returns the cc of this commerce notification template.
|
long |
getCommerceNotificationTemplateId()
Returns the commerce notification template ID of this commerce notification template.
|
long |
getCompanyId()
Returns the company ID of this commerce notification template.
|
java.util.Date |
getCreateDate()
Returns the create date of this commerce notification template.
|
java.lang.String |
getDefaultLanguageId() |
java.lang.String |
getDescription()
Returns the description of this commerce notification template.
|
boolean |
getEnabled()
Returns the enabled of this commerce notification template.
|
java.lang.String |
getFrom()
Returns the from of this commerce notification template.
|
java.lang.String |
getFromName()
Returns the from name of this commerce notification template.
|
java.lang.String |
getFromName(java.util.Locale locale)
Returns the localized from name of this commerce notification template in the language.
|
java.lang.String |
getFromName(java.util.Locale locale,
boolean useDefault)
Returns the localized from name of this commerce notification template in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getFromName(java.lang.String languageId)
Returns the localized from name of this commerce notification template in the language.
|
java.lang.String |
getFromName(java.lang.String languageId,
boolean useDefault)
Returns the localized from name of this commerce notification template in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getFromNameCurrentLanguageId() |
java.lang.String |
getFromNameCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getFromNameMap()
Returns a map of the locales and localized from names of this commerce notification template.
|
long |
getGroupId()
Returns the group ID of this commerce notification template.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this commerce notification template.
|
long |
getMvccVersion()
Returns the mvcc version of this commerce notification template.
|
java.lang.String |
getName()
Returns the name of this commerce notification template.
|
long |
getPrimaryKey()
Returns the primary key of this commerce notification template.
|
java.lang.String |
getSubject()
Returns the subject of this commerce notification template.
|
java.lang.String |
getSubject(java.util.Locale locale)
Returns the localized subject of this commerce notification template in the language.
|
java.lang.String |
getSubject(java.util.Locale locale,
boolean useDefault)
Returns the localized subject of this commerce notification template in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getSubject(java.lang.String languageId)
Returns the localized subject of this commerce notification template in the language.
|
java.lang.String |
getSubject(java.lang.String languageId,
boolean useDefault)
Returns the localized subject of this commerce notification template in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getSubjectCurrentLanguageId() |
java.lang.String |
getSubjectCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getSubjectMap()
Returns a map of the locales and localized subjects of this commerce notification template.
|
java.lang.String |
getTo()
Returns the to of this commerce notification template.
|
java.lang.String |
getType()
Returns the type of this commerce notification template.
|
long |
getUserId()
Returns the user ID of this commerce notification template.
|
java.lang.String |
getUserName()
Returns the user name of this commerce notification template.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this commerce notification template.
|
java.lang.String |
getUuid()
Returns the uuid of this commerce notification template.
|
boolean |
isEnabled()
Returns
true if this commerce notification template is enabled. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setBcc(java.lang.String bcc)
Sets the bcc of this commerce notification template.
|
void |
setBody(java.lang.String body)
Sets the body of this commerce notification template.
|
void |
setBody(java.lang.String body,
java.util.Locale locale)
Sets the localized body of this commerce notification template in the language.
|
void |
setBody(java.lang.String body,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized body of this commerce notification template in the language, and sets the default locale.
|
void |
setBodyCurrentLanguageId(java.lang.String languageId) |
void |
setBodyMap(java.util.Map<java.util.Locale,java.lang.String> bodyMap)
Sets the localized bodies of this commerce notification template from the map of locales and localized bodies.
|
void |
setBodyMap(java.util.Map<java.util.Locale,java.lang.String> bodyMap,
java.util.Locale defaultLocale)
Sets the localized bodies of this commerce notification template from the map of locales and localized bodies, and sets the default locale.
|
void |
setCc(java.lang.String cc)
Sets the cc of this commerce notification template.
|
void |
setCommerceNotificationTemplateId(long commerceNotificationTemplateId)
Sets the commerce notification template ID of this commerce notification template.
|
void |
setCompanyId(long companyId)
Sets the company ID of this commerce notification template.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this commerce notification template.
|
void |
setDescription(java.lang.String description)
Sets the description of this commerce notification template.
|
void |
setEnabled(boolean enabled)
Sets whether this commerce notification template is enabled.
|
void |
setFrom(java.lang.String from)
Sets the from of this commerce notification template.
|
void |
setFromName(java.lang.String fromName)
Sets the from name of this commerce notification template.
|
void |
setFromName(java.lang.String fromName,
java.util.Locale locale)
Sets the localized from name of this commerce notification template in the language.
|
void |
setFromName(java.lang.String fromName,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized from name of this commerce notification template in the language, and sets the default locale.
|
void |
setFromNameCurrentLanguageId(java.lang.String languageId) |
void |
setFromNameMap(java.util.Map<java.util.Locale,java.lang.String> fromNameMap)
Sets the localized from names of this commerce notification template from the map of locales and localized from names.
|
void |
setFromNameMap(java.util.Map<java.util.Locale,java.lang.String> fromNameMap,
java.util.Locale defaultLocale)
Sets the localized from names of this commerce notification template from the map of locales and localized from names, and sets the default locale.
|
void |
setGroupId(long groupId)
Sets the group ID of this commerce notification template.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this commerce notification template.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this commerce notification template.
|
void |
setName(java.lang.String name)
Sets the name of this commerce notification template.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this commerce notification template.
|
void |
setSubject(java.lang.String subject)
Sets the subject of this commerce notification template.
|
void |
setSubject(java.lang.String subject,
java.util.Locale locale)
Sets the localized subject of this commerce notification template in the language.
|
void |
setSubject(java.lang.String subject,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized subject of this commerce notification template in the language, and sets the default locale.
|
void |
setSubjectCurrentLanguageId(java.lang.String languageId) |
void |
setSubjectMap(java.util.Map<java.util.Locale,java.lang.String> subjectMap)
Sets the localized subjects of this commerce notification template from the map of locales and localized subjects.
|
void |
setSubjectMap(java.util.Map<java.util.Locale,java.lang.String> subjectMap,
java.util.Locale defaultLocale)
Sets the localized subjects of this commerce notification template from the map of locales and localized subjects, and sets the default locale.
|
void |
setTo(java.lang.String to)
Sets the to of this commerce notification template.
|
void |
setType(java.lang.String type)
Sets the type of this commerce notification template.
|
void |
setUserId(long userId)
Sets the user ID of this commerce notification template.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this commerce notification template.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this commerce notification template.
|
void |
setUuid(java.lang.String uuid)
Sets the uuid of this commerce notification template.
|
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this commerce notification templatelong getMvccVersion()
getMvccVersion
in interface com.liferay.portal.kernel.model.MVCCModel
void setMvccVersion(long mvccVersion)
setMvccVersion
in interface com.liferay.portal.kernel.model.MVCCModel
mvccVersion
- the mvcc version of this commerce notification template@AutoEscape java.lang.String getUuid()
getUuid
in interface com.liferay.portal.kernel.model.StagedModel
void setUuid(java.lang.String uuid)
setUuid
in interface com.liferay.portal.kernel.model.StagedModel
uuid
- the uuid of this commerce notification templatelong getCommerceNotificationTemplateId()
void setCommerceNotificationTemplateId(long commerceNotificationTemplateId)
commerceNotificationTemplateId
- the commerce notification template ID of this commerce notification templatelong getGroupId()
getGroupId
in interface com.liferay.portal.kernel.model.GroupedModel
void setGroupId(long groupId)
setGroupId
in interface com.liferay.portal.kernel.model.GroupedModel
groupId
- the group ID of this commerce notification templatelong getCompanyId()
getCompanyId
in interface com.liferay.portal.kernel.model.AuditedModel
getCompanyId
in interface com.liferay.portal.kernel.model.ShardedModel
getCompanyId
in interface com.liferay.portal.kernel.model.StagedModel
void setCompanyId(long companyId)
setCompanyId
in interface com.liferay.portal.kernel.model.AuditedModel
setCompanyId
in interface com.liferay.portal.kernel.model.ShardedModel
setCompanyId
in interface com.liferay.portal.kernel.model.StagedModel
companyId
- the company ID of this commerce notification templatelong getUserId()
getUserId
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserId(long userId)
setUserId
in interface com.liferay.portal.kernel.model.AuditedModel
userId
- the user ID of this commerce notification templatejava.lang.String getUserUuid()
getUserUuid
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserUuid(java.lang.String userUuid)
setUserUuid
in interface com.liferay.portal.kernel.model.AuditedModel
userUuid
- the user uuid of this commerce notification template@AutoEscape java.lang.String getUserName()
getUserName
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserName(java.lang.String userName)
setUserName
in interface com.liferay.portal.kernel.model.AuditedModel
userName
- the user name of this commerce notification templatejava.util.Date getCreateDate()
getCreateDate
in interface com.liferay.portal.kernel.model.AuditedModel
getCreateDate
in interface com.liferay.portal.kernel.model.StagedModel
void setCreateDate(java.util.Date createDate)
setCreateDate
in interface com.liferay.portal.kernel.model.AuditedModel
setCreateDate
in interface com.liferay.portal.kernel.model.StagedModel
createDate
- the create date of this commerce notification templatejava.util.Date getModifiedDate()
getModifiedDate
in interface com.liferay.portal.kernel.model.AuditedModel
getModifiedDate
in interface com.liferay.portal.kernel.model.StagedModel
void setModifiedDate(java.util.Date modifiedDate)
setModifiedDate
in interface com.liferay.portal.kernel.model.AuditedModel
setModifiedDate
in interface com.liferay.portal.kernel.model.StagedModel
modifiedDate
- the modified date of this commerce notification template@AutoEscape java.lang.String getName()
void setName(java.lang.String name)
name
- the name of this commerce notification template@AutoEscape java.lang.String getDescription()
void setDescription(java.lang.String description)
description
- the description of this commerce notification template@AutoEscape java.lang.String getFrom()
void setFrom(java.lang.String from)
from
- the from of this commerce notification templatejava.lang.String getFromName()
@AutoEscape java.lang.String getFromName(java.util.Locale locale)
locale
- the locale of the language@AutoEscape java.lang.String getFromName(java.util.Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested languageuseDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getFromName(java.lang.String languageId)
languageId
- the ID of the language@AutoEscape java.lang.String getFromName(java.lang.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 java.lang.String getFromNameCurrentLanguageId()
@AutoEscape java.lang.String getFromNameCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getFromNameMap()
void setFromName(java.lang.String fromName)
fromName
- the from name of this commerce notification templatevoid setFromName(java.lang.String fromName, java.util.Locale locale)
fromName
- the localized from name of this commerce notification templatelocale
- the locale of the languagevoid setFromName(java.lang.String fromName, java.util.Locale locale, java.util.Locale defaultLocale)
fromName
- the localized from name of this commerce notification templatelocale
- the locale of the languagedefaultLocale
- the default localevoid setFromNameCurrentLanguageId(java.lang.String languageId)
void setFromNameMap(java.util.Map<java.util.Locale,java.lang.String> fromNameMap)
fromNameMap
- the locales and localized from names of this commerce notification templatevoid setFromNameMap(java.util.Map<java.util.Locale,java.lang.String> fromNameMap, java.util.Locale defaultLocale)
fromNameMap
- the locales and localized from names of this commerce notification templatedefaultLocale
- the default locale@AutoEscape java.lang.String getTo()
void setTo(java.lang.String to)
to
- the to of this commerce notification template@AutoEscape java.lang.String getCc()
void setCc(java.lang.String cc)
cc
- the cc of this commerce notification template@AutoEscape java.lang.String getBcc()
void setBcc(java.lang.String bcc)
bcc
- the bcc of this commerce notification template@AutoEscape java.lang.String getType()
void setType(java.lang.String type)
type
- the type of this commerce notification templateboolean getEnabled()
boolean isEnabled()
true
if this commerce notification template is enabled.true
if this commerce notification template is enabled; false
otherwisevoid setEnabled(boolean enabled)
enabled
- the enabled of this commerce notification templatejava.lang.String getSubject()
@AutoEscape java.lang.String getSubject(java.util.Locale locale)
locale
- the locale of the language@AutoEscape java.lang.String getSubject(java.util.Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested languageuseDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getSubject(java.lang.String languageId)
languageId
- the ID of the language@AutoEscape java.lang.String getSubject(java.lang.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 java.lang.String getSubjectCurrentLanguageId()
@AutoEscape java.lang.String getSubjectCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getSubjectMap()
void setSubject(java.lang.String subject)
subject
- the subject of this commerce notification templatevoid setSubject(java.lang.String subject, java.util.Locale locale)
subject
- the localized subject of this commerce notification templatelocale
- the locale of the languagevoid setSubject(java.lang.String subject, java.util.Locale locale, java.util.Locale defaultLocale)
subject
- the localized subject of this commerce notification templatelocale
- the locale of the languagedefaultLocale
- the default localevoid setSubjectCurrentLanguageId(java.lang.String languageId)
void setSubjectMap(java.util.Map<java.util.Locale,java.lang.String> subjectMap)
subjectMap
- the locales and localized subjects of this commerce notification templatevoid setSubjectMap(java.util.Map<java.util.Locale,java.lang.String> subjectMap, java.util.Locale defaultLocale)
subjectMap
- the locales and localized subjects of this commerce notification templatedefaultLocale
- the default localejava.lang.String getBody()
@AutoEscape java.lang.String getBody(java.util.Locale locale)
locale
- the locale of the language@AutoEscape java.lang.String getBody(java.util.Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested languageuseDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getBody(java.lang.String languageId)
languageId
- the ID of the language@AutoEscape java.lang.String getBody(java.lang.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 java.lang.String getBodyCurrentLanguageId()
@AutoEscape java.lang.String getBodyCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getBodyMap()
void setBody(java.lang.String body)
body
- the body of this commerce notification templatevoid setBody(java.lang.String body, java.util.Locale locale)
body
- the localized body of this commerce notification templatelocale
- the locale of the languagevoid setBody(java.lang.String body, java.util.Locale locale, java.util.Locale defaultLocale)
body
- the localized body of this commerce notification templatelocale
- the locale of the languagedefaultLocale
- the default localevoid setBodyCurrentLanguageId(java.lang.String languageId)
void setBodyMap(java.util.Map<java.util.Locale,java.lang.String> bodyMap)
bodyMap
- the locales and localized bodies of this commerce notification templatevoid setBodyMap(java.util.Map<java.util.Locale,java.lang.String> bodyMap, java.util.Locale defaultLocale)
bodyMap
- the locales and localized bodies of this commerce notification templatedefaultLocale
- the default localejava.lang.String[] getAvailableLanguageIds()
getAvailableLanguageIds
in interface com.liferay.portal.kernel.model.LocalizedModel
java.lang.String getDefaultLanguageId()
getDefaultLanguageId
in interface com.liferay.portal.kernel.model.LocalizedModel
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport
in interface com.liferay.portal.kernel.model.LocalizedModel
com.liferay.portal.kernel.exception.LocaleException
void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport
in interface com.liferay.portal.kernel.model.LocalizedModel
com.liferay.portal.kernel.exception.LocaleException
CommerceNotificationTemplate cloneWithOriginalValues()
cloneWithOriginalValues
in interface com.liferay.portal.kernel.model.BaseModel<CommerceNotificationTemplate>