@ProviderType public interface DDMFormInstanceModel extends com.liferay.portal.kernel.model.BaseModel<DDMFormInstance>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMFormInstance>, 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.DDMFormInstanceModelImpl
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.DDMFormInstanceImpl
.
DDMFormInstance
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
getAvailableLanguageIds() |
long |
getCompanyId()
Returns the company ID of this ddm form instance.
|
java.util.Date |
getCreateDate()
Returns the create date of this ddm form instance.
|
long |
getCtCollectionId()
Returns the ct collection ID of this ddm form instance.
|
java.lang.String |
getDefaultLanguageId() |
java.lang.String |
getDescription()
Returns the description of this ddm form instance.
|
java.lang.String |
getDescription(java.util.Locale locale)
Returns the localized description of this ddm form instance in the language.
|
java.lang.String |
getDescription(java.util.Locale locale,
boolean useDefault)
Returns the localized description of this ddm form instance 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 form instance in the language.
|
java.lang.String |
getDescription(java.lang.String languageId,
boolean useDefault)
Returns the localized description of this ddm form instance 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 form instance.
|
long |
getFormInstanceId()
Returns the form instance ID of this ddm form instance.
|
long |
getGroupId()
Returns the group ID of this ddm form instance.
|
java.util.Date |
getLastPublishDate()
Returns the last publish date of this ddm form instance.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this ddm form instance.
|
long |
getMvccVersion()
Returns the mvcc version of this ddm form instance.
|
java.lang.String |
getName()
Returns the name of this ddm form instance.
|
java.lang.String |
getName(java.util.Locale locale)
Returns the localized name of this ddm form instance in the language.
|
java.lang.String |
getName(java.util.Locale locale,
boolean useDefault)
Returns the localized name of this ddm form instance 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 form instance in the language.
|
java.lang.String |
getName(java.lang.String languageId,
boolean useDefault)
Returns the localized name of this ddm form instance 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 form instance.
|
long |
getPrimaryKey()
Returns the primary key of this ddm form instance.
|
java.lang.String |
getSettings()
Returns the settings of this ddm form instance.
|
long |
getStructureId()
Returns the structure ID of this ddm form instance.
|
long |
getUserId()
Returns the user ID of this ddm form instance.
|
java.lang.String |
getUserName()
Returns the user name of this ddm form instance.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this ddm form instance.
|
java.lang.String |
getUuid()
Returns the uuid of this ddm form instance.
|
java.lang.String |
getVersion()
Returns the version of this ddm form instance.
|
long |
getVersionUserId()
Returns the version user ID of this ddm form instance.
|
java.lang.String |
getVersionUserName()
Returns the version user name of this ddm form instance.
|
java.lang.String |
getVersionUserUuid()
Returns the version user uuid of this ddm form instance.
|
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setCompanyId(long companyId)
Sets the company ID of this ddm form instance.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this ddm form instance.
|
void |
setCtCollectionId(long ctCollectionId)
Sets the ct collection ID of this ddm form instance.
|
void |
setDescription(java.lang.String description)
Sets the description of this ddm form instance.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets the localized description of this ddm form instance in the language.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized description of this ddm form instance 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 form instance 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 form instance from the map of locales and localized descriptions, and sets the default locale.
|
void |
setFormInstanceId(long formInstanceId)
Sets the form instance ID of this ddm form instance.
|
void |
setGroupId(long groupId)
Sets the group ID of this ddm form instance.
|
void |
setLastPublishDate(java.util.Date lastPublishDate)
Sets the last publish date of this ddm form instance.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this ddm form instance.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this ddm form instance.
|
void |
setName(java.lang.String name)
Sets the name of this ddm form instance.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Sets the localized name of this ddm form instance in the language.
|
void |
setName(java.lang.String name,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized name of this ddm form instance 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 form instance 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 form instance from the map of locales and localized names, and sets the default locale.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this ddm form instance.
|
void |
setSettings(java.lang.String settings)
Sets the settings of this ddm form instance.
|
void |
setStructureId(long structureId)
Sets the structure ID of this ddm form instance.
|
void |
setUserId(long userId)
Sets the user ID of this ddm form instance.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this ddm form instance.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this ddm form instance.
|
void |
setUuid(java.lang.String uuid)
Sets the uuid of this ddm form instance.
|
void |
setVersion(java.lang.String version)
Sets the version of this ddm form instance.
|
void |
setVersionUserId(long versionUserId)
Sets the version user ID of this ddm form instance.
|
void |
setVersionUserName(java.lang.String versionUserName)
Sets the version user name of this ddm form instance.
|
void |
setVersionUserUuid(java.lang.String versionUserUuid)
Sets the version user uuid of this ddm form instance.
|
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()
getPrimaryKey
in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMFormInstance>
void setPrimaryKey(long primaryKey)
setPrimaryKey
in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMFormInstance>
primaryKey
- the primary key of this ddm form instancelong 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 ddm form instancelong getCtCollectionId()
getCtCollectionId
in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMFormInstance>
void setCtCollectionId(long ctCollectionId)
setCtCollectionId
in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMFormInstance>
ctCollectionId
- the ct collection ID of this ddm form instance@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 ddm form instancelong getFormInstanceId()
void setFormInstanceId(long formInstanceId)
formInstanceId
- the form instance ID of this ddm form instancelong 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 ddm form instancelong 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 ddm form instancelong 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 ddm form instancejava.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 ddm form instance@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 ddm form instancelong getVersionUserId()
void setVersionUserId(long versionUserId)
versionUserId
- the version user ID of this ddm form instancejava.lang.String getVersionUserUuid()
void setVersionUserUuid(java.lang.String versionUserUuid)
versionUserUuid
- the version user uuid of this ddm form instance@AutoEscape java.lang.String getVersionUserName()
void setVersionUserName(java.lang.String versionUserName)
versionUserName
- the version user name of this ddm form instancejava.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 ddm form instancejava.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 ddm form instancelong getStructureId()
void setStructureId(long structureId)
structureId
- the structure ID of this ddm form instance@AutoEscape java.lang.String getVersion()
void setVersion(java.lang.String version)
version
- the version of this ddm form instancejava.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 form instancevoid setName(java.lang.String name, java.util.Locale locale)
name
- the localized name of this ddm form instancelocale
- 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 form instancelocale
- 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 form instancevoid setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Locale defaultLocale)
nameMap
- the locales and localized names of this ddm form instancedefaultLocale
- 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 form instancevoid setDescription(java.lang.String description, java.util.Locale locale)
description
- the localized description of this ddm form instancelocale
- 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 form instancelocale
- 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 form instancevoid setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Locale defaultLocale)
descriptionMap
- the locales and localized descriptions of this ddm form instancedefaultLocale
- the default locale@AutoEscape java.lang.String getSettings()
void setSettings(java.lang.String settings)
settings
- the settings of this ddm form instancejava.util.Date getLastPublishDate()
getLastPublishDate
in interface com.liferay.portal.kernel.model.StagedGroupedModel
void setLastPublishDate(java.util.Date lastPublishDate)
setLastPublishDate
in interface com.liferay.portal.kernel.model.StagedGroupedModel
lastPublishDate
- the last publish date of this ddm form instancejava.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