Interface DDMFormInstanceModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel
,com.liferay.portal.kernel.model.BaseModel<DDMFormInstance>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<DDMFormInstance>
,com.liferay.portal.kernel.model.change.tracking.CTModel<DDMFormInstance>
,com.liferay.portal.kernel.model.GroupedModel
,com.liferay.portal.kernel.model.LocalizedModel
,com.liferay.portal.kernel.model.MVCCModel
,Serializable
,com.liferay.portal.kernel.model.ShardedModel
,com.liferay.portal.kernel.model.StagedGroupedModel
,com.liferay.portal.kernel.model.StagedModel
- All Known Subinterfaces:
DDMFormInstance
- All Known Implementing Classes:
DDMFormInstanceWrapper
@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
The base model interface for the DDMFormInstance service. Represents a row in the "DDMFormInstance" database table, with each column mapped to a property of this class.
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
.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]
long
Returns the company ID of this ddm form instance.Returns the create date of this ddm form instance.long
Returns the ct collection ID of this ddm form instance.Returns the description of this ddm form instance.getDescription
(String languageId) Returns the localized description of this ddm form instance in the language.getDescription
(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.getDescription
(Locale locale) Returns the localized description of this ddm form instance in the language.getDescription
(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.Returns a map of the locales and localized descriptions of this ddm form instance.long
Returns the form instance ID of this ddm form instance.long
Returns the group ID of this ddm form instance.Returns the last publish date of this ddm form instance.Returns the modified date of this ddm form instance.long
Returns the mvcc version of this ddm form instance.getName()
Returns the name of this ddm form instance.Returns the localized name of this ddm form instance in the language.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.Returns the localized name of this ddm form instance in the language.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.Returns a map of the locales and localized names of this ddm form instance.long
Returns the primary key of this ddm form instance.Returns the settings of this ddm form instance.long
Returns the structure ID of this ddm form instance.long
Returns the user ID of this ddm form instance.Returns the user name of this ddm form instance.Returns the user uuid of this ddm form instance.getUuid()
Returns the uuid of this ddm form instance.Returns the version of this ddm form instance.long
Returns the version user ID of this ddm form instance.Returns the version user name of this ddm form instance.Returns the version user uuid of this ddm form instance.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setCompanyId
(long companyId) Sets the company ID of this ddm form instance.void
setCreateDate
(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
(String description) Sets the description of this ddm form instance.void
setDescription
(String description, Locale locale) Sets the localized description of this ddm form instance in the language.void
setDescription
(String description, Locale locale, Locale defaultLocale) Sets the localized description of this ddm form instance in the language, and sets the default locale.void
setDescriptionCurrentLanguageId
(String languageId) void
setDescriptionMap
(Map<Locale, String> descriptionMap) Sets the localized descriptions of this ddm form instance from the map of locales and localized descriptions.void
setDescriptionMap
(Map<Locale, String> descriptionMap, 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
(Date lastPublishDate) Sets the last publish date of this ddm form instance.void
setModifiedDate
(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
Sets the name of this ddm form instance.void
Sets the localized name of this ddm form instance in the language.void
Sets the localized name of this ddm form instance in the language, and sets the default locale.void
setNameCurrentLanguageId
(String languageId) void
setNameMap
(Map<Locale, String> nameMap) Sets the localized names of this ddm form instance from the map of locales and localized names.void
setNameMap
(Map<Locale, String> nameMap, 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
(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
(String userName) Sets the user name of this ddm form instance.void
setUserUuid
(String userUuid) Sets the user uuid of this ddm form instance.void
Sets the uuid of this ddm form instance.void
setVersion
(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
(String versionUserName) Sets the version user name of this ddm form instance.void
setVersionUserUuid
(String versionUserUuid) Sets the version user uuid of this ddm form instance.default String
Methods 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, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this ddm form instance.- Specified by:
getPrimaryKey
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMFormInstance>
- Returns:
- the primary key of this ddm form instance
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this ddm form instance.- Specified by:
setPrimaryKey
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMFormInstance>
- Parameters:
primaryKey
- the primary key of this ddm form instance
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this ddm form instance.- Specified by:
getMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Returns:
- the mvcc version of this ddm form instance
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this ddm form instance.- Specified by:
setMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this ddm form instance
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this ddm form instance.- Specified by:
getCtCollectionId
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMFormInstance>
- Returns:
- the ct collection ID of this ddm form instance
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this ddm form instance.- Specified by:
setCtCollectionId
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMFormInstance>
- Parameters:
ctCollectionId
- the ct collection ID of this ddm form instance
-
getUuid
Returns the uuid of this ddm form instance.- Specified by:
getUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the uuid of this ddm form instance
-
setUuid
Sets the uuid of this ddm form instance.- Specified by:
setUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
uuid
- the uuid of this ddm form instance
-
getFormInstanceId
long getFormInstanceId()Returns the form instance ID of this ddm form instance.- Returns:
- the form instance ID of this ddm form instance
-
setFormInstanceId
void setFormInstanceId(long formInstanceId) Sets the form instance ID of this ddm form instance.- Parameters:
formInstanceId
- the form instance ID of this ddm form instance
-
getGroupId
long getGroupId()Returns the group ID of this ddm form instance.- Specified by:
getGroupId
in interfacecom.liferay.portal.kernel.model.GroupedModel
- Returns:
- the group ID of this ddm form instance
-
setGroupId
void setGroupId(long groupId) Sets the group ID of this ddm form instance.- Specified by:
setGroupId
in interfacecom.liferay.portal.kernel.model.GroupedModel
- Parameters:
groupId
- the group ID of this ddm form instance
-
getCompanyId
long getCompanyId()Returns the company ID of this ddm form instance.- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the company ID of this ddm form instance
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this ddm form instance.- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
companyId
- the company ID of this ddm form instance
-
getUserId
long getUserId()Returns the user ID of this ddm form instance.- Specified by:
getUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user ID of this ddm form instance
-
setUserId
void setUserId(long userId) Sets the user ID of this ddm form instance.- Specified by:
setUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userId
- the user ID of this ddm form instance
-
getUserUuid
String getUserUuid()Returns the user uuid of this ddm form instance.- Specified by:
getUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user uuid of this ddm form instance
-
setUserUuid
Sets the user uuid of this ddm form instance.- Specified by:
setUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userUuid
- the user uuid of this ddm form instance
-
getUserName
Returns the user name of this ddm form instance.- Specified by:
getUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user name of this ddm form instance
-
setUserName
Sets the user name of this ddm form instance.- Specified by:
setUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userName
- the user name of this ddm form instance
-
getVersionUserId
long getVersionUserId()Returns the version user ID of this ddm form instance.- Returns:
- the version user ID of this ddm form instance
-
setVersionUserId
void setVersionUserId(long versionUserId) Sets the version user ID of this ddm form instance.- Parameters:
versionUserId
- the version user ID of this ddm form instance
-
getVersionUserUuid
String getVersionUserUuid()Returns the version user uuid of this ddm form instance.- Returns:
- the version user uuid of this ddm form instance
-
setVersionUserUuid
Sets the version user uuid of this ddm form instance.- Parameters:
versionUserUuid
- the version user uuid of this ddm form instance
-
getVersionUserName
Returns the version user name of this ddm form instance.- Returns:
- the version user name of this ddm form instance
-
setVersionUserName
Sets the version user name of this ddm form instance.- Parameters:
versionUserName
- the version user name of this ddm form instance
-
getCreateDate
Date getCreateDate()Returns the create date of this ddm form instance.- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the create date of this ddm form instance
-
setCreateDate
Sets the create date of this ddm form instance.- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
createDate
- the create date of this ddm form instance
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this ddm form instance.- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the modified date of this ddm form instance
-
setModifiedDate
Sets the modified date of this ddm form instance.- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
modifiedDate
- the modified date of this ddm form instance
-
getStructureId
long getStructureId()Returns the structure ID of this ddm form instance.- Returns:
- the structure ID of this ddm form instance
-
setStructureId
void setStructureId(long structureId) Sets the structure ID of this ddm form instance.- Parameters:
structureId
- the structure ID of this ddm form instance
-
getVersion
Returns the version of this ddm form instance.- Returns:
- the version of this ddm form instance
-
setVersion
Sets the version of this ddm form instance.- Parameters:
version
- the version of this ddm form instance
-
getName
String getName()Returns the name of this ddm form instance.- Returns:
- the name of this ddm form instance
-
getName
Returns the localized name of this ddm form instance 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 ddm form instance
-
getName
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.- 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 ddm form instance. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getName
Returns the localized name of this ddm form instance 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 ddm form instance
-
getName
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.- 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 ddm form instance
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this ddm form instance.- Returns:
- the locales and localized names of this ddm form instance
-
setName
Sets the name of this ddm form instance.- Parameters:
name
- the name of this ddm form instance
-
setName
Sets the localized name of this ddm form instance in the language.- Parameters:
name
- the localized name of this ddm form instancelocale
- the locale of the language
-
setName
Sets the localized name of this ddm form instance in the language, and sets the default locale.- Parameters:
name
- the localized name of this ddm form instancelocale
- the locale of the languagedefaultLocale
- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this ddm form instance from the map of locales and localized names.- Parameters:
nameMap
- the locales and localized names of this ddm form instance
-
setNameMap
Sets the localized names of this ddm form instance from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap
- the locales and localized names of this ddm form instancedefaultLocale
- the default locale
-
getDescription
String getDescription()Returns the description of this ddm form instance.- Returns:
- the description of this ddm form instance
-
getDescription
Returns the localized description of this ddm form instance 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 description of this ddm form instance
-
getDescription
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.- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this ddm form instance. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getDescription
Returns the localized description of this ddm form instance 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 description of this ddm form instance
-
getDescription
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.- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this ddm form instance
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this ddm form instance.- Returns:
- the locales and localized descriptions of this ddm form instance
-
setDescription
Sets the description of this ddm form instance.- Parameters:
description
- the description of this ddm form instance
-
setDescription
Sets the localized description of this ddm form instance in the language.- Parameters:
description
- the localized description of this ddm form instancelocale
- the locale of the language
-
setDescription
Sets the localized description of this ddm form instance in the language, and sets the default locale.- Parameters:
description
- the localized description of this ddm form instancelocale
- the locale of the languagedefaultLocale
- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this ddm form instance from the map of locales and localized descriptions.- Parameters:
descriptionMap
- the locales and localized descriptions of this ddm form instance
-
setDescriptionMap
Sets the localized descriptions of this ddm form instance from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap
- the locales and localized descriptions of this ddm form instancedefaultLocale
- the default locale
-
getSettings
Returns the settings of this ddm form instance.- Returns:
- the settings of this ddm form instance
-
setSettings
Sets the settings of this ddm form instance.- Parameters:
settings
- the settings of this ddm form instance
-
getLastPublishDate
Date getLastPublishDate()Returns the last publish date of this ddm form instance.- Specified by:
getLastPublishDate
in interfacecom.liferay.portal.kernel.model.StagedGroupedModel
- Returns:
- the last publish date of this ddm form instance
-
setLastPublishDate
Sets the last publish date of this ddm form instance.- Specified by:
setLastPublishDate
in interfacecom.liferay.portal.kernel.model.StagedGroupedModel
- Parameters:
lastPublishDate
- the last publish date of this ddm form instance
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIds
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageId
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImport
in 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:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
DDMFormInstance cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<DDMFormInstance>
-
toXmlString
-