com.liferay.dynamic.data.lists.model

Interface DDLRecordSetModel

All Superinterfaces:

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

All Known Subinterfaces:

DDLRecordSet

All Known Implementing Classes:

DDLRecordSetWrapper

@ProviderType
public interface DDLRecordSetModel
extends BaseModel<DDLRecordSet>, LocalizedModel, MVCCModel, ShardedModel, StagedGroupedModel

The base model interface for the DDLRecordSet service. Represents a row in the "DDLRecordSet" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.dynamic.data.lists.model.impl.DDLRecordSetModelImpl 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.lists.model.impl.DDLRecordSetImpl.

See Also:

DDLRecordSet

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAvailableLanguageIds()
long	getCompanyId() Returns the company ID of this ddl record set.
java.util.Date	getCreateDate() Returns the create date of this ddl record set.
long	getDDMStructureId() Returns the ddm structure ID of this ddl record set.
java.lang.String	getDefaultLanguageId()
java.lang.String	getDescription() Returns the description of this ddl record set.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this ddl record set in the language.
java.lang.String	getDescription(java.util.Locale locale, boolean useDefault) Returns the localized description of this ddl record set 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 ddl record set in the language.
java.lang.String	getDescription(java.lang.String languageId, boolean useDefault) Returns the localized description of this ddl record set 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 ddl record set.
long	getGroupId() Returns the group ID of this ddl record set.
java.util.Date	getLastPublishDate() Returns the last publish date of this ddl record set.
int	getMinDisplayRows() Returns the min display rows of this ddl record set.
java.util.Date	getModifiedDate() Returns the modified date of this ddl record set.
long	getMvccVersion() Returns the mvcc version of this ddl record set.
java.lang.String	getName() Returns the name of this ddl record set.
java.lang.String	getName(java.util.Locale locale) Returns the localized name of this ddl record set in the language.
java.lang.String	getName(java.util.Locale locale, boolean useDefault) Returns the localized name of this ddl record set 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 ddl record set in the language.
java.lang.String	getName(java.lang.String languageId, boolean useDefault) Returns the localized name of this ddl record set 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 ddl record set.
long	getPrimaryKey() Returns the primary key of this ddl record set.
long	getRecordSetId() Returns the record set ID of this ddl record set.
java.lang.String	getRecordSetKey() Returns the record set key of this ddl record set.
int	getScope() Returns the scope of this ddl record set.
java.lang.String	getSettings() Returns the settings of this ddl record set.
long	getUserId() Returns the user ID of this ddl record set.
java.lang.String	getUserName() Returns the user name of this ddl record set.
java.lang.String	getUserUuid() Returns the user uuid of this ddl record set.
java.lang.String	getUuid() Returns the uuid of this ddl record set.
java.lang.String	getVersion() Returns the version of this ddl record set.
long	getVersionUserId() Returns the version user ID of this ddl record set.
java.lang.String	getVersionUserName() Returns the version user name of this ddl record set.
java.lang.String	getVersionUserUuid() Returns the version user uuid of this ddl record set.
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
void	setCompanyId(long companyId) Sets the company ID of this ddl record set.
void	setCreateDate(java.util.Date createDate) Sets the create date of this ddl record set.
void	setDDMStructureId(long DDMStructureId) Sets the ddm structure ID of this ddl record set.
void	setDescription(java.lang.String description) Sets the description of this ddl record set.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this ddl record set in the language.
void	setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized description of this ddl record set 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 ddl record set 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 ddl record set from the map of locales and localized descriptions, and sets the default locale.
void	setGroupId(long groupId) Sets the group ID of this ddl record set.
void	setLastPublishDate(java.util.Date lastPublishDate) Sets the last publish date of this ddl record set.
void	setMinDisplayRows(int minDisplayRows) Sets the min display rows of this ddl record set.
void	setModifiedDate(java.util.Date modifiedDate) Sets the modified date of this ddl record set.
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this ddl record set.
void	setName(java.lang.String name) Sets the name of this ddl record set.
void	setName(java.lang.String name, java.util.Locale locale) Sets the localized name of this ddl record set in the language.
void	setName(java.lang.String name, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized name of this ddl record set 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 ddl record set 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 ddl record set from the map of locales and localized names, and sets the default locale.
void	setPrimaryKey(long primaryKey) Sets the primary key of this ddl record set.
void	setRecordSetId(long recordSetId) Sets the record set ID of this ddl record set.
void	setRecordSetKey(java.lang.String recordSetKey) Sets the record set key of this ddl record set.
void	setScope(int scope) Sets the scope of this ddl record set.
void	setSettings(java.lang.String settings) Sets the settings of this ddl record set.
void	setUserId(long userId) Sets the user ID of this ddl record set.
void	setUserName(java.lang.String userName) Sets the user name of this ddl record set.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this ddl record set.
void	setUuid(java.lang.String uuid) Sets the uuid of this ddl record set.
void	setVersion(java.lang.String version) Sets the version of this ddl record set.
void	setVersionUserId(long versionUserId) Sets the version user ID of this ddl record set.
void	setVersionUserName(java.lang.String versionUserName) Sets the version user name of this ddl record set.
void	setVersionUserUuid(java.lang.String versionUserUuid) Sets the version user uuid of this ddl record set.

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 ddl record set.

Returns:

the primary key of this ddl record set

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this ddl record set.

Parameters:

primaryKey - the primary key of this ddl record set

getMvccVersion

long getMvccVersion()

Returns the mvcc version of this ddl record set.

Specified by:

getMvccVersion in interface MVCCModel

Returns:

the mvcc version of this ddl record set

setMvccVersion

void setMvccVersion(long mvccVersion)

Sets the mvcc version of this ddl record set.

Specified by:

setMvccVersion in interface MVCCModel

Parameters:

mvccVersion - the mvcc version of this ddl record set

getUuid

@AutoEscape
java.lang.String getUuid()

Returns the uuid of this ddl record set.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this ddl record set

setUuid

void setUuid(java.lang.String uuid)

Sets the uuid of this ddl record set.

Specified by:

setUuid in interface StagedModel

Parameters:

uuid - the uuid of this ddl record set

getRecordSetId

long getRecordSetId()

Returns the record set ID of this ddl record set.

Returns:

the record set ID of this ddl record set

setRecordSetId

void setRecordSetId(long recordSetId)

Sets the record set ID of this ddl record set.

Parameters:

recordSetId - the record set ID of this ddl record set

getGroupId

long getGroupId()

Returns the group ID of this ddl record set.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this ddl record set

setGroupId

void setGroupId(long groupId)

Sets the group ID of this ddl record set.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this ddl record set

getCompanyId

long getCompanyId()

Returns the company ID of this ddl record set.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface ShardedModel

Specified by:

getCompanyId in interface StagedModel

Returns:

the company ID of this ddl record set

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this ddl record set.

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 ddl record set

getUserId

long getUserId()

Returns the user ID of this ddl record set.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this ddl record set

setUserId

void setUserId(long userId)

Sets the user ID of this ddl record set.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this ddl record set

getUserUuid

java.lang.String getUserUuid()

Returns the user uuid of this ddl record set.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this ddl record set

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this ddl record set.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this ddl record set

getUserName

@AutoEscape
java.lang.String getUserName()

Returns the user name of this ddl record set.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this ddl record set

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this ddl record set.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this ddl record set

getVersionUserId

long getVersionUserId()

Returns the version user ID of this ddl record set.

Returns:

the version user ID of this ddl record set

setVersionUserId

void setVersionUserId(long versionUserId)

Sets the version user ID of this ddl record set.

Parameters:

versionUserId - the version user ID of this ddl record set

getVersionUserUuid

java.lang.String getVersionUserUuid()

Returns the version user uuid of this ddl record set.

Returns:

the version user uuid of this ddl record set

setVersionUserUuid

void setVersionUserUuid(java.lang.String versionUserUuid)

Sets the version user uuid of this ddl record set.

Parameters:

versionUserUuid - the version user uuid of this ddl record set

getVersionUserName

@AutoEscape
java.lang.String getVersionUserName()

Returns the version user name of this ddl record set.

Returns:

the version user name of this ddl record set

setVersionUserName

void setVersionUserName(java.lang.String versionUserName)

Sets the version user name of this ddl record set.

Parameters:

versionUserName - the version user name of this ddl record set

getCreateDate

java.util.Date getCreateDate()

Returns the create date of this ddl record set.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this ddl record set

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this ddl record set.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this ddl record set

getModifiedDate

java.util.Date getModifiedDate()

Returns the modified date of this ddl record set.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this ddl record set

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this ddl record set.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Parameters:

modifiedDate - the modified date of this ddl record set

getDDMStructureId

long getDDMStructureId()

Returns the ddm structure ID of this ddl record set.

Returns:

the ddm structure ID of this ddl record set

setDDMStructureId

void setDDMStructureId(long DDMStructureId)

Sets the ddm structure ID of this ddl record set.

Parameters:

DDMStructureId - the ddm structure ID of this ddl record set

getRecordSetKey

java.lang.String getRecordSetKey()

Returns the record set key of this ddl record set.

Returns:

the record set key of this ddl record set

setRecordSetKey

void setRecordSetKey(java.lang.String recordSetKey)

Sets the record set key of this ddl record set.

Parameters:

recordSetKey - the record set key of this ddl record set

getVersion

@AutoEscape
java.lang.String getVersion()

Returns the version of this ddl record set.

Returns:

the version of this ddl record set

setVersion

void setVersion(java.lang.String version)

Sets the version of this ddl record set.

Parameters:

version - the version of this ddl record set

getName

java.lang.String getName()

Returns the name of this ddl record set.

Returns:

the name of this ddl record set

getName

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

Returns the localized name of this ddl record set 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 ddl record set

getName

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

Returns the localized name of this ddl record set 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 ddl record set. 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 ddl record set 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 ddl record set

getName

@AutoEscape
java.lang.String getName(java.lang.String languageId,
                                     boolean useDefault)

Returns the localized name of this ddl record set 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 ddl record set

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 ddl record set.

Returns:

the locales and localized names of this ddl record set

setName

void setName(java.lang.String name)

Sets the name of this ddl record set.

Parameters:

name - the name of this ddl record set

setName

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

Sets the localized name of this ddl record set in the language.

Parameters:

name - the localized name of this ddl record set

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 ddl record set in the language, and sets the default locale.

Parameters:

name - the localized name of this ddl record set

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 ddl record set from the map of locales and localized names.

Parameters:

nameMap - the locales and localized names of this ddl record set

setNameMap

void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
                java.util.Locale defaultLocale)

