com.liferay.dynamic.data.mapping.model

Class DDMStructureWrapper

java.lang.Object

com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<DDMStructure>

com.liferay.dynamic.data.mapping.model.DDMStructureWrapper

All Implemented Interfaces:

DDMStructure, DDMStructureModel, AuditedModel, BaseModel<DDMStructure>, CTModel<DDMStructure>, ClassedModel, GroupedModel, LocalizedModel, ModelWrapper<DDMStructure>, MVCCModel, PersistedModel, ShardedModel, StagedGroupedModel, StagedModel, TypedModel, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<DDMStructure>

public class DDMStructureWrapper
extends BaseModelWrapper<DDMStructure>
implements DDMStructure, ModelWrapper<DDMStructure>

This class is a wrapper for DDMStructure.

See Also:

DDMStructure, Serialized Form

Field Summary

Fields inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper

model

Fields inherited from interface com.liferay.dynamic.data.mapping.model.DDMStructure

STRUCTURE_ID_ACCESSOR

Constructor Summary

Constructors

Constructor and Description
DDMStructureWrapper(DDMStructure ddmStructure)

Method Summary

Modifier and Type	Method and Description
DDMForm	createFullHierarchyDDMForm()
DDMStructureLayout	fetchDDMStructureLayout()
java.util.Map<java.lang.String,java.util.function.Function<DDMStructure,java.lang.Object>>	getAttributeGetterFunctions()
java.util.Map<java.lang.String,java.util.function.BiConsumer<DDMStructure,java.lang.Object>>	getAttributeSetterBiConsumers()
java.lang.String[]	getAvailableLanguageIds()
java.util.List<java.lang.String>	getChildrenFieldNames(java.lang.String fieldName)
java.lang.String	getClassName() Returns the fully qualified class name of this ddm structure.
long	getClassNameId() Returns the class name ID of this ddm structure.
long	getCompanyId() Returns the company ID of this ddm structure.
java.util.Date	getCreateDate() Returns the create date of this ddm structure.
long	getCtCollectionId() Returns the ct collection ID of this ddm structure.
DDMForm	getDDMForm()
DDMFormField	getDDMFormField(java.lang.String fieldName)
java.util.List<DDMFormField>	getDDMFormFields(boolean includeTransientFields)
DDMFormLayout	getDDMFormLayout()
long	getDefaultDDMStructureLayoutId()
java.lang.String	getDefaultLanguageId()
java.lang.String	getDefinition() Returns the definition of this ddm structure.
java.lang.String	getDescription() Returns the description of this ddm structure.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this ddm structure in the language.
java.lang.String	getDescription(java.util.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.
java.lang.String	getDescription(java.lang.String languageId) Returns the localized description of this ddm structure in the language.
java.lang.String	getDescription(java.lang.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.
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.
java.lang.String	getFieldDataType(java.lang.String fieldName)
java.lang.String	getFieldLabel(java.lang.String fieldName, java.util.Locale locale)
java.lang.String	getFieldLabel(java.lang.String fieldName, java.lang.String locale)
java.util.Set<java.lang.String>	getFieldNames()
java.lang.String	getFieldProperty(java.lang.String fieldName, java.lang.String property)
boolean	getFieldRepeatable(java.lang.String fieldName)
boolean	getFieldRequired(java.lang.String fieldName)
java.lang.String	getFieldTip(java.lang.String fieldName, java.util.Locale locale)
java.lang.String	getFieldTip(java.lang.String fieldName, java.lang.String locale)
java.lang.String	getFieldType(java.lang.String fieldName)
DDMForm	getFullHierarchyDDMForm()
java.util.Map<java.lang.String,DDMFormField>	getFullHierarchyDDMFormFieldsMap(boolean includeNestedDDMFormFields)
long	getGroupId() Returns the group ID of this ddm structure.
java.util.Date	getLastPublishDate() Returns the last publish date of this ddm structure.
DDMStructureVersion	getLatestStructureVersion()
java.util.Map<java.lang.String,java.lang.Object>	getModelAttributes()
java.util.Date	getModifiedDate() Returns the modified date of this ddm structure.
long	getMvccVersion() Returns the mvcc version of this ddm structure.
java.lang.String	getName() Returns the name of this ddm structure.
java.lang.String	getName(java.util.Locale locale) Returns the localized name of this ddm structure in the language.
java.lang.String	getName(java.util.Locale locale, boolean useDefault) Returns the localized name of this ddm structure 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 in the language.
java.lang.String	getName(java.lang.String languageId, boolean useDefault) Returns the localized name of this ddm structure 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.
long	getParentStructureId() Returns the parent structure ID of this ddm structure.
long	getPrimaryKey() Returns the primary key of this ddm structure.
java.util.List<java.lang.String>	getRootFieldNames()
StagedModelType	getStagedModelType()
java.lang.String	getStorageType() Returns the storage type of this ddm structure.
long	getStructureId() Returns the structure ID of this ddm structure.
java.lang.String	getStructureKey() Returns the structure key of this ddm structure.
DDMStructureVersion	getStructureVersion()
java.util.List<DDMTemplate>	getTemplates()
int	getType() Returns the type of this ddm structure.
java.lang.String	getUnambiguousName(java.util.List<DDMStructure> structures, long groupId, java.util.Locale locale)
long	getUserId() Returns the user ID of this ddm structure.
java.lang.String	getUserName() Returns the user name of this ddm structure.
java.lang.String	getUserUuid() Returns the user uuid of this ddm structure.
java.lang.String	getUuid() Returns the uuid of this ddm structure.
java.lang.String	getVersion() Returns the version of this ddm structure.
long	getVersionUserId() Returns the version user ID of this ddm structure.
java.lang.String	getVersionUserName() Returns the version user name of this ddm structure.
java.lang.String	getVersionUserUuid() Returns the version user uuid of this ddm structure.
java.lang.String	getWebDavURL(ThemeDisplay themeDisplay, java.lang.String webDAVToken) Returns the WebDAV URL to access the structure.
boolean	hasField(java.lang.String fieldName)
boolean	isFieldRepeatable(java.lang.String fieldName)
boolean	isFieldTransient(java.lang.String fieldName)
void	persist() Updates this model instance in the database or adds it if it does not yet exist.
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.
void	setCompanyId(long companyId) Sets the company ID of this ddm structure.
void	setCreateDate(java.util.Date createDate) Sets the create date of this ddm structure.
void	setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this ddm structure.
void	setDDMForm(DDMForm ddmForm)
void	setDefinition(java.lang.String definition) Sets the definition of this ddm structure.
void	setDescription(java.lang.String description) Sets the description of this ddm structure.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this ddm structure 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 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 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 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.
void	setLastPublishDate(java.util.Date lastPublishDate) Sets the last publish date of this ddm structure.
void	setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
void	setModifiedDate(java.util.Date modifiedDate) Sets the modified date of this ddm structure.
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this ddm structure.
void	setName(java.lang.String name) Sets the name of this ddm structure.
void	setName(java.lang.String name, java.util.Locale locale) Sets the localized name of this ddm structure 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 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 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 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(java.lang.String storageType) Sets the storage type of this ddm structure.
void	setStructureId(long structureId) Sets the structure ID of this ddm structure.
void	setStructureKey(java.lang.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(java.lang.String userName) Sets the user name of this ddm structure.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this ddm structure.
void	setUuid(java.lang.String uuid) Sets the uuid of this ddm structure.
void	setVersion(java.lang.String version) Sets the version of this ddm structure.
void	setVersionUserId(long versionUserId) Sets the version user ID of this ddm structure.
void	setVersionUserName(java.lang.String versionUserName) Sets the version user name of this ddm structure.
void	setVersionUserUuid(java.lang.String versionUserUuid) Sets the version user uuid of this ddm structure.
protected DDMStructureWrapper	wrap(DDMStructure ddmStructure)

Methods inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper

clone, compareTo, equals, getExpandoBridge, getModelClass, getModelClassName, getPrimaryKeyObj, getWrappedModel, hashCode, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

clone, getExpandoBridge, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, 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

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

getWrappedModel

Constructor Detail

DDMStructureWrapper

public DDMStructureWrapper(DDMStructure ddmStructure)

Method Detail

getModelAttributes

public java.util.Map<java.lang.String,java.lang.Object> getModelAttributes()

Specified by:

getModelAttributes in interface BaseModel<DDMStructure>

setModelAttributes

public void setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

setModelAttributes in interface BaseModel<DDMStructure>

createFullHierarchyDDMForm

public DDMForm createFullHierarchyDDMForm()
                                   throws PortalException

Specified by:

createFullHierarchyDDMForm in interface DDMStructure

Throws:

PortalException

fetchDDMStructureLayout

public DDMStructureLayout fetchDDMStructureLayout()

Specified by:

fetchDDMStructureLayout in interface DDMStructure

getAvailableLanguageIds

public java.lang.String[] getAvailableLanguageIds()

Specified by:

getAvailableLanguageIds in interface DDMStructureModel

Specified by:

getAvailableLanguageIds in interface LocalizedModel

getChildrenFieldNames

public java.util.List<java.lang.String> getChildrenFieldNames(java.lang.String fieldName)
                                                       throws PortalException

Specified by:

getChildrenFieldNames in interface DDMStructure

Throws:

PortalException

getClassName

public java.lang.String getClassName()

Returns the fully qualified class name of this ddm structure.

Specified by:

getClassName in interface DDMStructureModel

Specified by:

getClassName in interface TypedModel

Returns:

the fully qualified class name of this ddm structure

getClassNameId

public long getClassNameId()

Returns the class name ID of this ddm structure.

Specified by:

getClassNameId in interface DDMStructureModel

Specified by:

getClassNameId in interface TypedModel

Returns:

the class name ID of this ddm structure

getCompanyId

public long getCompanyId()

Returns the company ID of this ddm structure.

Specified by:

getCompanyId in interface DDMStructureModel

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

getCreateDate

public java.util.Date getCreateDate()

Returns the create date of this ddm structure.

Specified by:

getCreateDate in interface DDMStructureModel

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this ddm structure

getCtCollectionId

public long getCtCollectionId()

Returns the ct collection ID of this ddm structure.

Specified by:

getCtCollectionId in interface DDMStructureModel

Specified by:

getCtCollectionId in interface CTModel<DDMStructure>

Returns:

the ct collection ID of this ddm structure

getDDMForm

public DDMForm getDDMForm()

Specified by:

getDDMForm in interface DDMStructure

getDDMFormField

public DDMFormField getDDMFormField(java.lang.String fieldName)
                             throws PortalException

Specified by:

getDDMFormField in interface DDMStructure

Throws:

PortalException

getDDMFormFields

public java.util.List<DDMFormField> getDDMFormFields(boolean includeTransientFields)

Specified by:

getDDMFormFields in interface DDMStructure

getDDMFormLayout

public DDMFormLayout getDDMFormLayout()
                               throws PortalException

Specified by:

getDDMFormLayout in interface DDMStructure

Throws:

PortalException

getDefaultDDMStructureLayoutId

public long getDefaultDDMStructureLayoutId()

Specified by:

getDefaultDDMStructureLayoutId in interface DDMStructure

getDefaultLanguageId

public java.lang.String getDefaultLanguageId()

Specified by:

getDefaultLanguageId in interface DDMStructureModel

Specified by:

getDefaultLanguageId in interface LocalizedModel

getDefinition

public java.lang.String getDefinition()

Returns the definition of this ddm structure.

Specified by:

getDefinition in interface DDMStructureModel

Returns:

the definition of this ddm structure

getDescription

public java.lang.String getDescription()

Returns the description of this ddm structure.

Specified by:

getDescription in interface DDMStructureModel

Returns:

the description of this ddm structure

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Returns the localized description of this ddm structure in the language. Uses the default language if no localization exists for the requested language.

Specified by:

getDescription in interface DDMStructureModel

Parameters:

locale - the locale of the language

Returns:

the localized description of this ddm structure

getDescription

public java.lang.String getDescription(java.util.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.

Specified by:

getDescription in interface DDMStructureModel

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

getDescription

public java.lang.String getDescription(java.lang.String languageId)

Returns the localized description of this ddm structure in the language. Uses the default language if no localization exists for the requested language.

Specified by:

getDescription in interface DDMStructureModel

Parameters:

languageId - the ID of the language

Returns:

the localized description of this ddm structure

getDescription

public java.lang.String getDescription(java.lang.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.

Specified by:

getDescription in interface DDMStructureModel

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

getDescriptionCurrentLanguageId

public java.lang.String getDescriptionCurrentLanguageId()

Specified by:

getDescriptionCurrentLanguageId in interface DDMStructureModel

getDescriptionCurrentValue

public java.lang.String getDescriptionCurrentValue()

Specified by:

getDescriptionCurrentValue in interface DDMStructureModel

getDescriptionMap

public java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()

Returns a map of the locales and localized descriptions of this ddm structure.

Specified by:

getDescriptionMap in interface DDMStructureModel

Returns:

the locales and localized descriptions of this ddm structure

getFieldDataType

public java.lang.String getFieldDataType(java.lang.String fieldName)
                                  throws PortalException

Specified by:

getFieldDataType in interface DDMStructure

Throws:

PortalException

getFieldLabel

public java.lang.String getFieldLabel(java.lang.String fieldName,
                                      java.util.Locale locale)
                               throws PortalException

Specified by:

getFieldLabel in interface DDMStructure

Throws:

PortalException

getFieldLabel

public java.lang.String getFieldLabel(java.lang.String fieldName,
                                      java.lang.String locale)
                               throws PortalException

Specified by:

getFieldLabel in interface DDMStructure

Throws:

PortalException

getFieldNames

public java.util.Set<java.lang.String> getFieldNames()

Specified by:

getFieldNames in interface DDMStructure

getFieldProperty

public java.lang.String getFieldProperty(java.lang.String fieldName,
                                         java.lang.String property)
                                  throws PortalException

Specified by:

getFieldProperty in interface DDMStructure

Throws:

PortalException

getFieldRepeatable

public boolean getFieldRepeatable(java.lang.String fieldName)
                           throws PortalException

Specified by:

getFieldRepeatable in interface DDMStructure

Throws:

PortalException

getFieldRequired

public boolean getFieldRequired(java.lang.String fieldName)
                         throws PortalException

Specified by:

getFieldRequired in interface DDMStructure

Throws:

PortalException

getFieldTip

public java.lang.String getFieldTip(java.lang.String fieldName,
                                    java.util.Locale locale)
                             throws PortalException

Specified by:

getFieldTip in interface DDMStructure

Throws:

PortalException

getFieldTip

public java.lang.String getFieldTip(java.lang.String fieldName,
                                    java.lang.String locale)
                             throws PortalException

Specified by:

getFieldTip in interface DDMStructure

Throws:

PortalException

getFieldType

public java.lang.String getFieldType(java.lang.String fieldName)
                              throws PortalException

Specified by:

getFieldType in interface DDMStructure

Throws:

PortalException

getFullHierarchyDDMForm

public DDMForm getFullHierarchyDDMForm()

Specified by:

getFullHierarchyDDMForm in interface DDMStructure

getFullHierarchyDDMFormFieldsMap

public java.util.Map<java.lang.String,DDMFormField> getFullHierarchyDDMFormFieldsMap(boolean includeNestedDDMFormFields)

Specified by:

getFullHierarchyDDMFormFieldsMap in interface DDMStructure

getGroupId

public long getGroupId()

Returns the group ID of this ddm structure.

Specified by:

getGroupId in interface DDMStructureModel

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this ddm structure

getLastPublishDate

public java.util.Date getLastPublishDate()

Returns the last publish date of this ddm structure.

Specified by:

getLastPublishDate in interface DDMStructureModel

Specified by:

getLastPublishDate in interface StagedGroupedModel

Returns:

the last publish date of this ddm structure

getLatestStructureVersion

public DDMStructureVersion getLatestStructureVersion()
                                              throws PortalException

Specified by:

getLatestStructureVersion in interface DDMStructure

Throws:

PortalException

getModifiedDate

public java.util.Date getModifiedDate()

Returns the modified date of this ddm structure.

Specified by:

getModifiedDate in interface DDMStructureModel

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this ddm structure

getMvccVersion

public long getMvccVersion()

Returns the mvcc version of this ddm structure.

Specified by:

getMvccVersion in interface DDMStructureModel

Specified by:

getMvccVersion in interface MVCCModel

Returns:

the mvcc version of this ddm structure

getName

public java.lang.String getName()

Returns the name of this ddm structure.

Specified by:

getName in interface DDMStructureModel

Returns:

the name of this ddm structure

getName

public java.lang.String getName(java.util.Locale locale)

Returns the localized name of this ddm structure in the language. Uses the default language if no localization exists for the requested language.

Specified by:

getName in interface DDMStructureModel

Parameters:

locale - the locale of the language

Returns:

the localized name of this ddm structure

getName

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

Returns the localized name of this ddm structure in the language, optionally using the default language if no localization exists for the requested language.

Specified by:

getName in interface DDMStructureModel

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

getName

public java.lang.String getName(java.lang.String languageId)

Returns the localized name of this ddm structure in the language. Uses the default language if no localization exists for the requested language.

Specified by:

getName in interface DDMStructureModel

Parameters:

languageId - the ID of the language

Returns:

the localized name of this ddm structure

getName

public java.lang.String getName(java.lang.String languageId,
                                boolean useDefault)

Returns the localized name of this ddm structure in the language, optionally using the default language if no localization exists for the requested language.

Specified by:

getName in interface DDMStructureModel

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

getNameCurrentLanguageId

public java.lang.String getNameCurrentLanguageId()

Specified by:

getNameCurrentLanguageId in interface DDMStructureModel

getNameCurrentValue

public java.lang.String getNameCurrentValue()

Specified by:

getNameCurrentValue in interface DDMStructureModel

getNameMap

public java.util.Map<java.util.Locale,java.lang.String> getNameMap()

Returns a map of the locales and localized names of this ddm structure.

Specified by:

getNameMap in interface DDMStructureModel

Returns:

the locales and localized names of this ddm structure

getParentStructureId

public long getParentStructureId()

Returns the parent structure ID of this ddm structure.

Specified by:

getParentStructureId in interface DDMStructureModel

Returns:

the parent structure ID of this ddm structure

getPrimaryKey

public long getPrimaryKey()

Returns the primary key of this ddm structure.

Specified by:

getPrimaryKey in interface DDMStructureModel

Specified by:

getPrimaryKey in interface CTModel<DDMStructure>

Returns:

the primary key of this ddm structure

getRootFieldNames

public java.util.List<java.lang.String> getRootFieldNames()

Specified by:

getRootFieldNames in interface DDMStructure

getStorageType

public java.lang.String getStorageType()

Returns the storage type of this ddm structure.

Specified by:

getStorageType in interface DDMStructureModel

Returns:

the storage type of this ddm structure

getStructureId

public long getStructureId()

Returns the structure ID of this ddm structure.

Specified by:

getStructureId in interface DDMStructureModel

Returns:

the structure ID of this ddm structure

getStructureKey

public java.lang.String getStructureKey()

Returns the structure key of this ddm structure.

Specified by:

getStructureKey in interface DDMStructureModel

Returns:

the structure key of this ddm structure

getStructureVersion

public DDMStructureVersion getStructureVersion()
                                        throws PortalException

Specified by:

getStructureVersion in interface DDMStructure

Throws:

PortalException

getTemplates

public java.util.List<DDMTemplate> getTemplates()

Specified by:

getTemplates in interface DDMStructure

getType

public int getType()

Returns the type of this ddm structure.

Specified by:

getType in interface DDMStructureModel

Returns:

the type of this ddm structure

getUnambiguousName

public java.lang.String getUnambiguousName(java.util.List<DDMStructure> structures,
                                           long groupId,
                                           java.util.Locale locale)
                                    throws PortalException

Specified by:

getUnambiguousName in interface DDMStructure

Throws:

PortalException

getUserId

public long getUserId()

Returns the user ID of this ddm structure.

Specified by:

getUserId in interface DDMStructureModel

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this ddm structure

getUserName

public java.lang.String getUserName()

Returns the user name of this ddm structure.

Specified by:

getUserName in interface DDMStructureModel

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this ddm structure

getUserUuid

public java.lang.String getUserUuid()

Returns the user uuid of this ddm structure.

Specified by:

getUserUuid in interface DDMStructureModel

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this ddm structure

getUuid

public java.lang.String getUuid()

Returns the uuid of this ddm structure.

Specified by:

getUuid in interface DDMStructureModel

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this ddm structure

getVersion

public java.lang.String getVersion()

Returns the version of this ddm structure.

Specified by:

getVersion in interface DDMStructureModel

Returns:

the version of this ddm structure

getVersionUserId

public long getVersionUserId()

Returns the version user ID of this ddm structure.

Specified by:

getVersionUserId in interface DDMStructureModel

Returns:

the version user ID of this ddm structure

getVersionUserName

public java.lang.String getVersionUserName()

Returns the version user name of this ddm structure.

Specified by:

getVersionUserName in interface DDMStructureModel

Returns:

the version user name of this ddm structure

getVersionUserUuid

public java.lang.String getVersionUserUuid()

Returns the version user uuid of this ddm structure.

Specified by:

getVersionUserUuid in interface DDMStructureModel

Returns:

the version user uuid of this ddm structure

getWebDavURL

public java.lang.String getWebDavURL(ThemeDisplay themeDisplay,
                                     java.lang.String webDAVToken)

Returns the WebDAV URL to access the structure.

Specified by:

getWebDavURL in interface DDMStructure

Parameters:

themeDisplay - the theme display needed to build the URL. It can set HTTPS access, the server name, the server port, the path context, and the scope group.

webDAVToken - the WebDAV token for the URL

Returns:

the WebDAV URL

hasField

public boolean hasField(java.lang.String fieldName)

Specified by:

hasField in interface DDMStructure

isFieldRepeatable

public boolean isFieldRepeatable(java.lang.String fieldName)
                          throws PortalException

Specified by:

isFieldRepeatable in interface DDMStructure

Throws:

PortalException

isFieldTransient

public boolean isFieldTransient(java.lang.String fieldName)
                         throws PortalException

Specified by:

isFieldTransient in interface DDMStructure

Throws:

PortalException

persist

public void persist()

Description copied from interface: PersistedModel

Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:

persist in interface PersistedModel

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport()
                                     throws LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface DDMStructureModel

Specified by:

prepareLocalizedFieldsForImport in interface LocalizedModel

Throws:

LocaleException

prepareLocalizedFieldsForImport

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

Specified by:

prepareLocalizedFieldsForImport in interface DDMStructureModel

Specified by:

prepareLocalizedFieldsForImport in interface LocalizedModel

Throws:

LocaleException

setClassName

public void setClassName(java.lang.String className)

Specified by:

setClassName in interface DDMStructureModel

setClassNameId

public void setClassNameId(long classNameId)

Sets the class name ID of this ddm structure.

Specified by:

setClassNameId in interface DDMStructureModel

Specified by:

setClassNameId in interface TypedModel

Parameters:

classNameId - the class name ID of this ddm structure

setCompanyId

public void setCompanyId(long companyId)

Sets the company ID of this ddm structure.

Specified by:

setCompanyId in interface DDMStructureModel

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

setCreateDate

public void setCreateDate(java.util.Date createDate)

Sets the create date of this ddm structure.

Specified by:

setCreateDate in interface DDMStructureModel

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this ddm structure

setCtCollectionId

public void setCtCollectionId(long ctCollectionId)

Sets the ct collection ID of this ddm structure.

Specified by:

setCtCollectionId in interface DDMStructureModel

Specified by:

setCtCollectionId in interface CTModel<DDMStructure>

Parameters:

ctCollectionId - the ct collection ID of this ddm structure

setDDMForm

public void setDDMForm(DDMForm ddmForm)

Specified by:

setDDMForm in interface DDMStructure

setDefinition

public void setDefinition(java.lang.String definition)

Sets the definition of this ddm structure.

Specified by:

setDefinition in interface DDMStructureModel

Parameters:

definition - the definition of this ddm structure

setDescription

public void setDescription(java.lang.String description)

Sets the description of this ddm structure.

Specified by:

setDescription in interface DDMStructureModel

Parameters:

description - the description of this ddm structure

setDescription

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

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

Specified by:

setDescription in interface DDMStructureModel

Parameters:

description - the localized description of this ddm structure

locale - the locale of the language

setDescription

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

Sets the localized description of this ddm structure in the language, and sets the default locale.

Specified by:

setDescription in interface DDMStructureModel

Parameters:

description - the localized description of this ddm structure

locale - the locale of the language

defaultLocale - the default locale

setDescriptionCurrentLanguageId

public void setDescriptionCurrentLanguageId(java.lang.String languageId)

Specified by:

setDescriptionCurrentLanguageId in interface DDMStructureModel

setDescriptionMap

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

Sets the localized descriptions of this ddm structure from the map of locales and localized descriptions.

Specified by:

setDescriptionMap in interface DDMStructureModel

Parameters:

descriptionMap - the locales and localized descriptions of this ddm structure

setDescriptionMap

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

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

Specified by:

setDescriptionMap in interface DDMStructureModel

Parameters:

descriptionMap - the locales and localized descriptions of this ddm structure

defaultLocale - the default locale

setGroupId

public void setGroupId(long groupId)

Sets the group ID of this ddm structure.

Specified by:

setGroupId in interface DDMStructureModel

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this ddm structure

setLastPublishDate

public void setLastPublishDate(java.util.Date lastPublishDate)

Sets the last publish date of this ddm structure.

Specified by:

setLastPublishDate in interface DDMStructureModel

Specified by:

setLastPublishDate in interface StagedGroupedModel

Parameters:

lastPublishDate - the last publish date of this ddm structure

setModifiedDate

public void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this ddm structure.

Specified by:

setModifiedDate in interface DDMStructureModel

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Parameters:

modifiedDate - the modified date of this ddm structure

setMvccVersion

public void setMvccVersion(long mvccVersion)

Sets the mvcc version of this ddm structure.

Specified by:

setMvccVersion in interface DDMStructureModel

Specified by:

setMvccVersion in interface MVCCModel

Parameters:

mvccVersion - the mvcc version of this ddm structure

setName

public void setName(java.lang.String name)

Sets the name of this ddm structure.

Specified by:

setName in interface DDMStructureModel

Parameters:

name - the name of this ddm structure

setName

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

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

Specified by:

setName in interface DDMStructureModel

Parameters:

name - the localized name of this ddm structure

locale - the locale of the language

setName

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

Sets the localized name of this ddm structure in the language, and sets the default locale.

Specified by:

setName in interface DDMStructureModel

Parameters:

name - the localized name of this ddm structure

locale - the locale of the language

defaultLocale - the default locale

setNameCurrentLanguageId

public void setNameCurrentLanguageId(java.lang.String languageId)

Specified by:

setNameCurrentLanguageId in interface DDMStructureModel

setNameMap

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

Sets the localized names of this ddm structure from the map of locales and localized names.

Specified by:

setNameMap in interface DDMStructureModel

Parameters:

nameMap - the locales and localized names of this ddm structure

setNameMap

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

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

Specified by:

setNameMap in interface DDMStructureModel

Parameters:

nameMap - the locales and localized names of this ddm structure

defaultLocale - the default locale

setParentStructureId

public void setParentStructureId(long parentStructureId)

Sets the parent structure ID of this ddm structure.

Specified by:

setParentStructureId in interface DDMStructureModel

Parameters:

parentStructureId - the parent structure ID of this ddm structure

setPrimaryKey

public void setPrimaryKey(long primaryKey)

Sets the primary key of this ddm structure.

Specified by:

setPrimaryKey in interface DDMStructureModel

Specified by:

setPrimaryKey in interface CTModel<DDMStructure>

Parameters:

primaryKey - the primary key of this ddm structure

setStorageType

public void setStorageType(java.lang.String storageType)

Sets the storage type of this ddm structure.

Specified by:

setStorageType in interface DDMStructureModel

Parameters:

storageType - the storage type of this ddm structure

setStructureId

public void setStructureId(long structureId)

Sets the structure ID of this ddm structure.

Specified by:

setStructureId in interface DDMStructureModel

Parameters:

structureId - the structure ID of this ddm structure

setStructureKey

public void setStructureKey(java.lang.String structureKey)

Sets the structure key of this ddm structure.

Specified by:

setStructureKey in interface DDMStructureModel

Parameters:

structureKey - the structure key of this ddm structure

setType

public void setType(int type)

Sets the type of this ddm structure.

Specified by:

setType in interface DDMStructureModel

Parameters:

type - the type of this ddm structure

setUserId

public void setUserId(long userId)

Sets the user ID of this ddm structure.

Specified by:

setUserId in interface DDMStructureModel

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this ddm structure

setUserName

public void setUserName(java.lang.String userName)

Sets the user name of this ddm structure.

Specified by:

setUserName in interface DDMStructureModel

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this ddm structure

setUserUuid

public void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this ddm structure.

Specified by:

setUserUuid in interface DDMStructureModel

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this ddm structure

setUuid

public void setUuid(java.lang.String uuid)

Sets the uuid of this ddm structure.

Specified by:

setUuid in interface DDMStructureModel

Specified by:

setUuid in interface StagedModel

Parameters:

uuid - the uuid of this ddm structure

setVersion

public void setVersion(java.lang.String version)

Sets the version of this ddm structure.

Specified by:

setVersion in interface DDMStructureModel

Parameters:

version - the version of this ddm structure

setVersionUserId

public void setVersionUserId(long versionUserId)

Sets the version user ID of this ddm structure.

Specified by:

setVersionUserId in interface DDMStructureModel

Parameters:

versionUserId - the version user ID of this ddm structure

setVersionUserName

public void setVersionUserName(java.lang.String versionUserName)

Sets the version user name of this ddm structure.

Specified by:

setVersionUserName in interface DDMStructureModel

Parameters:

versionUserName - the version user name of this ddm structure

setVersionUserUuid

public void setVersionUserUuid(java.lang.String versionUserUuid)

Sets the version user uuid of this ddm structure.

Specified by:

setVersionUserUuid in interface DDMStructureModel

Parameters:

versionUserUuid - the version user uuid of this ddm structure

getAttributeGetterFunctions

public java.util.Map<java.lang.String,java.util.function.Function<DDMStructure,java.lang.Object>> getAttributeGetterFunctions()

Specified by:

getAttributeGetterFunctions in interface BaseModel<DDMStructure>

getAttributeSetterBiConsumers

public java.util.Map<java.lang.String,java.util.function.BiConsumer<DDMStructure,java.lang.Object>> getAttributeSetterBiConsumers()

Specified by:

getAttributeSetterBiConsumers in interface BaseModel<DDMStructure>

getStagedModelType

public StagedModelType getStagedModelType()

Specified by:

getStagedModelType in interface StagedModel

wrap

protected DDMStructureWrapper wrap(DDMStructure ddmStructure)

Specified by:

wrap in class BaseModelWrapper<DDMStructure>