@ProviderType public interface DDMTemplateModel extends com.liferay.portal.kernel.model.AttachedModel, com.liferay.portal.kernel.model.BaseModel<DDMTemplate>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMTemplate>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel
This interface and its corresponding implementation com.liferay.dynamic.data.mapping.model.impl.DDMTemplateModelImpl 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.dynamic.data.mapping.model.impl.DDMTemplateImpl.
DDMTemplate| Modifier and Type | Method and Description |
|---|---|
DDMTemplate |
cloneWithOriginalValues() |
java.lang.String[] |
getAvailableLanguageIds() |
boolean |
getCacheable()
Returns the cacheable of this ddm template.
|
java.lang.String |
getClassName()
Returns the fully qualified class name of this ddm template.
|
long |
getClassNameId()
Returns the class name ID of this ddm template.
|
long |
getClassPK()
Returns the class pk of this ddm template.
|
long |
getCompanyId()
Returns the company ID of this ddm template.
|
java.util.Date |
getCreateDate()
Returns the create date of this ddm template.
|
long |
getCtCollectionId()
Returns the ct collection ID of this ddm template.
|
java.lang.String |
getDefaultLanguageId() |
java.lang.String |
getDescription()
Returns the description of this ddm template.
|
java.lang.String |
getDescription(java.util.Locale locale)
Returns the localized description of this ddm template in the language.
|
java.lang.String |
getDescription(java.util.Locale locale,
boolean useDefault)
Returns the localized description of this ddm template in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getDescription(java.lang.String languageId)
Returns the localized description of this ddm template in the language.
|
java.lang.String |
getDescription(java.lang.String languageId,
boolean useDefault)
Returns the localized description of this ddm template in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getDescriptionCurrentLanguageId() |
java.lang.String |
getDescriptionCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getDescriptionMap()
Returns a map of the locales and localized descriptions of this ddm template.
|
long |
getGroupId()
Returns the group ID of this ddm template.
|
java.lang.String |
getLanguage()
Returns the language of this ddm template.
|
java.util.Date |
getLastPublishDate()
Returns the last publish date of this ddm template.
|
java.lang.String |
getMode()
Returns the mode of this ddm template.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this ddm template.
|
long |
getMvccVersion()
Returns the mvcc version of this ddm template.
|
java.lang.String |
getName()
Returns the name of this ddm template.
|
java.lang.String |
getName(java.util.Locale locale)
Returns the localized name of this ddm template in the language.
|
java.lang.String |
getName(java.util.Locale locale,
boolean useDefault)
Returns the localized name of this ddm 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 ddm template in the language.
|
java.lang.String |
getName(java.lang.String languageId,
boolean useDefault)
Returns the localized name of this ddm 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 ddm template.
|
long |
getPrimaryKey()
Returns the primary key of this ddm template.
|
long |
getResourceClassNameId()
Returns the resource class name ID of this ddm template.
|
java.lang.String |
getScript()
Returns the script of this ddm template.
|
boolean |
getSmallImage()
Returns the small image of this ddm template.
|
long |
getSmallImageId()
Returns the small image ID of this ddm template.
|
java.lang.String |
getSmallImageURL()
Returns the small image url of this ddm template.
|
long |
getTemplateId()
Returns the template ID of this ddm template.
|
java.lang.String |
getTemplateKey()
Returns the template key of this ddm template.
|
java.lang.String |
getType()
Returns the type of this ddm template.
|
long |
getUserId()
Returns the user ID of this ddm template.
|
java.lang.String |
getUserName()
Returns the user name of this ddm template.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this ddm template.
|
java.lang.String |
getUuid()
Returns the uuid of this ddm template.
|
java.lang.String |
getVersion()
Returns the version of this ddm template.
|
long |
getVersionUserId()
Returns the version user ID of this ddm template.
|
java.lang.String |
getVersionUserName()
Returns the version user name of this ddm template.
|
java.lang.String |
getVersionUserUuid()
Returns the version user uuid of this ddm template.
|
boolean |
isCacheable()
Returns
true if this ddm template is cacheable. |
boolean |
isSmallImage()
Returns
true if this ddm template is small image. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setCacheable(boolean cacheable)
Sets whether this ddm template is cacheable.
|
void |
setClassName(java.lang.String className) |
void |
setClassNameId(long classNameId)
Sets the class name ID of this ddm template.
|
void |
setClassPK(long classPK)
Sets the class pk of this ddm template.
|
void |
setCompanyId(long companyId)
Sets the company ID of this ddm template.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this ddm template.
|
void |
setCtCollectionId(long ctCollectionId)
Sets the ct collection ID of this ddm template.
|
void |
setDescription(java.lang.String description)
Sets the description of this ddm template.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets the localized description of this ddm template in the language.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized description of this ddm template in the language, and sets the default locale.
|
void |
setDescriptionCurrentLanguageId(java.lang.String languageId) |
void |
setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)
Sets the localized descriptions of this ddm template from the map of locales and localized descriptions.
|
void |
setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.Locale defaultLocale)
Sets the localized descriptions of this ddm template from the map of locales and localized descriptions, and sets the default locale.
|
void |
setGroupId(long groupId)
Sets the group ID of this ddm template.
|
void |
setLanguage(java.lang.String language)
Sets the language of this ddm template.
|
void |
setLastPublishDate(java.util.Date lastPublishDate)
Sets the last publish date of this ddm template.
|
void |
setMode(java.lang.String mode)
Sets the mode of this ddm template.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this ddm template.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this ddm template.
|
void |
setName(java.lang.String name)
Sets the name of this ddm template.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Sets the localized name of this ddm template in the language.
|
void |
setName(java.lang.String name,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized name of this ddm 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 ddm 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 ddm template from the map of locales and localized names, and sets the default locale.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this ddm template.
|
void |
setResourceClassNameId(long resourceClassNameId)
Sets the resource class name ID of this ddm template.
|
void |
setScript(java.lang.String script)
Sets the script of this ddm template.
|
void |
setSmallImage(boolean smallImage)
Sets whether this ddm template is small image.
|
void |
setSmallImageId(long smallImageId)
Sets the small image ID of this ddm template.
|
void |
setSmallImageURL(java.lang.String smallImageURL)
Sets the small image url of this ddm template.
|
void |
setTemplateId(long templateId)
Sets the template ID of this ddm template.
|
void |
setTemplateKey(java.lang.String templateKey)
Sets the template key of this ddm template.
|
void |
setType(java.lang.String type)
Sets the type of this ddm template.
|
void |
setUserId(long userId)
Sets the user ID of this ddm template.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this ddm template.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this ddm template.
|
void |
setUuid(java.lang.String uuid)
Sets the uuid of this ddm template.
|
void |
setVersion(java.lang.String version)
Sets the version of this ddm template.
|
void |
setVersionUserId(long versionUserId)
Sets the version user ID of this ddm template.
|
void |
setVersionUserName(java.lang.String versionUserName)
Sets the version user name of this ddm template.
|
void |
setVersionUserUuid(java.lang.String versionUserUuid)
Sets the version user uuid of this ddm template.
|
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlStringlong getPrimaryKey()
getPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMTemplate>void setPrimaryKey(long primaryKey)
setPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMTemplate>primaryKey - the primary key of this ddm 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 ddm templatelong getCtCollectionId()
getCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMTemplate>void setCtCollectionId(long ctCollectionId)
setCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMTemplate>ctCollectionId - the ct collection ID of this ddm 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 ddm templatelong getTemplateId()
void setTemplateId(long templateId)
templateId - the template ID of this ddm templatelong getGroupId()
getGroupId in interface com.liferay.portal.kernel.model.GroupedModelvoid setGroupId(long groupId)
setGroupId in interface com.liferay.portal.kernel.model.GroupedModelgroupId - the group ID of this ddm 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 ddm 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 ddm 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 ddm 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 ddm templatelong getVersionUserId()
void setVersionUserId(long versionUserId)
versionUserId - the version user ID of this ddm templatejava.lang.String getVersionUserUuid()
void setVersionUserUuid(java.lang.String versionUserUuid)
versionUserUuid - the version user uuid of this ddm template@AutoEscape java.lang.String getVersionUserName()
void setVersionUserName(java.lang.String versionUserName)
versionUserName - the version user name of this ddm 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 ddm 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 ddm templatejava.lang.String getClassName()
getClassName in interface com.liferay.portal.kernel.model.TypedModelvoid setClassName(java.lang.String className)
long getClassNameId()
getClassNameId in interface com.liferay.portal.kernel.model.TypedModelvoid setClassNameId(long classNameId)
setClassNameId in interface com.liferay.portal.kernel.model.TypedModelclassNameId - the class name ID of this ddm templatelong getClassPK()
getClassPK in interface com.liferay.portal.kernel.model.AttachedModelvoid setClassPK(long classPK)
setClassPK in interface com.liferay.portal.kernel.model.AttachedModelclassPK - the class pk of this ddm templatelong getResourceClassNameId()
void setResourceClassNameId(long resourceClassNameId)
resourceClassNameId - the resource class name ID of this ddm templatejava.lang.String getTemplateKey()
void setTemplateKey(java.lang.String templateKey)
templateKey - the template key of this ddm template@AutoEscape java.lang.String getVersion()
void setVersion(java.lang.String version)
version - the version of this ddm 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 ddm templatevoid setName(java.lang.String name,
java.util.Locale locale)
name - the localized name of this ddm 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 ddm 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 ddm templatevoid setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Locale defaultLocale)
nameMap - the locales and localized names of this ddm templatedefaultLocale - the default localejava.lang.String getDescription()
@AutoEscape java.lang.String getDescription(java.util.Locale locale)
locale - the locale of the language@AutoEscape
java.lang.String getDescription(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 getDescription(java.lang.String languageId)
languageId - the ID of the language@AutoEscape
java.lang.String getDescription(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 getDescriptionCurrentLanguageId()
@AutoEscape java.lang.String getDescriptionCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()
void setDescription(java.lang.String description)
description - the description of this ddm templatevoid setDescription(java.lang.String description,
java.util.Locale locale)
description - the localized description of this ddm templatelocale - the locale of the languagevoid setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
description - the localized description of this ddm templatelocale - the locale of the languagedefaultLocale - the default localevoid setDescriptionCurrentLanguageId(java.lang.String languageId)
void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)
descriptionMap - the locales and localized descriptions of this ddm templatevoid setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.Locale defaultLocale)
descriptionMap - the locales and localized descriptions of this ddm templatedefaultLocale - the default locale@AutoEscape java.lang.String getType()
void setType(java.lang.String type)
type - the type of this ddm template@AutoEscape java.lang.String getMode()
void setMode(java.lang.String mode)
mode - the mode of this ddm template@AutoEscape java.lang.String getLanguage()
void setLanguage(java.lang.String language)
language - the language of this ddm template@AutoEscape java.lang.String getScript()
void setScript(java.lang.String script)
script - the script of this ddm templateboolean getCacheable()
boolean isCacheable()
true if this ddm template is cacheable.true if this ddm template is cacheable; false otherwisevoid setCacheable(boolean cacheable)
cacheable - the cacheable of this ddm templateboolean getSmallImage()
boolean isSmallImage()
true if this ddm template is small image.true if this ddm template is small image; false otherwisevoid setSmallImage(boolean smallImage)
smallImage - the small image of this ddm templatelong getSmallImageId()
void setSmallImageId(long smallImageId)
smallImageId - the small image ID of this ddm template@AutoEscape java.lang.String getSmallImageURL()
void setSmallImageURL(java.lang.String smallImageURL)
smallImageURL - the small image url of this ddm templatejava.util.Date getLastPublishDate()
getLastPublishDate in interface com.liferay.portal.kernel.model.StagedGroupedModelvoid setLastPublishDate(java.util.Date lastPublishDate)
setLastPublishDate in interface com.liferay.portal.kernel.model.StagedGroupedModellastPublishDate - the last publish date of this ddm 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.LocaleExceptionDDMTemplate cloneWithOriginalValues()
cloneWithOriginalValues in interface com.liferay.portal.kernel.model.BaseModel<DDMTemplate>