Interface DDMStructureModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel
,com.liferay.portal.kernel.model.BaseModel<DDMStructure>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<DDMStructure>
,com.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructure>
,com.liferay.portal.kernel.model.ExternalReferenceCodeModel
,com.liferay.portal.kernel.model.GroupedModel
,com.liferay.portal.kernel.model.LocalizedModel
,com.liferay.portal.kernel.model.MVCCModel
,Serializable
,com.liferay.portal.kernel.model.ShardedModel
,com.liferay.portal.kernel.model.StagedGroupedModel
,com.liferay.portal.kernel.model.StagedModel
,com.liferay.portal.kernel.model.TypedModel
- All Known Subinterfaces:
DDMStructure
- All Known Implementing Classes:
DDMStructureWrapper
@ProviderType
public interface DDMStructureModel
extends com.liferay.portal.kernel.model.BaseModel<DDMStructure>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructure>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel, com.liferay.portal.kernel.model.TypedModel
The base model interface for the DDMStructure service. Represents a row in the "DDMStructure" 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.DDMStructureModelImpl
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.DDMStructureImpl
.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]
Returns the fully qualified class name of this ddm structure.long
Returns the class name ID of this ddm structure.long
Returns the company ID of this ddm structure.Returns the create date of this ddm structure.long
Returns the ct collection ID of this ddm structure.Returns the definition of this ddm structure.Returns the description of this ddm structure.getDescription
(String languageId) Returns the localized description of this ddm structure in the language.getDescription
(String languageId, boolean useDefault) Returns the localized description of this ddm structure 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 in the language.getDescription
(Locale locale, boolean useDefault) Returns the localized description of this ddm structure 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.Returns the external reference code of this ddm structure.long
Returns the group ID of this ddm structure.Returns the last publish date of this ddm structure.Returns the modified date of this ddm structure.long
Returns the mvcc version of this ddm structure.getName()
Returns the name of this ddm structure.Returns the localized name of this ddm structure in the language.Returns the localized name of this ddm structure in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this ddm structure in the language.Returns the localized name of this ddm structure 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.long
Returns the parent structure ID of this ddm structure.long
Returns the primary key of this ddm structure.Returns the storage type of this ddm structure.long
Returns the structure ID of this ddm structure.Returns the structure key of this ddm structure.int
getType()
Returns the type of this ddm structure.long
Returns the user ID of this ddm structure.Returns the user name of this ddm structure.Returns the user uuid of this ddm structure.getUuid()
Returns the uuid of this ddm structure.Returns the version of this ddm structure.long
Returns the version user ID of this ddm structure.Returns the version user name of this ddm structure.Returns the version user uuid of this ddm structure.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setClassName
(String className) void
setClassNameId
(long classNameId) Sets the class name ID of this ddm structure.void
setCompanyId
(long companyId) Sets the company ID of this ddm structure.void
setCreateDate
(Date createDate) Sets the create date of this ddm structure.void
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID of this ddm structure.void
setDefinition
(String definition) Sets the definition of this ddm structure.void
setDescription
(String description) Sets the description of this ddm structure.void
setDescription
(String description, Locale locale) Sets the localized description of this ddm structure in the language.void
setDescription
(String description, Locale locale, Locale defaultLocale) Sets the localized description of this ddm structure in the language, and sets the default locale.void
setDescriptionCurrentLanguageId
(String languageId) void
setDescriptionMap
(Map<Locale, String> descriptionMap) Sets the localized descriptions of this ddm structure from the map of locales and localized descriptions.void
setDescriptionMap
(Map<Locale, String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this ddm structure from the map of locales and localized descriptions, and sets the default locale.void
setExternalReferenceCode
(String externalReferenceCode) Sets the external reference code of this ddm structure.void
setGroupId
(long groupId) Sets the group ID of this ddm structure.void
setLastPublishDate
(Date lastPublishDate) Sets the last publish date of this ddm structure.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this ddm structure.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this ddm structure.void
Sets the name of this ddm structure.void
Sets the localized name of this ddm structure in the language.void
Sets the localized name of this ddm structure in the language, and sets the default locale.void
setNameCurrentLanguageId
(String languageId) void
setNameMap
(Map<Locale, String> nameMap) Sets the localized names of this ddm structure from the map of locales and localized names.void
setNameMap
(Map<Locale, String> nameMap, Locale defaultLocale) Sets the localized names of this ddm structure from the map of locales and localized names, and sets the default locale.void
setParentStructureId
(long parentStructureId) Sets the parent structure ID of this ddm structure.void
setPrimaryKey
(long primaryKey) Sets the primary key of this ddm structure.void
setStorageType
(String storageType) Sets the storage type of this ddm structure.void
setStructureId
(long structureId) Sets the structure ID of this ddm structure.void
setStructureKey
(String structureKey) Sets the structure key of this ddm structure.void
setType
(int type) Sets the type of this ddm structure.void
setUserId
(long userId) Sets the user ID of this ddm structure.void
setUserName
(String userName) Sets the user name of this ddm structure.void
setUserUuid
(String userUuid) Sets the user uuid of this ddm structure.void
Sets the uuid of this ddm structure.void
setVersion
(String version) Sets the version of this ddm structure.void
setVersionUserId
(long versionUserId) Sets the version user ID of this ddm structure.void
setVersionUserName
(String versionUserName) Sets the version user name of this ddm structure.void
setVersionUserUuid
(String versionUserUuid) Sets the version user uuid of this ddm structure.default String
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this ddm structure.- Specified by:
getPrimaryKey
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructure>
- Returns:
- the primary key of this ddm structure
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this ddm structure.- Specified by:
setPrimaryKey
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructure>
- Parameters:
primaryKey
- the primary key of this ddm structure
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this ddm structure.- Specified by:
getMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Returns:
- the mvcc version of this ddm structure
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this ddm structure.- Specified by:
setMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this ddm structure
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this ddm structure.- Specified by:
getCtCollectionId
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructure>
- Returns:
- the ct collection ID of this ddm structure
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this ddm structure.- Specified by:
setCtCollectionId
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructure>
- Parameters:
ctCollectionId
- the ct collection ID of this ddm structure
-
getUuid
Returns the uuid of this ddm structure.- Specified by:
getUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the uuid of this ddm structure
-
setUuid
Sets the uuid of this ddm structure.- Specified by:
setUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
uuid
- the uuid of this ddm structure
-
getExternalReferenceCode
Returns the external reference code of this ddm structure.- Specified by:
getExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- Returns:
- the external reference code of this ddm structure
-
setExternalReferenceCode
Sets the external reference code of this ddm structure.- Specified by:
setExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- Parameters:
externalReferenceCode
- the external reference code of this ddm structure
-
getStructureId
long getStructureId()Returns the structure ID of this ddm structure.- Returns:
- the structure ID of this ddm structure
-
setStructureId
void setStructureId(long structureId) Sets the structure ID of this ddm structure.- Parameters:
structureId
- the structure ID of this ddm structure
-
getGroupId
long getGroupId()Returns the group ID of this ddm structure.- Specified by:
getGroupId
in interfacecom.liferay.portal.kernel.model.GroupedModel
- Returns:
- the group ID of this ddm structure
-
setGroupId
void setGroupId(long groupId) Sets the group ID of this ddm structure.- Specified by:
setGroupId
in interfacecom.liferay.portal.kernel.model.GroupedModel
- Parameters:
groupId
- the group ID of this ddm structure
-
getCompanyId
long getCompanyId()Returns the company ID of this ddm structure.- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the company ID of this ddm structure
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this ddm structure.- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
companyId
- the company ID of this ddm structure
-
getUserId
long getUserId()Returns the user ID of this ddm structure.- Specified by:
getUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user ID of this ddm structure
-
setUserId
void setUserId(long userId) Sets the user ID of this ddm structure.- Specified by:
setUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userId
- the user ID of this ddm structure
-
getUserUuid
String getUserUuid()Returns the user uuid of this ddm structure.- Specified by:
getUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user uuid of this ddm structure
-
setUserUuid
Sets the user uuid of this ddm structure.- Specified by:
setUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userUuid
- the user uuid of this ddm structure
-
getUserName
Returns the user name of this ddm structure.- Specified by:
getUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user name of this ddm structure
-
setUserName
Sets the user name of this ddm structure.- Specified by:
setUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userName
- the user name of this ddm structure
-
getVersionUserId
long getVersionUserId()Returns the version user ID of this ddm structure.- Returns:
- the version user ID of this ddm structure
-
setVersionUserId
void setVersionUserId(long versionUserId) Sets the version user ID of this ddm structure.- Parameters:
versionUserId
- the version user ID of this ddm structure
-
getVersionUserUuid
String getVersionUserUuid()Returns the version user uuid of this ddm structure.- Returns:
- the version user uuid of this ddm structure
-
setVersionUserUuid
Sets the version user uuid of this ddm structure.- Parameters:
versionUserUuid
- the version user uuid of this ddm structure
-
getVersionUserName
Returns the version user name of this ddm structure.- Returns:
- the version user name of this ddm structure
-
setVersionUserName
Sets the version user name of this ddm structure.- Parameters:
versionUserName
- the version user name of this ddm structure
-
getCreateDate
Date getCreateDate()Returns the create date of this ddm structure.- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the create date of this ddm structure
-
setCreateDate
Sets the create date of this ddm structure.- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
createDate
- the create date of this ddm structure
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this ddm structure.- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the modified date of this ddm structure
-
setModifiedDate
Sets the modified date of this ddm structure.- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
modifiedDate
- the modified date of this ddm structure
-
getParentStructureId
long getParentStructureId()Returns the parent structure ID of this ddm structure.- Returns:
- the parent structure ID of this ddm structure
-
setParentStructureId
void setParentStructureId(long parentStructureId) Sets the parent structure ID of this ddm structure.- Parameters:
parentStructureId
- the parent structure ID of this ddm structure
-
getClassName
String getClassName()Returns the fully qualified class name of this ddm structure.- Specified by:
getClassName
in interfacecom.liferay.portal.kernel.model.TypedModel
- Returns:
- the fully qualified class name of this ddm structure
-
setClassName
-
getClassNameId
long getClassNameId()Returns the class name ID of this ddm structure.- Specified by:
getClassNameId
in interfacecom.liferay.portal.kernel.model.TypedModel
- Returns:
- the class name ID of this ddm structure
-
setClassNameId
void setClassNameId(long classNameId) Sets the class name ID of this ddm structure.- Specified by:
setClassNameId
in interfacecom.liferay.portal.kernel.model.TypedModel
- Parameters:
classNameId
- the class name ID of this ddm structure
-
getStructureKey
String getStructureKey()Returns the structure key of this ddm structure.- Returns:
- the structure key of this ddm structure
-
setStructureKey
Sets the structure key of this ddm structure.- Parameters:
structureKey
- the structure key of this ddm structure
-
getVersion
Returns the version of this ddm structure.- Returns:
- the version of this ddm structure
-
setVersion
Sets the version of this ddm structure.- Parameters:
version
- the version of this ddm structure
-
getName
String getName()Returns the name of this ddm structure.- Returns:
- the name of this ddm structure
-
getName
Returns the localized name of this ddm structure 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
-
getName
Returns the localized name of this ddm structure 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. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getName
Returns the localized name of this ddm structure 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
-
getName
Returns the localized name of this ddm structure 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
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this ddm structure.- Returns:
- the locales and localized names of this ddm structure
-
setName
Sets the name of this ddm structure.- Parameters:
name
- the name of this ddm structure
-
setName
Sets the localized name of this ddm structure in the language.- Parameters:
name
- the localized name of this ddm structurelocale
- the locale of the language
-
setName
Sets the localized name of this ddm structure in the language, and sets the default locale.- Parameters:
name
- the localized name of this ddm structurelocale
- the locale of the languagedefaultLocale
- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this ddm structure from the map of locales and localized names.- Parameters:
nameMap
- the locales and localized names of this ddm structure
-
setNameMap
Sets the localized names of this ddm structure from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap
- the locales and localized names of this ddm structuredefaultLocale
- the default locale
-
getDescription
String getDescription()Returns the description of this ddm structure.- Returns:
- the description of this ddm structure
-
getDescription
Returns the localized description of this ddm structure 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
-
getDescription
Returns the localized description of this ddm structure 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. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getDescription
Returns the localized description of this ddm structure 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
-
getDescription
Returns the localized description of this ddm structure 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
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this ddm structure.- Returns:
- the locales and localized descriptions of this ddm structure
-
setDescription
Sets the description of this ddm structure.- Parameters:
description
- the description of this ddm structure
-
setDescription
Sets the localized description of this ddm structure in the language.- Parameters:
description
- the localized description of this ddm structurelocale
- the locale of the language
-
setDescription
Sets the localized description of this ddm structure in the language, and sets the default locale.- Parameters:
description
- the localized description of this ddm structurelocale
- the locale of the languagedefaultLocale
- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this ddm structure from the map of locales and localized descriptions.- Parameters:
descriptionMap
- the locales and localized descriptions of this ddm structure
-
setDescriptionMap
Sets the localized descriptions of this ddm structure from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap
- the locales and localized descriptions of this ddm structuredefaultLocale
- the default locale
-
getDefinition
Returns the definition of this ddm structure.- Returns:
- the definition of this ddm structure
-
setDefinition
Sets the definition of this ddm structure.- Parameters:
definition
- the definition of this ddm structure
-
getStorageType
Returns the storage type of this ddm structure.- Returns:
- the storage type of this ddm structure
-
setStorageType
Sets the storage type of this ddm structure.- Parameters:
storageType
- the storage type of this ddm structure
-
getType
int getType()Returns the type of this ddm structure.- Returns:
- the type of this ddm structure
-
setType
void setType(int type) Sets the type of this ddm structure.- Parameters:
type
- the type of this ddm structure
-
getLastPublishDate
Date getLastPublishDate()Returns the last publish date of this ddm structure.- Specified by:
getLastPublishDate
in interfacecom.liferay.portal.kernel.model.StagedGroupedModel
- Returns:
- the last publish date of this ddm structure
-
setLastPublishDate
Sets the last publish date of this ddm structure.- Specified by:
setLastPublishDate
in interfacecom.liferay.portal.kernel.model.StagedGroupedModel
- Parameters:
lastPublishDate
- the last publish date of this ddm structure
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIds
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageId
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException - Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
DDMStructure cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<DDMStructure>
-
toXmlString
-