Sets the localized names of this ddl record set from the map of locales and localized names, and sets the default locale.

Parameters:

nameMap - the locales and localized names of this ddl record set

defaultLocale - the default locale

getDescription

java.lang.String getDescription()

Returns the description of this ddl record set.

Returns:

the description of this ddl record set

getDescription

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

Returns the localized description of this ddl record set 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 ddl record set

getDescription

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

Returns the localized description of this ddl record set 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 ddl record set. 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 ddl record set 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 ddl record set

getDescription

@AutoEscape
java.lang.String getDescription(java.lang.String languageId,
                                            boolean useDefault)

Returns the localized description of this ddl record set 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 ddl record set

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 ddl record set.

Returns:

the locales and localized descriptions of this ddl record set

setDescription

void setDescription(java.lang.String description)

Sets the description of this ddl record set.

Parameters:

description - the description of this ddl record set

setDescription

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

Sets the localized description of this ddl record set in the language.

Parameters:

description - the localized description of this ddl record set

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 ddl record set in the language, and sets the default locale.

Parameters:

description - the localized description of this ddl record set

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 ddl record set from the map of locales and localized descriptions.

Parameters:

descriptionMap - the locales and localized descriptions of this ddl record set

setDescriptionMap

void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                       java.util.Locale defaultLocale)

