Interface DDMStructureLayoutModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel,com.liferay.portal.kernel.model.BaseModel<DDMStructureLayout>,com.liferay.portal.kernel.model.ClassedModel,Cloneable,Comparable<DDMStructureLayout>,com.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructureLayout>,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.StagedAuditedModel,com.liferay.portal.kernel.model.StagedModel,com.liferay.portal.kernel.model.TypedModel
- All Known Subinterfaces:
DDMStructureLayout
- All Known Implementing Classes:
DDMStructureLayoutWrapper
@ProviderType
public interface DDMStructureLayoutModel
extends com.liferay.portal.kernel.model.BaseModel<DDMStructureLayout>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructureLayout>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel, com.liferay.portal.kernel.model.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:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]Returns the fully qualified class name of this ddm structure layout.longReturns the class name ID of this ddm structure layout.longReturns the company ID of this ddm structure layout.Returns the create date of this ddm structure layout.longReturns the ct collection ID of this ddm structure layout.Returns the definition of this ddm structure layout.Returns the description of this ddm structure layout.getDescription(String languageId) Returns the localized description of this ddm structure layout in the language.getDescription(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.getDescription(Locale locale) Returns the localized description of this ddm structure layout in the language.getDescription(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.Returns a map of the locales and localized descriptions of this ddm structure layout.longReturns the group ID of this ddm structure layout.Returns the modified date of this ddm structure layout.longReturns the mvcc version of this ddm structure layout.getName()Returns the name of this ddm structure layout.Returns the localized name of this ddm structure layout in the language.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.Returns the localized name of this ddm structure layout in the language.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.Returns a map of the locales and localized names of this ddm structure layout.longReturns the primary key of this ddm structure layout.longReturns the structure layout ID of this ddm structure layout.Returns the structure layout key of this ddm structure layout.longReturns the structure version ID of this ddm structure layout.longReturns the user ID of this ddm structure layout.Returns the user name of this ddm structure layout.Returns the user uuid of this ddm structure layout.getUuid()Returns the uuid of this ddm structure layout.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidsetClassName(String className) voidsetClassNameId(long classNameId) Sets the class name ID of this ddm structure layout.voidsetCompanyId(long companyId) Sets the company ID of this ddm structure layout.voidsetCreateDate(Date createDate) Sets the create date of this ddm structure layout.voidsetCtCollectionId(long ctCollectionId) Sets the ct collection ID of this ddm structure layout.voidsetDefinition(String definition) Sets the definition of this ddm structure layout.voidsetDescription(String description) Sets the description of this ddm structure layout.voidsetDescription(String description, Locale locale) Sets the localized description of this ddm structure layout in the language.voidsetDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this ddm structure layout in the language, and sets the default locale.voidsetDescriptionCurrentLanguageId(String languageId) voidsetDescriptionMap(Map<Locale, String> descriptionMap) Sets the localized descriptions of this ddm structure layout from the map of locales and localized descriptions.voidsetDescriptionMap(Map<Locale, String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this ddm structure layout from the map of locales and localized descriptions, and sets the default locale.voidsetGroupId(long groupId) Sets the group ID of this ddm structure layout.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this ddm structure layout.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this ddm structure layout.voidSets the name of this ddm structure layout.voidSets the localized name of this ddm structure layout in the language.voidSets the localized name of this ddm structure layout in the language, and sets the default locale.voidsetNameCurrentLanguageId(String languageId) voidsetNameMap(Map<Locale, String> nameMap) Sets the localized names of this ddm structure layout from the map of locales and localized names.voidsetNameMap(Map<Locale, String> nameMap, Locale defaultLocale) Sets the localized names of this ddm structure layout from the map of locales and localized names, and sets the default locale.voidsetPrimaryKey(long primaryKey) Sets the primary key of this ddm structure layout.voidsetStructureLayoutId(long structureLayoutId) Sets the structure layout ID of this ddm structure layout.voidsetStructureLayoutKey(String structureLayoutKey) Sets the structure layout key of this ddm structure layout.voidsetStructureVersionId(long structureVersionId) Sets the structure version ID of this ddm structure layout.voidsetUserId(long userId) Sets the user ID of this ddm structure layout.voidsetUserName(String userName) Sets the user name of this ddm structure layout.voidsetUserUuid(String userUuid) Sets the user uuid of this ddm structure layout.voidSets the uuid of this ddm structure layout.default StringMethods 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, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this ddm structure layout.- Specified by:
getPrimaryKeyin interfacecom.liferay.portal.kernel.model.change.tracking.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:
setPrimaryKeyin interfacecom.liferay.portal.kernel.model.change.tracking.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:
getMvccVersionin interfacecom.liferay.portal.kernel.model.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:
setMvccVersionin interfacecom.liferay.portal.kernel.model.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:
getCtCollectionIdin interfacecom.liferay.portal.kernel.model.change.tracking.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:
setCtCollectionIdin interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructureLayout>- Parameters:
ctCollectionId- the ct collection ID of this ddm structure layout
-
getUuid
Returns the uuid of this ddm structure layout.- Specified by:
getUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the uuid of this ddm structure layout
-
setUuid
Sets the uuid of this ddm structure layout.- Specified by:
setUuidin interfacecom.liferay.portal.kernel.model.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:
getGroupIdin interfacecom.liferay.portal.kernel.model.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:
setGroupIdin interfacecom.liferay.portal.kernel.model.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:
getCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.ShardedModel- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.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:
setCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.ShardedModel- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.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:
getUserIdin interfacecom.liferay.portal.kernel.model.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:
setUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userId- the user ID of this ddm structure layout
-
getUserUuid
String getUserUuid()Returns the user uuid of this ddm structure layout.- Specified by:
getUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user uuid of this ddm structure layout
-
setUserUuid
Sets the user uuid of this ddm structure layout.- Specified by:
setUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userUuid- the user uuid of this ddm structure layout
-
getUserName
Returns the user name of this ddm structure layout.- Specified by:
getUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user name of this ddm structure layout
-
setUserName
Sets the user name of this ddm structure layout.- Specified by:
setUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userName- the user name of this ddm structure layout
-
getCreateDate
Date getCreateDate()Returns the create date of this ddm structure layout.- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the create date of this ddm structure layout
-
setCreateDate
Sets the create date of this ddm structure layout.- Specified by:
setCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
createDate- the create date of this ddm structure layout
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this ddm structure layout.- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the modified date of this ddm structure layout
-
setModifiedDate
Sets the modified date of this ddm structure layout.- Specified by:
setModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
modifiedDate- the modified date of this ddm structure layout
-
getClassName
String getClassName()Returns the fully qualified class name of this ddm structure layout.- Specified by:
getClassNamein interfacecom.liferay.portal.kernel.model.TypedModel- Returns:
- the fully qualified class name of this ddm structure layout
-
setClassName
-
getClassNameId
long getClassNameId()Returns the class name ID of this ddm structure layout.- Specified by:
getClassNameIdin interfacecom.liferay.portal.kernel.model.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:
setClassNameIdin interfacecom.liferay.portal.kernel.model.TypedModel- Parameters:
classNameId- the class name ID of this ddm structure layout
-
getStructureLayoutKey
String getStructureLayoutKey()Returns the structure layout key of this ddm structure layout.- Returns:
- the structure layout key of this ddm structure layout
-
setStructureLayoutKey
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
String getName()Returns the name of this ddm structure layout.- Returns:
- the name of this ddm structure layout
-
getName
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this ddm structure layout. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getName
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this ddm structure layout
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
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
Sets the name of this ddm structure layout.- Parameters:
name- the name of this ddm structure layout
-
setName
Sets the localized name of this ddm structure layout in the language.- Parameters:
name- the localized name of this ddm structure layoutlocale- the locale of the language
-
setName
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 layoutlocale- the locale of the languagedefaultLocale- the default locale
-
setNameCurrentLanguageId
-
setNameMap
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
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 layoutdefaultLocale- the default locale
-
getDescription
String getDescription()Returns the description of this ddm structure layout.- Returns:
- the description of this ddm structure layout
-
getDescription
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this ddm structure layout. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getDescription
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
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 languageuseDefault- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this ddm structure layout
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
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
Sets the description of this ddm structure layout.- Parameters:
description- the description of this ddm structure layout
-
setDescription
Sets the localized description of this ddm structure layout in the language.- Parameters:
description- the localized description of this ddm structure layoutlocale- the locale of the language
-
setDescription
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 layoutlocale- the locale of the languagedefaultLocale- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
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
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 layoutdefaultLocale- the default locale
-
getDefinition
Returns the definition of this ddm structure layout.- Returns:
- the definition of this ddm structure layout
-
setDefinition
Sets the definition of this ddm structure layout.- Parameters:
definition- the definition of this ddm structure layout
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIdsin interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageIdin interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImportin 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:
prepareLocalizedFieldsForImportin interfacecom.liferay.portal.kernel.model.LocalizedModel- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
DDMStructureLayout cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfacecom.liferay.portal.kernel.model.BaseModel<DDMStructureLayout>
-
toXmlString
-