Package com.liferay.notification.model
Interface NotificationTemplateModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel,com.liferay.portal.kernel.model.BaseModel<NotificationTemplate>,com.liferay.portal.kernel.model.ClassedModel,Cloneable,Comparable<NotificationTemplate>,com.liferay.portal.kernel.model.ExternalReferenceCodeModel,com.liferay.portal.kernel.model.LocalizedModel,com.liferay.portal.kernel.model.MVCCModel,Serializable,com.liferay.portal.kernel.model.ShardedModel,com.liferay.portal.kernel.model.StagedAuditedModel,com.liferay.portal.kernel.model.StagedModel
- All Known Subinterfaces:
NotificationTemplate
- All Known Implementing Classes:
NotificationTemplateWrapper
@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
The base model interface for the NotificationTemplate service. Represents a row in the "NotificationTemplate" database table, with each column mapped to a property of this class.
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.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]getBody()Returns the body of this notification template.Returns the localized body of this notification template in the language.Returns the localized body of this notification template in the language, optionally using the default language if no localization exists for the requested language.Returns the localized body of this notification template in the language.Returns the localized body of this notification template in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized bodies of this notification template.longReturns the company ID of this notification template.Returns the create date of this notification template.Returns the description of this notification template.Returns the editor type of this notification template.Returns the external reference code of this notification template.Returns the modified date of this notification template.longReturns the mvcc version of this notification template.getName()Returns the name of this notification template.Returns the localized name of this notification template in the language.Returns the localized name of this notification template in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this notification template in the language.Returns the localized name of this notification template in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized names of this notification template.longReturns the notification template ID of this notification template.longReturns the object definition ID of this notification template.longReturns the primary key of this notification template.Returns the recipient type of this notification template.Returns the subject of this notification template.getSubject(String languageId) Returns the localized subject of this notification template in the language.getSubject(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.getSubject(Locale locale) Returns the localized subject of this notification template in the language.getSubject(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.Returns a map of the locales and localized subjects of this notification template.booleanReturns the system of this notification template.getType()Returns the type of this notification template.longReturns the user ID of this notification template.Returns the user name of this notification template.Returns the user uuid of this notification template.getUuid()Returns the uuid of this notification template.booleanisSystem()Returnstrueif this notification template is system.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidSets the body of this notification template.voidSets the localized body of this notification template in the language.voidSets the localized body of this notification template in the language, and sets the default locale.voidsetBodyCurrentLanguageId(String languageId) voidsetBodyMap(Map<Locale, String> bodyMap) Sets the localized bodies of this notification template from the map of locales and localized bodies.voidsetBodyMap(Map<Locale, String> bodyMap, Locale defaultLocale) Sets the localized bodies of this notification template from the map of locales and localized bodies, and sets the default locale.voidsetCompanyId(long companyId) Sets the company ID of this notification template.voidsetCreateDate(Date createDate) Sets the create date of this notification template.voidsetDescription(String description) Sets the description of this notification template.voidsetEditorType(String editorType) Sets the editor type of this notification template.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this notification template.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this notification template.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this notification template.voidSets the name of this notification template.voidSets the localized name of this notification template in the language.voidSets the localized name of this notification template in the language, and sets the default locale.voidsetNameCurrentLanguageId(String languageId) voidsetNameMap(Map<Locale, String> nameMap) Sets the localized names of this notification template from the map of locales and localized names.voidsetNameMap(Map<Locale, String> nameMap, Locale defaultLocale) Sets the localized names of this notification template from the map of locales and localized names, and sets the default locale.voidsetNotificationTemplateId(long notificationTemplateId) Sets the notification template ID of this notification template.voidsetObjectDefinitionId(long objectDefinitionId) Sets the object definition ID of this notification template.voidsetPrimaryKey(long primaryKey) Sets the primary key of this notification template.voidsetRecipientType(String recipientType) Sets the recipient type of this notification template.voidsetSubject(String subject) Sets the subject of this notification template.voidsetSubject(String subject, Locale locale) Sets the localized subject of this notification template in the language.voidsetSubject(String subject, Locale locale, Locale defaultLocale) Sets the localized subject of this notification template in the language, and sets the default locale.voidsetSubjectCurrentLanguageId(String languageId) voidsetSubjectMap(Map<Locale, String> subjectMap) Sets the localized subjects of this notification template from the map of locales and localized subjects.voidsetSubjectMap(Map<Locale, String> subjectMap, Locale defaultLocale) Sets the localized subjects of this notification template from the map of locales and localized subjects, and sets the default locale.voidsetSystem(boolean system) Sets whether this notification template is system.voidSets the type of this notification template.voidsetUserId(long userId) Sets the user ID of this notification template.voidsetUserName(String userName) Sets the user name of this notification template.voidsetUserUuid(String userUuid) Sets the user uuid of this notification template.voidSets the uuid of this notification template.default StringMethods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this notification template.- Returns:
- the primary key of this notification template
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this notification template.- Parameters:
primaryKey- the primary key of this notification template
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this notification template.- Specified by:
getMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Returns:
- the mvcc version of this notification template
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this notification template.- Specified by:
setMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Parameters:
mvccVersion- the mvcc version of this notification template
-
getUuid
Returns the uuid of this notification template.- Specified by:
getUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the uuid of this notification template
-
setUuid
Sets the uuid of this notification template.- Specified by:
setUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
uuid- the uuid of this notification template
-
getExternalReferenceCode
Returns the external reference code of this notification template.- Specified by:
getExternalReferenceCodein interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel- Returns:
- the external reference code of this notification template
-
setExternalReferenceCode
Sets the external reference code of this notification template.- Specified by:
setExternalReferenceCodein interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel- Parameters:
externalReferenceCode- the external reference code of this notification template
-
getNotificationTemplateId
long getNotificationTemplateId()Returns the notification template ID of this notification template.- Returns:
- the notification template ID of this notification template
-
setNotificationTemplateId
void setNotificationTemplateId(long notificationTemplateId) Sets the notification template ID of this notification template.- Parameters:
notificationTemplateId- the notification template ID of this notification template
-
getCompanyId
long getCompanyId()Returns the company ID of this notification template.- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.ShardedModel- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the company ID of this notification template
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this notification template.- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.ShardedModel- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
companyId- the company ID of this notification template
-
getUserId
long getUserId()Returns the user ID of this notification template.- Specified by:
getUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user ID of this notification template
-
setUserId
void setUserId(long userId) Sets the user ID of this notification template.- Specified by:
setUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userId- the user ID of this notification template
-
getUserUuid
String getUserUuid()Returns the user uuid of this notification template.- Specified by:
getUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user uuid of this notification template
-
setUserUuid
Sets the user uuid of this notification template.- Specified by:
setUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userUuid- the user uuid of this notification template
-
getUserName
Returns the user name of this notification template.- Specified by:
getUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user name of this notification template
-
setUserName
Sets the user name of this notification template.- Specified by:
setUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userName- the user name of this notification template
-
getCreateDate
Date getCreateDate()Returns the create date of this notification template.- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the create date of this notification template
-
setCreateDate
Sets the create date of this notification template.- Specified by:
setCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
createDate- the create date of this notification template
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this notification template.- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the modified date of this notification template
-
setModifiedDate
Sets the modified date of this notification template.- Specified by:
setModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
modifiedDate- the modified date of this notification template
-
getObjectDefinitionId
long getObjectDefinitionId()Returns the object definition ID of this notification template.- Returns:
- the object definition ID of this notification template
-
setObjectDefinitionId
void setObjectDefinitionId(long objectDefinitionId) Sets the object definition ID of this notification template.- Parameters:
objectDefinitionId- the object definition ID of this notification template
-
getBody
String getBody()Returns the body of this notification template.- Returns:
- the body of this notification template
-
getBody
Returns the localized body of this notification 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 body of this notification template
-
getBody
Returns the localized body of this notification template in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale- the local of the languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized body of this notification template. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getBody
Returns the localized body of this notification 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 body of this notification template
-
getBody
Returns the localized body of this notification template in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId- the ID of the languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized body of this notification template
-
getBodyCurrentLanguageId
-
getBodyCurrentValue
-
getBodyMap
Returns a map of the locales and localized bodies of this notification template.- Returns:
- the locales and localized bodies of this notification template
-
setBody
Sets the body of this notification template.- Parameters:
body- the body of this notification template
-
setBody
Sets the localized body of this notification template in the language.- Parameters:
body- the localized body of this notification templatelocale- the locale of the language
-
setBody
Sets the localized body of this notification template in the language, and sets the default locale.- Parameters:
body- the localized body of this notification templatelocale- the locale of the languagedefaultLocale- the default locale
-
setBodyCurrentLanguageId
-
setBodyMap
Sets the localized bodies of this notification template from the map of locales and localized bodies.- Parameters:
bodyMap- the locales and localized bodies of this notification template
-
setBodyMap
Sets the localized bodies of this notification template from the map of locales and localized bodies, and sets the default locale.- Parameters:
bodyMap- the locales and localized bodies of this notification templatedefaultLocale- the default locale
-
getDescription
Returns the description of this notification template.- Returns:
- the description of this notification template
-
setDescription
Sets the description of this notification template.- Parameters:
description- the description of this notification template
-
getEditorType
Returns the editor type of this notification template.- Returns:
- the editor type of this notification template
-
setEditorType
Sets the editor type of this notification template.- Parameters:
editorType- the editor type of this notification template
-
getName
String getName()Returns the name of this notification template.- Returns:
- the name of this notification template
-
getName
Returns the localized name of this notification 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 notification template
-
getName
Returns the localized name of this notification template in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale- the local of the languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this notification template. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getName
Returns the localized name of this notification 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 notification template
-
getName
Returns the localized name of this notification template in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId- the ID of the languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this notification template
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this notification template.- Returns:
- the locales and localized names of this notification template
-
setName
Sets the name of this notification template.- Parameters:
name- the name of this notification template
-
setName
Sets the localized name of this notification template in the language.- Parameters:
name- the localized name of this notification templatelocale- the locale of the language
-
setName
Sets the localized name of this notification template in the language, and sets the default locale.- Parameters:
name- the localized name of this notification templatelocale- the locale of the languagedefaultLocale- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this notification template from the map of locales and localized names.- Parameters:
nameMap- the locales and localized names of this notification template
-
setNameMap
Sets the localized names of this notification template from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap- the locales and localized names of this notification templatedefaultLocale- the default locale
-
getRecipientType
Returns the recipient type of this notification template.- Returns:
- the recipient type of this notification template
-
setRecipientType
Sets the recipient type of this notification template.- Parameters:
recipientType- the recipient type of this notification template
-
getSubject
String getSubject()Returns the subject of this notification template.- Returns:
- the subject of this notification template
-
getSubject
Returns the localized subject of this notification 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 subject of this notification template
-
getSubject
Returns the localized subject of this notification template in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale- the local of the languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized subject of this notification template. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getSubject
Returns the localized subject of this notification 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 subject of this notification template
-
getSubject
Returns the localized subject of this notification template in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId- the ID of the languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized subject of this notification template
-
getSubjectCurrentLanguageId
-
getSubjectCurrentValue
-
getSubjectMap
Returns a map of the locales and localized subjects of this notification template.- Returns:
- the locales and localized subjects of this notification template
-
setSubject
Sets the subject of this notification template.- Parameters:
subject- the subject of this notification template
-
setSubject
Sets the localized subject of this notification template in the language.- Parameters:
subject- the localized subject of this notification templatelocale- the locale of the language
-
setSubject
Sets the localized subject of this notification template in the language, and sets the default locale.- Parameters:
subject- the localized subject of this notification templatelocale- the locale of the languagedefaultLocale- the default locale
-
setSubjectCurrentLanguageId
-
setSubjectMap
Sets the localized subjects of this notification template from the map of locales and localized subjects.- Parameters:
subjectMap- the locales and localized subjects of this notification template
-
setSubjectMap
Sets the localized subjects of this notification template from the map of locales and localized subjects, and sets the default locale.- Parameters:
subjectMap- the locales and localized subjects of this notification templatedefaultLocale- the default locale
-
getSystem
boolean getSystem()Returns the system of this notification template.- Returns:
- the system of this notification template
-
isSystem
boolean isSystem()Returnstrueif this notification template is system.- Returns:
trueif this notification template is system;falseotherwise
-
setSystem
void setSystem(boolean system) Sets whether this notification template is system.- Parameters:
system- the system of this notification template
-
getType
Returns the type of this notification template.- Returns:
- the type of this notification template
-
setType
Sets the type of this notification template.- Parameters:
type- the type of this notification template
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIdsin interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageIdin interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImportin interfacecom.liferay.portal.kernel.model.LocalizedModel- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException - Specified by:
prepareLocalizedFieldsForImportin interfacecom.liferay.portal.kernel.model.LocalizedModel- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
NotificationTemplate cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfacecom.liferay.portal.kernel.model.BaseModel<NotificationTemplate>
-
toXmlString
-