Sets the localized descriptions of this ddl record set from the map of locales and localized descriptions, and sets the default locale.

Parameters:

descriptionMap - the locales and localized descriptions of this ddl record set

defaultLocale - the default locale

getMinDisplayRows

int getMinDisplayRows()

Returns the min display rows of this ddl record set.

Returns:

the min display rows of this ddl record set

setMinDisplayRows

void setMinDisplayRows(int minDisplayRows)

Sets the min display rows of this ddl record set.

Parameters:

minDisplayRows - the min display rows of this ddl record set

getScope

int getScope()

Returns the scope of this ddl record set.

Returns:

the scope of this ddl record set

setScope

void setScope(int scope)

Sets the scope of this ddl record set.

Parameters:

scope - the scope of this ddl record set

getSettings

@AutoEscape
java.lang.String getSettings()

Returns the settings of this ddl record set.

Returns:

the settings of this ddl record set

setSettings

void setSettings(java.lang.String settings)

Sets the settings of this ddl record set.

Parameters:

settings - the settings of this ddl record set

getLastPublishDate

java.util.Date getLastPublishDate()

Returns the last publish date of this ddl record set.

Specified by:

getLastPublishDate in interface StagedGroupedModel

Returns:

the last publish date of this ddl record set

setLastPublishDate

void setLastPublishDate(java.util.Date lastPublishDate)

Sets the last publish date of this ddl record set.

Specified by:

setLastPublishDate in interface StagedGroupedModel

Parameters:

lastPublishDate - the last publish date of this ddl record set

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