com.liferay.dynamic.data.mapping.model

Interface DDMFormInstanceModel

All Superinterfaces:

AuditedModel, BaseModel<DDMFormInstance>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<DDMFormInstance>, CTModel<DDMFormInstance>, GroupedModel, LocalizedModel, MVCCModel, java.io.Serializable, ShardedModel, StagedGroupedModel, StagedModel

All Known Subinterfaces:

DDMFormInstance

All Known Implementing Classes:

DDMFormInstanceWrapper

@ProviderType
public interface DDMFormInstanceModel
extends BaseModel<DDMFormInstance>, CTModel<DDMFormInstance>, LocalizedModel, MVCCModel, ShardedModel, 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:

DDMFormInstance

Method Summary

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.

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, toXmlString

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface com.liferay.portal.kernel.model.StagedModel

clone, getStagedModelType

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this ddm form instance.

Specified by:

getPrimaryKey in interface 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 interface 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 interface 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 interface 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 interface 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 interface CTModel<DDMFormInstance>

Parameters:

ctCollectionId - the ct collection ID of this ddm form instance

getUuid

@AutoEscape
java.lang.String getUuid()

Returns the uuid of this ddm form instance.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this ddm form instance

setUuid

void setUuid(java.lang.String uuid)

Sets the uuid of this ddm form instance.

Specified by:

setUuid in interface 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 interface 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 interface 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 interface AuditedModel

Specified by:

getCompanyId in interface ShardedModel

Specified by:

getCompanyId in interface 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 interface AuditedModel

Specified by:

setCompanyId in interface ShardedModel

Specified by:

setCompanyId in interface 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 interface 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 interface AuditedModel

Parameters:

userId - the user ID of this ddm form instance

getUserUuid

java.lang.String getUserUuid()

Returns the user uuid of this ddm form instance.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this ddm form instance

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this ddm form instance.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this ddm form instance

getUserName

@AutoEscape
java.lang.String getUserName()

Returns the user name of this ddm form instance.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this ddm form instance

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this ddm form instance.

Specified by:

setUserName in interface 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

java.lang.String getVersionUserUuid()

Returns the version user uuid of this ddm form instance.

Returns:

the version user uuid of this ddm form instance

setVersionUserUuid

void setVersionUserUuid(java.lang.String versionUserUuid)

Sets the version user uuid of this ddm form instance.

Parameters:

versionUserUuid - the version user uuid of this ddm form instance

getVersionUserName

@AutoEscape
java.lang.String getVersionUserName()

Returns the version user name of this ddm form instance.

Returns:

the version user name of this ddm form instance

setVersionUserName

void setVersionUserName(java.lang.String versionUserName)

Sets the version user name of this ddm form instance.

Parameters:

versionUserName - the version user name of this ddm form instance

getCreateDate

java.util.Date getCreateDate()

Returns the create date of this ddm form instance.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this ddm form instance

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this ddm form instance.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this ddm form instance

getModifiedDate

java.util.Date getModifiedDate()

Returns the modified date of this ddm form instance.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this ddm form instance

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this ddm form instance.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface 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

@AutoEscape
java.lang.String getVersion()

Returns the version of this ddm form instance.

Returns:

the version of this ddm form instance

setVersion

void setVersion(java.lang.String version)

Sets the version of this ddm form instance.

Parameters:

version - the version of this ddm form instance

getName

java.lang.String getName()

Returns the name of this ddm form instance.

Returns:

the name of this ddm form instance

getName

@AutoEscape
java.lang.String getName(java.util.Locale locale)

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

@AutoEscape
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.

Parameters:

locale - the local of the language

useDefault - 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 is false and no localization exists for the requested language, an empty string will be returned.

getName

@AutoEscape
java.lang.String getName(java.lang.String languageId)

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

@AutoEscape
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.

Parameters:

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized name of this ddm form instance

getNameCurrentLanguageId

@AutoEscape
java.lang.String getNameCurrentLanguageId()

getNameCurrentValue

@AutoEscape
java.lang.String getNameCurrentValue()

getNameMap

java.util.Map<java.util.Locale,java.lang.String> 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

void setName(java.lang.String name)

Sets the name of this ddm form instance.

Parameters:

name - the name of this ddm form instance

setName

void setName(java.lang.String name,
             java.util.Locale locale)

Sets the localized name of this ddm form instance in the language.

Parameters:

name - the localized name of this ddm form instance

locale - the locale of the language

setName

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.

Parameters:

name - the localized name of this ddm form instance

locale - the locale of the language

defaultLocale - the default locale

setNameCurrentLanguageId

void setNameCurrentLanguageId(java.lang.String languageId)

setNameMap

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.

Parameters:

nameMap - the locales and localized names of this ddm form instance

setNameMap

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.

Parameters:

nameMap - the locales and localized names of this ddm form instance

defaultLocale - the default locale

getDescription

java.lang.String getDescription()

Returns the description of this ddm form instance.

Returns:

the description of this ddm form instance

getDescription

@AutoEscape
java.lang.String getDescription(java.util.Locale locale)

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

@AutoEscape
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.

Parameters:

locale - the local of the language

useDefault - 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 is false and no localization exists for the requested language, an empty string will be returned.

getDescription

@AutoEscape
java.lang.String getDescription(java.lang.String languageId)

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

@AutoEscape
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.

Parameters:

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized description of this ddm form instance

getDescriptionCurrentLanguageId

@AutoEscape
java.lang.String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

@AutoEscape
java.lang.String getDescriptionCurrentValue()

getDescriptionMap

java.util.Map<java.util.Locale,java.lang.String> 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

void setDescription(java.lang.String description)

Sets the description of this ddm form instance.

Parameters:

description - the description of this ddm form instance

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)

Sets the localized description of this ddm form instance in the language.

Parameters:

description - the localized description of this ddm form instance

locale - the locale of the language

setDescription

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.

Parameters:

description - the localized description of this ddm form instance

locale - the locale of the language

defaultLocale - the default locale

setDescriptionCurrentLanguageId

void setDescriptionCurrentLanguageId(java.lang.String languageId)

setDescriptionMap

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.

Parameters:

descriptionMap - the locales and localized descriptions of this ddm form instance

setDescriptionMap

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.

Parameters:

descriptionMap - the locales and localized descriptions of this ddm form instance

defaultLocale - the default locale

getSettings

@AutoEscape
java.lang.String getSettings()

Returns the settings of this ddm form instance.

Returns:

the settings of this ddm form instance

setSettings

void setSettings(java.lang.String settings)

Sets the settings of this ddm form instance.

Parameters:

settings - the settings of this ddm form instance

getLastPublishDate

java.util.Date getLastPublishDate()

Returns the last publish date of this ddm form instance.

Specified by:

getLastPublishDate in interface StagedGroupedModel

Returns:

the last publish date of this ddm form instance

setLastPublishDate

void setLastPublishDate(java.util.Date lastPublishDate)

Sets the last publish date of this ddm form instance.

Specified by:

setLastPublishDate in interface StagedGroupedModel

Parameters:

lastPublishDate - the last publish date of this ddm form instance

getAvailableLanguageIds

java.lang.String[] getAvailableLanguageIds()

Specified by:

getAvailableLanguageIds in interface LocalizedModel

getDefaultLanguageId

java.lang.String getDefaultLanguageId()

Specified by:

getDefaultLanguageId in interface LocalizedModel

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport()
                              throws LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface LocalizedModel

Throws:

LocaleException

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
                              throws LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface LocalizedModel

Throws:

LocaleException