com.liferay.dynamic.data.mapping.model

Interface DDMStructureLayoutModel

All Superinterfaces:

AuditedModel, BaseModel<DDMStructureLayout>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<DDMStructureLayout>, CTModel<DDMStructureLayout>, GroupedModel, LocalizedModel, MVCCModel, java.io.Serializable, ShardedModel, StagedAuditedModel, StagedModel, TypedModel

All Known Subinterfaces:

DDMStructureLayout

All Known Implementing Classes:

DDMStructureLayoutWrapper

@ProviderType
public interface DDMStructureLayoutModel
extends BaseModel<DDMStructureLayout>, CTModel<DDMStructureLayout>, GroupedModel, LocalizedModel, MVCCModel, ShardedModel, StagedAuditedModel, TypedModel

The base model interface for the DDMStructureLayout service. Represents a row in the "DDMStructureLayout" 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.DDMStructureLayoutModelImpl 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.DDMStructureLayoutImpl.

See Also:

DDMStructureLayout

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAvailableLanguageIds()
java.lang.String	getClassName() Returns the fully qualified class name of this ddm structure layout.
long	getClassNameId() Returns the class name ID of this ddm structure layout.
long	getCompanyId() Returns the company ID of this ddm structure layout.
java.util.Date	getCreateDate() Returns the create date of this ddm structure layout.
long	getCtCollectionId() Returns the ct collection ID of this ddm structure layout.
java.lang.String	getDefaultLanguageId()
java.lang.String	getDefinition() Returns the definition of this ddm structure layout.
java.lang.String	getDescription() Returns the description of this ddm structure layout.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this ddm structure layout in the language.
java.lang.String	getDescription(java.util.Locale locale, boolean useDefault) Returns the localized description of this ddm structure layout 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 structure layout in the language.
java.lang.String	getDescription(java.lang.String languageId, boolean useDefault) Returns the localized description of this ddm structure layout 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 structure layout.
long	getGroupId() Returns the group ID of this ddm structure layout.
java.util.Date	getModifiedDate() Returns the modified date of this ddm structure layout.
long	getMvccVersion() Returns the mvcc version of this ddm structure layout.
java.lang.String	getName() Returns the name of this ddm structure layout.
java.lang.String	getName(java.util.Locale locale) Returns the localized name of this ddm structure layout in the language.
java.lang.String	getName(java.util.Locale locale, boolean useDefault) Returns the localized name of this ddm structure layout 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 structure layout in the language.
java.lang.String	getName(java.lang.String languageId, boolean useDefault) Returns the localized name of this ddm structure layout 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 structure layout.
long	getPrimaryKey() Returns the primary key of this ddm structure layout.
long	getStructureLayoutId() Returns the structure layout ID of this ddm structure layout.
java.lang.String	getStructureLayoutKey() Returns the structure layout key of this ddm structure layout.
long	getStructureVersionId() Returns the structure version ID of this ddm structure layout.
long	getUserId() Returns the user ID of this ddm structure layout.
java.lang.String	getUserName() Returns the user name of this ddm structure layout.
java.lang.String	getUserUuid() Returns the user uuid of this ddm structure layout.
java.lang.String	getUuid() Returns the uuid of this ddm structure layout.
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
void	setClassName(java.lang.String className)
void	setClassNameId(long classNameId) Sets the class name ID of this ddm structure layout.
void	setCompanyId(long companyId) Sets the company ID of this ddm structure layout.
void	setCreateDate(java.util.Date createDate) Sets the create date of this ddm structure layout.
void	setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this ddm structure layout.
void	setDefinition(java.lang.String definition) Sets the definition of this ddm structure layout.
void	setDescription(java.lang.String description) Sets the description of this ddm structure layout.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this ddm structure layout in the language.
void	setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized description of this ddm structure layout 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 structure layout 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 structure layout from the map of locales and localized descriptions, and sets the default locale.
void	setGroupId(long groupId) Sets the group ID of this ddm structure layout.
void	setModifiedDate(java.util.Date modifiedDate) Sets the modified date of this ddm structure layout.
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this ddm structure layout.
void	setName(java.lang.String name) Sets the name of this ddm structure layout.
void	setName(java.lang.String name, java.util.Locale locale) Sets the localized name of this ddm structure layout in the language.
void	setName(java.lang.String name, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized name of this ddm structure layout 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 structure layout 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 structure layout from the map of locales and localized names, and sets the default locale.
void	setPrimaryKey(long primaryKey) Sets the primary key of this ddm structure layout.
void	setStructureLayoutId(long structureLayoutId) Sets the structure layout ID of this ddm structure layout.
void	setStructureLayoutKey(java.lang.String structureLayoutKey) Sets the structure layout key of this ddm structure layout.
void	setStructureVersionId(long structureVersionId) Sets the structure version ID of this ddm structure layout.
void	setUserId(long userId) Sets the user ID of this ddm structure layout.
void	setUserName(java.lang.String userName) Sets the user name of this ddm structure layout.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this ddm structure layout.
void	setUuid(java.lang.String uuid) Sets the uuid of this ddm structure layout.

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.StagedModel

clone, getStagedModelType

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

getModelClass, getModelClassName

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this ddm structure layout.

Specified by:

getPrimaryKey in interface CTModel<DDMStructureLayout>

Returns:

the primary key of this ddm structure layout

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this ddm structure layout.

Specified by:

setPrimaryKey in interface CTModel<DDMStructureLayout>

Parameters:

primaryKey - the primary key of this ddm structure layout

getMvccVersion

long getMvccVersion()

Returns the mvcc version of this ddm structure layout.

Specified by:

getMvccVersion in interface MVCCModel

Returns:

the mvcc version of this ddm structure layout

setMvccVersion

void setMvccVersion(long mvccVersion)

Sets the mvcc version of this ddm structure layout.

Specified by:

setMvccVersion in interface MVCCModel

Parameters:

mvccVersion - the mvcc version of this ddm structure layout

getCtCollectionId

long getCtCollectionId()

Returns the ct collection ID of this ddm structure layout.

Specified by:

getCtCollectionId in interface CTModel<DDMStructureLayout>

Returns:

the ct collection ID of this ddm structure layout

setCtCollectionId

void setCtCollectionId(long ctCollectionId)

Sets the ct collection ID of this ddm structure layout.

Specified by:

setCtCollectionId in interface CTModel<DDMStructureLayout>

Parameters:

ctCollectionId - the ct collection ID of this ddm structure layout

getUuid

@AutoEscape
java.lang.String getUuid()

Returns the uuid of this ddm structure layout.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this ddm structure layout

setUuid

void setUuid(java.lang.String uuid)

Sets the uuid of this ddm structure layout.

Specified by:

setUuid in interface StagedModel

Parameters:

uuid - the uuid of this ddm structure layout

getStructureLayoutId

long getStructureLayoutId()

Returns the structure layout ID of this ddm structure layout.

Returns:

the structure layout ID of this ddm structure layout

setStructureLayoutId

void setStructureLayoutId(long structureLayoutId)

Sets the structure layout ID of this ddm structure layout.

Parameters:

structureLayoutId - the structure layout ID of this ddm structure layout

getGroupId

long getGroupId()

Returns the group ID of this ddm structure layout.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this ddm structure layout

setGroupId

void setGroupId(long groupId)

Sets the group ID of this ddm structure layout.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this ddm structure layout

getCompanyId

long getCompanyId()

Returns the company ID of this ddm structure layout.

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 structure layout

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this ddm structure layout.

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 structure layout

getUserId

long getUserId()

Returns the user ID of this ddm structure layout.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this ddm structure layout

setUserId

void setUserId(long userId)

Sets the user ID of this ddm structure layout.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this ddm structure layout

getUserUuid

java.lang.String getUserUuid()

Returns the user uuid of this ddm structure layout.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this ddm structure layout

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this ddm structure layout.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this ddm structure layout

getUserName

@AutoEscape
java.lang.String getUserName()

Returns the user name of this ddm structure layout.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this ddm structure layout

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this ddm structure layout.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this ddm structure layout

getCreateDate

java.util.Date getCreateDate()

Returns the create date of this ddm structure layout.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this ddm structure layout

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this ddm structure layout.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this ddm structure layout

getModifiedDate

java.util.Date getModifiedDate()

Returns the modified date of this ddm structure layout.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this ddm structure layout

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this ddm structure layout.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Parameters:

modifiedDate - the modified date of this ddm structure layout

getClassName

java.lang.String getClassName()

Returns the fully qualified class name of this ddm structure layout.

Specified by:

getClassName in interface TypedModel

Returns:

the fully qualified class name of this ddm structure layout

setClassName

void setClassName(java.lang.String className)

getClassNameId

long getClassNameId()

Returns the class name ID of this ddm structure layout.

Specified by:

getClassNameId in interface TypedModel

Returns:

the class name ID of this ddm structure layout

setClassNameId

void setClassNameId(long classNameId)

Sets the class name ID of this ddm structure layout.

Specified by:

setClassNameId in interface TypedModel

Parameters:

classNameId - the class name ID of this ddm structure layout

getStructureLayoutKey

java.lang.String getStructureLayoutKey()

Returns the structure layout key of this ddm structure layout.

Returns:

the structure layout key of this ddm structure layout

setStructureLayoutKey

void setStructureLayoutKey(java.lang.String structureLayoutKey)

Sets the structure layout key of this ddm structure layout.

Parameters:

structureLayoutKey - the structure layout key of this ddm structure layout

getStructureVersionId

long getStructureVersionId()

Returns the structure version ID of this ddm structure layout.

Returns:

the structure version ID of this ddm structure layout

setStructureVersionId

void setStructureVersionId(long structureVersionId)

Sets the structure version ID of this ddm structure layout.

Parameters:

structureVersionId - the structure version ID of this ddm structure layout

getName

java.lang.String getName()

Returns the name of this ddm structure layout.

Returns:

the name of this ddm structure layout

getName

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

Returns the localized name of this ddm structure layout 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 structure layout

getName

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

Returns the localized name of this ddm structure layout 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 structure layout. 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 structure layout 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 structure layout

getName

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

Returns the localized name of this ddm structure layout 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 structure layout

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 structure layout.

Returns:

the locales and localized names of this ddm structure layout

setName

void setName(java.lang.String name)

Sets the name of this ddm structure layout.

Parameters:

name - the name of this ddm structure layout

setName

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

Sets the localized name of this ddm structure layout in the language.

Parameters:

name - the localized name of this ddm structure layout

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 structure layout in the language, and sets the default locale.

Parameters:

name - the localized name of this ddm structure layout

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 structure layout from the map of locales and localized names.

Parameters:

nameMap - the locales and localized names of this ddm structure layout

setNameMap

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

Sets the localized names of this ddm structure layout from the map of locales and localized names, and sets the default locale.

Parameters:

nameMap - the locales and localized names of this ddm structure layout

defaultLocale - the default locale

getDescription

java.lang.String getDescription()

Returns the description of this ddm structure layout.

Returns:

the description of this ddm structure layout

getDescription

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

Returns the localized description of this ddm structure layout 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 structure layout

getDescription

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

Returns the localized description of this ddm structure layout 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 structure layout. 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 structure layout 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 structure layout

getDescription

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

Returns the localized description of this ddm structure layout 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 structure layout

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 structure layout.

Returns:

the locales and localized descriptions of this ddm structure layout

setDescription

void setDescription(java.lang.String description)

Sets the description of this ddm structure layout.

Parameters:

description - the description of this ddm structure layout

setDescription

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

Sets the localized description of this ddm structure layout in the language.

Parameters:

description - the localized description of this ddm structure layout

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 structure layout in the language, and sets the default locale.

Parameters:

description - the localized description of this ddm structure layout

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 structure layout from the map of locales and localized descriptions.

Parameters:

descriptionMap - the locales and localized descriptions of this ddm structure layout

setDescriptionMap

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

Sets the localized descriptions of this ddm structure layout from the map of locales and localized descriptions, and sets the default locale.

Parameters:

descriptionMap - the locales and localized descriptions of this ddm structure layout

defaultLocale - the default locale

getDefinition

@AutoEscape
java.lang.String getDefinition()

Returns the definition of this ddm structure layout.

Returns:

the definition of this ddm structure layout

setDefinition

void setDefinition(java.lang.String definition)

Sets the definition of this ddm structure layout.

Parameters:

definition - the definition of this ddm structure layout

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