com.liferay.portlet.dynamicdatamapping.model

Class DDMStructureWrapper

java.lang.Object

com.liferay.portlet.dynamicdatamapping.model.DDMStructureWrapper

All Implemented Interfaces:

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

@ProviderType
public class DDMStructureWrapper
extends java.lang.Object
implements DDMStructure, ModelWrapper<DDMStructure>

This class is a wrapper for DDMStructure.

Author:

Brian Wing Shun Chan

See Also:

DDMStructure, Serialized Form

Generated:

Constructor Summary

Constructors

Constructor and Description
DDMStructureWrapper(DDMStructure ddmStructure)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a shallow clone of this model instance.
int	compareTo(DDMStructure ddmStructure)
boolean	equals(java.lang.Object obj)
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 d d m structure.
long	getClassNameId() Returns the class name ID of this d d m structure.
long	getCompanyId() Returns the company ID of this d d m structure.
java.lang.String	getCompleteXsd()
java.util.Date	getCreateDate() Returns the create date of this d d m structure.
java.lang.String	getDefaultLanguageId()
java.lang.String	getDescription() Returns the description of this d d m structure.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this d d m structure in the language.
java.lang.String	getDescription(java.util.Locale locale, boolean useDefault) Returns the localized description of this d d m 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 d d m structure in the language.
java.lang.String	getDescription(java.lang.String languageId, boolean useDefault) Returns the localized description of this d d m 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 d d m structure.
Document	getDocument()
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
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)
java.lang.String	getFieldProperty(java.lang.String fieldName, java.lang.String property, java.lang.String locale)
boolean	getFieldRepeatable(java.lang.String fieldName)
boolean	getFieldRequired(java.lang.String fieldName)
java.util.Map<java.lang.String,java.lang.String>	getFields(java.lang.String fieldName, java.lang.String attributeName, java.lang.String attributeValue)
java.util.Map<java.lang.String,java.lang.String>	getFields(java.lang.String fieldName, java.lang.String attributeName, java.lang.String attributeValue, java.lang.String locale)
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getFieldsMap()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getFieldsMap(boolean includeTransientFields)
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getFieldsMap(java.lang.String locale)
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getFieldsMap(java.lang.String locale, boolean includeTransientFields)
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)
long	getGroupId() Returns the group ID of this d d m structure.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>>	getLocalizedFieldsMap()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>>	getLocalizedPersistentFieldsMap()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>>	getLocalizedTransientFieldsMap()
java.util.Map<java.lang.String,java.lang.Object>	getModelAttributes()
java.lang.Class<?>	getModelClass()
java.lang.String	getModelClassName()
java.util.Date	getModifiedDate() Returns the modified date of this d d m structure.
java.lang.String	getName() Returns the name of this d d m structure.
java.lang.String	getName(java.util.Locale locale) Returns the localized name of this d d m structure in the language.
java.lang.String	getName(java.util.Locale locale, boolean useDefault) Returns the localized name of this d d m 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 d d m structure in the language.
java.lang.String	getName(java.lang.String languageId, boolean useDefault) Returns the localized name of this d d m 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 d d m structure.
long	getParentStructureId() Returns the parent structure ID of this d d m structure.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getPersistentFieldsMap(java.lang.String locale)
long	getPrimaryKey() Returns the primary key of this d d m structure.
java.io.Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
java.util.List<java.lang.String>	getRootFieldNames()
StagedModelType	getStagedModelType()
java.lang.String	getStorageType() Returns the storage type of this d d m structure.
long	getStructureId() Returns the structure ID of this d d m structure.
java.lang.String	getStructureKey() Returns the structure key of this d d m structure.
java.util.List<DDMTemplate>	getTemplates()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getTransientFieldsMap(java.lang.String locale)
int	getType() Returns the type of this d d m structure.
long	getUserId() Returns the user ID of this d d m structure.
java.lang.String	getUserName() Returns the user name of this d d m structure.
java.lang.String	getUserUuid() Returns the user uuid of this d d m structure.
java.lang.String	getUuid() Returns the uuid of this d d m structure.
java.lang.String	getWebDavURL(ThemeDisplay themeDisplay, java.lang.String webDAVToken) Returns the WebDAV URL to access the structure.
DDMStructure	getWrappedDDMStructure() Deprecated. As of 6.1.0, replaced by getWrappedModel()
DDMStructure	getWrappedModel()
java.lang.String	getXsd() Returns the xsd of this d d m structure.
boolean	hasField(java.lang.String fieldName)
int	hashCode()
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isFieldPrivate(java.lang.String fieldName)
boolean	isFieldRepeatable(java.lang.String fieldName)
boolean	isFieldTransient(java.lang.String fieldName)
boolean	isNew() Returns true if this model instance does not yet exist in the database.
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	resetOriginalValues() Reset all original fields to current values.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setClassName(java.lang.String className)
void	setClassNameId(long classNameId) Sets the class name ID of this d d m structure.
void	setCompanyId(long companyId) Sets the company ID of this d d m structure.
void	setCreateDate(java.util.Date createDate) Sets the create date of this d d m structure.
void	setDescription(java.lang.String description) Sets the description of this d d m structure.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this d d m structure in the language.
void	setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized description of this d d m 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 d d m 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 d d m structure from the map of locales and localized descriptions, and sets the default locale.
void	setDocument(Document document)
void	setExpandoBridgeAttributes(BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setGroupId(long groupId) Sets the group ID of this d d m structure.
void	setLocalizedFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedFieldsMap)
void	setLocalizedPersistentFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedPersistentFieldsMap)
void	setLocalizedTransientFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedTransientFieldsMap)
void	setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
void	setModifiedDate(java.util.Date modifiedDate) Sets the modified date of this d d m structure.
void	setName(java.lang.String name) Sets the name of this d d m structure.
void	setName(java.lang.String name, java.util.Locale locale) Sets the localized name of this d d m structure in the language.
void	setName(java.lang.String name, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized name of this d d m 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 d d m 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 d d m structure from the map of locales and localized names, and sets the default locale.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setParentStructureId(long parentStructureId) Sets the parent structure ID of this d d m structure.
void	setPrimaryKey(long primaryKey) Sets the primary key of this d d m structure.
void	setPrimaryKeyObj(java.io.Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setStorageType(java.lang.String storageType) Sets the storage type of this d d m structure.
void	setStructureId(long structureId) Sets the structure ID of this d d m structure.
void	setStructureKey(java.lang.String structureKey) Sets the structure key of this d d m structure.
void	setType(int type) Sets the type of this d d m structure.
void	setUserId(long userId) Sets the user ID of this d d m structure.
void	setUserName(java.lang.String userName) Sets the user name of this d d m structure.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this d d m structure.
void	setUuid(java.lang.String uuid) Sets the uuid of this d d m structure.
void	setXsd(java.lang.String xsd) Sets the xsd of this d d m structure.
CacheModel<DDMStructure>	toCacheModel() Returns a cache model object for this entity used by entity cache.
DDMStructure	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
java.lang.String	toString()
DDMStructure	toUnescapedModel()
java.lang.String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

DDMStructureWrapper

public DDMStructureWrapper(DDMStructure ddmStructure)

Method Detail

getModelClass

public java.lang.Class<?> getModelClass()

Specified by:

getModelClass in interface ClassedModel

getModelClassName

public java.lang.String getModelClassName()

Specified by:

getModelClassName in interface ClassedModel

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>

getPrimaryKey

public long getPrimaryKey()

Returns the primary key of this d d m structure.

Specified by:

getPrimaryKey in interface DDMStructureModel

Returns:

the primary key of this d d m structure

setPrimaryKey

public void setPrimaryKey(long primaryKey)

Sets the primary key of this d d m structure.

Specified by:

setPrimaryKey in interface DDMStructureModel

Parameters:

primaryKey - the primary key of this d d m structure

getUuid

public java.lang.String getUuid()

Returns the uuid of this d d m structure.

Specified by:

getUuid in interface StagedModel

Specified by:

getUuid in interface DDMStructureModel

Returns:

the uuid of this d d m structure

setUuid

public void setUuid(java.lang.String uuid)

Sets the uuid of this d d m structure.

Specified by:

setUuid in interface StagedModel

Specified by:

setUuid in interface DDMStructureModel

Parameters:

uuid - the uuid of this d d m structure

getStructureId

public long getStructureId()

Returns the structure ID of this d d m structure.

Specified by:

getStructureId in interface DDMStructureModel

Returns:

the structure ID of this d d m structure

setStructureId

public void setStructureId(long structureId)

Sets the structure ID of this d d m structure.

Specified by:

setStructureId in interface DDMStructureModel

Parameters:

structureId - the structure ID of this d d m structure

getGroupId

public long getGroupId()

Returns the group ID of this d d m structure.

Specified by:

getGroupId in interface GroupedModel

Specified by:

getGroupId in interface DDMStructureModel

Returns:

the group ID of this d d m structure

setGroupId

public void setGroupId(long groupId)

Sets the group ID of this d d m structure.

Specified by:

setGroupId in interface GroupedModel

Specified by:

setGroupId in interface DDMStructureModel

Parameters:

groupId - the group ID of this d d m structure

getCompanyId

public long getCompanyId()

Returns the company ID of this d d m structure.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface StagedModel

Specified by:

getCompanyId in interface DDMStructureModel

Returns:

the company ID of this d d m structure

setCompanyId

public void setCompanyId(long companyId)

Sets the company ID of this d d m structure.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface StagedModel

Specified by:

setCompanyId in interface DDMStructureModel

Parameters:

companyId - the company ID of this d d m structure

getUserId

public long getUserId()

Returns the user ID of this d d m structure.

Specified by:

getUserId in interface AuditedModel

Specified by:

getUserId in interface DDMStructureModel

Returns:

the user ID of this d d m structure

setUserId

public void setUserId(long userId)

Sets the user ID of this d d m structure.

Specified by:

setUserId in interface AuditedModel

Specified by:

setUserId in interface DDMStructureModel

Parameters:

userId - the user ID of this d d m structure

getUserUuid

public java.lang.String getUserUuid()
                             throws SystemException

Returns the user uuid of this d d m structure.

Specified by:

getUserUuid in interface AuditedModel

Specified by:

getUserUuid in interface DDMStructureModel

Returns:

the user uuid of this d d m structure

Throws:

SystemException - if a system exception occurred

setUserUuid

public void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this d d m structure.

Specified by:

setUserUuid in interface AuditedModel

Specified by:

setUserUuid in interface DDMStructureModel

Parameters:

userUuid - the user uuid of this d d m structure

getUserName

public java.lang.String getUserName()

Returns the user name of this d d m structure.

Specified by:

getUserName in interface AuditedModel

Specified by:

getUserName in interface DDMStructureModel

Returns:

the user name of this d d m structure

setUserName

public void setUserName(java.lang.String userName)

Sets the user name of this d d m structure.

Specified by:

setUserName in interface AuditedModel

Specified by:

setUserName in interface DDMStructureModel

Parameters:

userName - the user name of this d d m structure

getCreateDate

public java.util.Date getCreateDate()

Returns the create date of this d d m structure.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Specified by:

getCreateDate in interface DDMStructureModel

Returns:

the create date of this d d m structure

setCreateDate

public void setCreateDate(java.util.Date createDate)

Sets the create date of this d d m structure.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Specified by:

setCreateDate in interface DDMStructureModel

Parameters:

createDate - the create date of this d d m structure

getModifiedDate

public java.util.Date getModifiedDate()

Returns the modified date of this d d m structure.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Specified by:

getModifiedDate in interface DDMStructureModel

Returns:

the modified date of this d d m structure

setModifiedDate

public void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this d d m structure.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Specified by:

setModifiedDate in interface DDMStructureModel

Parameters:

modifiedDate - the modified date of this d d m structure

getParentStructureId

public long getParentStructureId()

Returns the parent structure ID of this d d m structure.

Specified by:

getParentStructureId in interface DDMStructureModel

Returns:

the parent structure ID of this d d m structure

setParentStructureId

public void setParentStructureId(long parentStructureId)

Sets the parent structure ID of this d d m structure.

Specified by:

setParentStructureId in interface DDMStructureModel

Parameters:

parentStructureId - the parent structure ID of this d d m structure

getClassName

public java.lang.String getClassName()

Returns the fully qualified class name of this d d m structure.

Specified by:

getClassName in interface TypedModel

Specified by:

getClassName in interface DDMStructureModel

Returns:

the fully qualified class name of this d d m structure

setClassName

public void setClassName(java.lang.String className)

Specified by:

setClassName in interface DDMStructureModel

getClassNameId

public long getClassNameId()

Returns the class name ID of this d d m structure.

Specified by:

getClassNameId in interface TypedModel

Specified by:

getClassNameId in interface DDMStructureModel

Returns:

the class name ID of this d d m structure

setClassNameId

public void setClassNameId(long classNameId)

Sets the class name ID of this d d m structure.

Specified by:

setClassNameId in interface TypedModel

Specified by:

setClassNameId in interface DDMStructureModel

Parameters:

classNameId - the class name ID of this d d m structure

getStructureKey

public java.lang.String getStructureKey()

Returns the structure key of this d d m structure.

Specified by:

getStructureKey in interface DDMStructureModel

Returns:

the structure key of this d d m structure

setStructureKey

public void setStructureKey(java.lang.String structureKey)

Sets the structure key of this d d m structure.

Specified by:

setStructureKey in interface DDMStructureModel

Parameters:

structureKey - the structure key of this d d m structure

getName

public java.lang.String getName()

Returns the name of this d d m structure.

Specified by:

getName in interface DDMStructureModel

Returns:

the name of this d d m structure

getName

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

Returns the localized name of this d d m 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 d d m structure

getName

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

Returns the localized name of this d d m 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 d d m 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 d d m 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 d d m structure

getName

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

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

Specified by:

getNameMap in interface DDMStructureModel

Returns:

the locales and localized names of this d d m structure

setName

public void setName(java.lang.String name)

Sets the name of this d d m structure.

Specified by:

setName in interface DDMStructureModel

Parameters:

name - the name of this d d m structure

setName

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

Sets the localized name of this d d m structure in the language.

Specified by:

setName in interface DDMStructureModel

Parameters:

name - the localized name of this d d m 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 d d m structure in the language, and sets the default locale.

Specified by:

setName in interface DDMStructureModel

Parameters:

name - the localized name of this d d m 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 d d m structure from the map of locales and localized names.

Specified by:

setNameMap in interface DDMStructureModel

Parameters:

nameMap - the locales and localized names of this d d m 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 d d m 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 d d m structure

defaultLocale - the default locale

getDescription

public java.lang.String getDescription()

Returns the description of this d d m structure.

Specified by:

getDescription in interface DDMStructureModel

Returns:

the description of this d d m structure

getDescription

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

Returns the localized description of this d d m 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 d d m structure

getDescription

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

Returns the localized description of this d d m 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 d d m 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 d d m 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 d d m structure

getDescription

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

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

Specified by:

getDescriptionMap in interface DDMStructureModel

Returns:

the locales and localized descriptions of this d d m structure

setDescription

public void setDescription(java.lang.String description)

Sets the description of this d d m structure.

Specified by:

setDescription in interface DDMStructureModel

Parameters:

description - the description of this d d m structure

setDescription

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

Sets the localized description of this d d m structure in the language.

Specified by:

setDescription in interface DDMStructureModel

Parameters:

description - the localized description of this d d m 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 d d m structure in the language, and sets the default locale.

Specified by:

setDescription in interface DDMStructureModel

Parameters:

description - the localized description of this d d m 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 d d m structure from the map of locales and localized descriptions.

Specified by:

setDescriptionMap in interface DDMStructureModel

Parameters:

descriptionMap - the locales and localized descriptions of this d d m 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 d d m 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 d d m structure

defaultLocale - the default locale

getXsd

public java.lang.String getXsd()

Returns the xsd of this d d m structure.

Specified by:

getXsd in interface DDMStructureModel

Returns:

the xsd of this d d m structure

setXsd

public void setXsd(java.lang.String xsd)

Sets the xsd of this d d m structure.

Specified by:

setXsd in interface DDMStructureModel

Parameters:

xsd - the xsd of this d d m structure

getStorageType

public java.lang.String getStorageType()

Returns the storage type of this d d m structure.

Specified by:

getStorageType in interface DDMStructureModel

Returns:

the storage type of this d d m structure

setStorageType

public void setStorageType(java.lang.String storageType)

Sets the storage type of this d d m structure.

Specified by:

setStorageType in interface DDMStructureModel

Parameters:

storageType - the storage type of this d d m structure

getType

public int getType()

Returns the type of this d d m structure.

Specified by:

getType in interface DDMStructureModel

Returns:

the type of this d d m structure

setType

public void setType(int type)

Sets the type of this d d m structure.

Specified by:

setType in interface DDMStructureModel

Parameters:

type - the type of this d d m structure

isNew

public boolean isNew()

Description copied from interface: BaseModel

Returns true if this model instance does not yet exist in the database.

Specified by:

isNew in interface BaseModel<DDMStructure>

Specified by:

isNew in interface DDMStructureModel

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

public void setNew(boolean n)

Description copied from interface: BaseModel

Sets whether this model instance does not yet exist in the database.

Specified by:

setNew in interface BaseModel<DDMStructure>

Specified by:

setNew in interface DDMStructureModel

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

public boolean isCachedModel()

Description copied from interface: BaseModel

Returns true if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<DDMStructure>

Specified by:

isCachedModel in interface DDMStructureModel

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

public void setCachedModel(boolean cachedModel)

Description copied from interface: BaseModel

Sets whether this model instance was retrieved from the entity cache.

Specified by:

setCachedModel in interface BaseModel<DDMStructure>

Specified by:

setCachedModel in interface DDMStructureModel

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

public boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<DDMStructure>

Specified by:

isEscapedModel in interface DDMStructureModel

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

public java.io.Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<DDMStructure>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Specified by:

getPrimaryKeyObj in interface DDMStructureModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

public void setPrimaryKeyObj(java.io.Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<DDMStructure>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Specified by:

setPrimaryKeyObj in interface DDMStructureModel

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<DDMStructure>

Specified by:

getExpandoBridge in interface ClassedModel

Specified by:

getExpandoBridge in interface DDMStructureModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<DDMStructure>

Specified by:

setExpandoBridgeAttributes in interface DDMStructureModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<DDMStructure>

Specified by:

setExpandoBridgeAttributes in interface DDMStructureModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ServiceContext serviceContext)

Description copied from interface: BaseModel

Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:

setExpandoBridgeAttributes in interface BaseModel<DDMStructure>

Specified by:

setExpandoBridgeAttributes in interface DDMStructureModel

Parameters:

serviceContext - the service context to be applied

See Also:

ServiceContext.getExpandoBridgeAttributes( )

getAvailableLanguageIds

public java.lang.String[] getAvailableLanguageIds()

Specified by:

getAvailableLanguageIds in interface DDMStructureModel

getDefaultLanguageId

public java.lang.String getDefaultLanguageId()

Specified by:

getDefaultLanguageId in interface DDMStructureModel

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport()
                                     throws LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface DDMStructureModel

Throws:

LocaleException

prepareLocalizedFieldsForImport

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

Specified by:

prepareLocalizedFieldsForImport in interface DDMStructureModel

Throws:

LocaleException

clone

public java.lang.Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<DDMStructure>

Specified by:

clone in interface StagedModel

Specified by:

clone in interface DDMStructureModel

Overrides:

clone in class java.lang.Object

Returns:

the shallow clone of this model instance

compareTo

public int compareTo(DDMStructure ddmStructure)

Specified by:

compareTo in interface DDMStructureModel

Specified by:

compareTo in interface java.lang.Comparable<DDMStructure>

hashCode

public int hashCode()

Specified by:

hashCode in interface DDMStructureModel

Overrides:

hashCode in class java.lang.Object

toCacheModel

public CacheModel<DDMStructure> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<DDMStructure>

Specified by:

toCacheModel in interface DDMStructureModel

Returns:

the cache model object

toEscapedModel

public DDMStructure toEscapedModel()

Description copied from interface: BaseModel

Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface BaseModel<DDMStructure>

Specified by:

toEscapedModel in interface DDMStructureModel

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

public DDMStructure toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<DDMStructure>

Specified by:

toUnescapedModel in interface DDMStructureModel

toString

public java.lang.String toString()

Specified by:

toString in interface DDMStructureModel

Overrides:

toString in class java.lang.Object

toXmlString

public java.lang.String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<DDMStructure>

Specified by:

toXmlString in interface DDMStructureModel

Returns:

the XML representation of this model instance

persist

public void persist()
             throws SystemException

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

Throws:

SystemException - if a system exception occurred

getChildrenFieldNames

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

Specified by:

getChildrenFieldNames in interface DDMStructure

Throws:

PortalException

SystemException

getCompleteXsd

public java.lang.String getCompleteXsd()
                                throws PortalException,
                                       SystemException

Specified by:

getCompleteXsd in interface DDMStructure

Throws:

PortalException

SystemException

getDocument

public Document getDocument()

Specified by:

getDocument in interface DDMStructure

getFieldDataType

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

Specified by:

getFieldDataType in interface DDMStructure

Throws:

PortalException

SystemException

getFieldLabel

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

Specified by:

getFieldLabel in interface DDMStructure

Throws:

PortalException

SystemException

getFieldLabel

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

Specified by:

getFieldLabel in interface DDMStructure

Throws:

PortalException

SystemException

getFieldNames

public java.util.Set<java.lang.String> getFieldNames()
                                              throws PortalException,
                                                     SystemException

Specified by:

getFieldNames in interface DDMStructure

Throws:

PortalException

SystemException

getFieldProperty

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

Specified by:

getFieldProperty in interface DDMStructure

Throws:

PortalException

SystemException

getFieldProperty

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

Specified by:

getFieldProperty in interface DDMStructure

Throws:

PortalException

SystemException

getFieldRepeatable

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

Specified by:

getFieldRepeatable in interface DDMStructure

Throws:

PortalException

SystemException

getFieldRequired

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

Specified by:

getFieldRequired in interface DDMStructure

Throws:

PortalException

SystemException

getFields

public java.util.Map<java.lang.String,java.lang.String> getFields(java.lang.String fieldName,
                                                         java.lang.String attributeName,
                                                         java.lang.String attributeValue)

Specified by:

getFields in interface DDMStructure

getFields

public java.util.Map<java.lang.String,java.lang.String> getFields(java.lang.String fieldName,
                                                         java.lang.String attributeName,
                                                         java.lang.String attributeValue,
                                                         java.lang.String locale)

Specified by:

getFields in interface DDMStructure

getFieldsMap

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFieldsMap()
                                                                                              throws PortalException,
                                                                                                     SystemException

Specified by:

getFieldsMap in interface DDMStructure

Throws:

PortalException

SystemException

getFieldsMap

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFieldsMap(boolean includeTransientFields)
                                                                                              throws PortalException,
                                                                                                     SystemException

Specified by:

getFieldsMap in interface DDMStructure

Throws:

PortalException

SystemException

getFieldsMap

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFieldsMap(java.lang.String locale)
                                                                                              throws PortalException,
                                                                                                     SystemException

Specified by:

getFieldsMap in interface DDMStructure

Throws:

PortalException

SystemException

getFieldsMap

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFieldsMap(java.lang.String locale,
                                                                                            boolean includeTransientFields)
                                                                                              throws PortalException,
                                                                                                     SystemException

Specified by:

getFieldsMap in interface DDMStructure

Throws:

PortalException

SystemException

getFieldTip

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

Specified by:

getFieldTip in interface DDMStructure

Throws:

PortalException

SystemException

getFieldTip

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

Specified by:

getFieldTip in interface DDMStructure

Throws:

PortalException

SystemException

getFieldType

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

Specified by:

getFieldType in interface DDMStructure

Throws:

PortalException

SystemException

getLocalizedFieldsMap

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

Specified by:

getLocalizedFieldsMap in interface DDMStructure

getLocalizedPersistentFieldsMap

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

Specified by:

getLocalizedPersistentFieldsMap in interface DDMStructure

getLocalizedTransientFieldsMap

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

Specified by:

getLocalizedTransientFieldsMap in interface DDMStructure

getPersistentFieldsMap

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getPersistentFieldsMap(java.lang.String locale)
                                                                                                        throws PortalException,
                                                                                                               SystemException

Specified by:

getPersistentFieldsMap in interface DDMStructure

Throws:

PortalException

SystemException

getRootFieldNames

public java.util.List<java.lang.String> getRootFieldNames()
                                                   throws PortalException,
                                                          SystemException

Specified by:

getRootFieldNames in interface DDMStructure

Throws:

PortalException

SystemException

getTemplates

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

Specified by:

getTemplates in interface DDMStructure

Throws:

SystemException

getTransientFieldsMap

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getTransientFieldsMap(java.lang.String locale)
                                                                                                       throws PortalException,
                                                                                                              SystemException

Specified by:

getTransientFieldsMap in interface DDMStructure

Throws:

PortalException

SystemException

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)
                 throws PortalException,
                        SystemException

Specified by:

hasField in interface DDMStructure

Throws:

PortalException

SystemException

isFieldPrivate

public boolean isFieldPrivate(java.lang.String fieldName)
                       throws PortalException,
                              SystemException

Specified by:

isFieldPrivate in interface DDMStructure

Throws:

PortalException

SystemException

isFieldRepeatable

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

Specified by:

isFieldRepeatable in interface DDMStructure

Throws:

PortalException

SystemException

isFieldTransient

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

Specified by:

isFieldTransient in interface DDMStructure

Throws:

PortalException

SystemException

setDocument

public void setDocument(Document document)

Specified by:

setDocument in interface DDMStructure

setLocalizedFieldsMap

public void setLocalizedFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedFieldsMap)

Specified by:

setLocalizedFieldsMap in interface DDMStructure

setLocalizedPersistentFieldsMap

public void setLocalizedPersistentFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedPersistentFieldsMap)

Specified by:

setLocalizedPersistentFieldsMap in interface DDMStructure

setLocalizedTransientFieldsMap

public void setLocalizedTransientFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedTransientFieldsMap)

Specified by:

setLocalizedTransientFieldsMap in interface DDMStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getStagedModelType

public StagedModelType getStagedModelType()

Specified by:

getStagedModelType in interface StagedModel

getWrappedDDMStructure

public DDMStructure getWrappedDDMStructure()

Deprecated. As of 6.1.0, replaced by getWrappedModel()

getWrappedModel

public DDMStructure getWrappedModel()

Specified by:

getWrappedModel in interface ModelWrapper<DDMStructure>

resetOriginalValues

public void resetOriginalValues()

Description copied from interface: BaseModel

Reset all original fields to current values.

Specified by:

resetOriginalValues in interface BaseModel<DDMStructure>