@ProviderType public interface NotificationTemplateModel extends com.liferay.portal.kernel.model.BaseModel<NotificationTemplate>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, 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.notification.model.impl.NotificationTemplateModelImpl 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.notification.model.impl.NotificationTemplateImpl.
NotificationTemplate| Modifier and Type | Method and Description |
|---|---|
NotificationTemplate |
cloneWithOriginalValues() |
java.lang.String[] |
getAvailableLanguageIds() |
java.lang.String |
getBody()
Returns the body of this notification template.
|
java.lang.String |
getBody(java.util.Locale locale)
Returns the localized body of this notification template in the language.
|
java.lang.String |
getBody(java.util.Locale locale,
boolean useDefault)
Returns the localized body of this 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 notification template in the language.
|
java.lang.String |
getBody(java.lang.String languageId,
boolean useDefault)
Returns the localized body of this 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 notification template.
|
long |
getCompanyId()
Returns the company ID of this notification template.
|
java.util.Date |
getCreateDate()
Returns the create date of this notification template.
|
java.lang.String |
getDefaultLanguageId() |
java.lang.String |
getDescription()
Returns the description of this notification template.
|
java.lang.String |
getEditorType()
Returns the editor type of this notification template.
|
java.lang.String |
getExternalReferenceCode()
Returns the external reference code of this notification template.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this notification template.
|
long |
getMvccVersion()
Returns the mvcc version of this notification template.
|
java.lang.String |
getName()
Returns the name of this notification template.
|
java.lang.String |
getName(java.util.Locale locale)
Returns the localized name of this notification template in the language.
|
java.lang.String |
getName(java.util.Locale locale,
boolean useDefault)
Returns the localized name of this notification template in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getName(java.lang.String languageId)
Returns the localized name of this notification template in the language.
|
java.lang.String |
getName(java.lang.String languageId,
boolean useDefault)
Returns the localized name of this notification template in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getNameCurrentLanguageId() |
java.lang.String |
getNameCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getNameMap()
Returns a map of the locales and localized names of this notification template.
|
long |
getNotificationTemplateId()
Returns the notification template ID of this notification template.
|
long |
getObjectDefinitionId()
Returns the object definition ID of this notification template.
|
long |
getPrimaryKey()
Returns the primary key of this notification template.
|
java.lang.String |
getRecipientType()
Returns the recipient type of this notification template.
|
java.lang.String |
getSubject()
Returns the subject of this notification template.
|
java.lang.String |
getSubject(java.util.Locale locale)
Returns the localized subject of this notification template in the language.
|
java.lang.String |
getSubject(java.util.Locale locale,
boolean useDefault)
Returns the localized subject of this 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 notification template in the language.
|
java.lang.String |
getSubject(java.lang.String languageId,
boolean useDefault)
Returns the localized subject of this 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 notification template.
|
boolean |
getSystem()
Returns the system of this notification template.
|
java.lang.String |
getType()
Returns the type of this notification template.
|
long |
getUserId()
Returns the user ID of this notification template.
|
java.lang.String |
getUserName()
Returns the user name of this notification template.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this notification template.
|
java.lang.String |
getUuid()
Returns the uuid of this notification template.
|
boolean |
isSystem()
Returns
true if this notification template is system. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setBody(java.lang.String body)
Sets the body of this notification template.
|
void |
setBody(java.lang.String body,
java.util.Locale locale)
Sets the localized body of this 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 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 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 notification template from the map of locales and localized bodies, and sets the default locale.
|
void |
setCompanyId(long companyId)
Sets the company ID of this notification template.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this notification template.
|
void |
setDescription(java.lang.String description)
Sets the description of this notification template.
|
void |
setEditorType(java.lang.String editorType)
Sets the editor type of this notification template.
|
void |
setExternalReferenceCode(java.lang.String externalReferenceCode)
Sets the external reference code of this notification template.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this notification template.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this notification template.
|
void |
setName(java.lang.String name)
Sets the name of this notification template.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Sets the localized name of this notification template in the language.
|
void |
setName(java.lang.String name,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized name of this notification template in the language, and sets the default locale.
|
void |
setNameCurrentLanguageId(java.lang.String languageId) |
void |
setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)
Sets the localized names of this notification template from the map of locales and localized names.
|
void |
setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Locale defaultLocale)
Sets the localized names of this notification template from the map of locales and localized names, and sets the default locale.
|
void |
setNotificationTemplateId(long notificationTemplateId)
Sets the notification template ID of this notification template.
|
void |
setObjectDefinitionId(long objectDefinitionId)
Sets the object definition ID of this notification template.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this notification template.
|
void |
setRecipientType(java.lang.String recipientType)
Sets the recipient type of this notification template.
|
void |
setSubject(java.lang.String subject)
Sets the subject of this notification template.
|
void |
setSubject(java.lang.String subject,
java.util.Locale locale)
Sets the localized subject of this 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 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 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 notification template from the map of locales and localized subjects, and sets the default locale.
|
void |
setSystem(boolean system)
Sets whether this notification template is system.
|
void |
setType(java.lang.String type)
Sets the type of this notification template.
|
void |
setUserId(long userId)
Sets the user ID of this notification template.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this notification template.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this notification template.
|
void |
setUuid(java.lang.String uuid)
Sets the uuid of this notification template.
|
default java.lang.String |
toXmlString() |
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModellong getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey - the primary key of this notification templatelong getMvccVersion()
getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModelvoid setMvccVersion(long mvccVersion)
setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModelmvccVersion - the mvcc version of this notification template@AutoEscape java.lang.String getUuid()
getUuid in interface com.liferay.portal.kernel.model.StagedModelvoid setUuid(java.lang.String uuid)
setUuid in interface com.liferay.portal.kernel.model.StagedModeluuid - the uuid of this notification template@AutoEscape java.lang.String getExternalReferenceCode()
getExternalReferenceCode in interface com.liferay.portal.kernel.model.ExternalReferenceCodeModelvoid setExternalReferenceCode(java.lang.String externalReferenceCode)
setExternalReferenceCode in interface com.liferay.portal.kernel.model.ExternalReferenceCodeModelexternalReferenceCode - the external reference code of this notification templatelong getNotificationTemplateId()
void setNotificationTemplateId(long notificationTemplateId)
notificationTemplateId - the notification template ID of this notification templatelong getCompanyId()
getCompanyId in interface com.liferay.portal.kernel.model.AuditedModelgetCompanyId in interface com.liferay.portal.kernel.model.ShardedModelgetCompanyId in interface com.liferay.portal.kernel.model.StagedModelvoid setCompanyId(long companyId)
setCompanyId in interface com.liferay.portal.kernel.model.AuditedModelsetCompanyId in interface com.liferay.portal.kernel.model.ShardedModelsetCompanyId in interface com.liferay.portal.kernel.model.StagedModelcompanyId - the company ID of this notification templatelong getUserId()
getUserId in interface com.liferay.portal.kernel.model.AuditedModelvoid setUserId(long userId)
setUserId in interface com.liferay.portal.kernel.model.AuditedModeluserId - the user ID of this notification templatejava.lang.String getUserUuid()
getUserUuid in interface com.liferay.portal.kernel.model.AuditedModelvoid setUserUuid(java.lang.String userUuid)
setUserUuid in interface com.liferay.portal.kernel.model.AuditedModeluserUuid - the user uuid of this notification template@AutoEscape java.lang.String getUserName()
getUserName in interface com.liferay.portal.kernel.model.AuditedModelvoid setUserName(java.lang.String userName)
setUserName in interface com.liferay.portal.kernel.model.AuditedModeluserName - the user name of this notification templatejava.util.Date getCreateDate()
getCreateDate in interface com.liferay.portal.kernel.model.AuditedModelgetCreateDate in interface com.liferay.portal.kernel.model.StagedModelvoid setCreateDate(java.util.Date createDate)
setCreateDate in interface com.liferay.portal.kernel.model.AuditedModelsetCreateDate in interface com.liferay.portal.kernel.model.StagedModelcreateDate - the create date of this notification templatejava.util.Date getModifiedDate()
getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModelgetModifiedDate in interface com.liferay.portal.kernel.model.StagedModelvoid setModifiedDate(java.util.Date modifiedDate)
setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModelsetModifiedDate in interface com.liferay.portal.kernel.model.StagedModelmodifiedDate - the modified date of this notification templatelong getObjectDefinitionId()
void setObjectDefinitionId(long objectDefinitionId)
objectDefinitionId - the object definition ID of this notification templatejava.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 notification templatevoid setBody(java.lang.String body,
java.util.Locale locale)
body - the localized body of this 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 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 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 notification templatedefaultLocale - the default locale@AutoEscape java.lang.String getDescription()
void setDescription(java.lang.String description)
description - the description of this notification template@AutoEscape java.lang.String getEditorType()
void setEditorType(java.lang.String editorType)
editorType - the editor type of this notification templatejava.lang.String getName()
@AutoEscape java.lang.String getName(java.util.Locale locale)
locale - the locale of the language@AutoEscape
java.lang.String getName(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 getName(java.lang.String languageId)
languageId - the ID of the language@AutoEscape
java.lang.String getName(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 getNameCurrentLanguageId()
@AutoEscape java.lang.String getNameCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getNameMap()
void setName(java.lang.String name)
name - the name of this notification templatevoid setName(java.lang.String name,
java.util.Locale locale)
name - the localized name of this notification templatelocale - the locale of the languagevoid setName(java.lang.String name,
java.util.Locale locale,
java.util.Locale defaultLocale)
name - the localized name of this notification templatelocale - the locale of the languagedefaultLocale - the default localevoid setNameCurrentLanguageId(java.lang.String languageId)
void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)
nameMap - the locales and localized names of this notification templatevoid setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Locale defaultLocale)
nameMap - the locales and localized names of this notification templatedefaultLocale - the default locale@AutoEscape java.lang.String getRecipientType()
void setRecipientType(java.lang.String recipientType)
recipientType - the recipient type of this 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 notification templatevoid setSubject(java.lang.String subject,
java.util.Locale locale)
subject - the localized subject of this 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 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 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 notification templatedefaultLocale - the default localeboolean getSystem()
boolean isSystem()
true if this notification template is system.true if this notification template is system; false otherwisevoid setSystem(boolean system)
system - the system of this notification template@AutoEscape java.lang.String getType()
void setType(java.lang.String type)
type - the type of this notification templatejava.lang.String[] getAvailableLanguageIds()
getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModeljava.lang.String getDefaultLanguageId()
getDefaultLanguageId in interface com.liferay.portal.kernel.model.LocalizedModelvoid prepareLocalizedFieldsForImport()
throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModelcom.liferay.portal.kernel.exception.LocaleExceptionvoid prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModelcom.liferay.portal.kernel.exception.LocaleExceptionNotificationTemplate cloneWithOriginalValues()
cloneWithOriginalValues in interface com.liferay.portal.kernel.model.BaseModel<NotificationTemplate>default java.lang.String toXmlString()