com.liferay.dynamic.data.mapping.model

Class DDMStructureWrapper

java.lang.Object

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

All Implemented Interfaces:

DDMStructure, DDMStructureModel, com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<DDMStructure>, com.liferay.portal.kernel.model.ClassedModel, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.ModelWrapper<DDMStructure>, com.liferay.portal.kernel.model.PersistedModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel, com.liferay.portal.kernel.model.StagedModel, com.liferay.portal.kernel.model.TypedModel, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<DDMStructure>

@ProviderType
public class DDMStructureWrapper
extends java.lang.Object
implements DDMStructure, com.liferay.portal.kernel.model.ModelWrapper<DDMStructure>

This class is a wrapper for DDMStructure.

See Also:

DDMStructure, Serialized Form

Generated:

Field Summary

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
java.lang.Object	clone()
int	compareTo(DDMStructure ddmStructure)
DDMForm	createFullHierarchyDDMForm()
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 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.
DDMForm	getDDMForm()
DDMFormField	getDDMFormField(java.lang.String fieldName)
java.util.List<DDMFormField>	getDDMFormFields(boolean includeTransientFields)
DDMFormLayout	getDDMFormLayout()
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.
com.liferay.expando.kernel.model.ExpandoBridge	getExpandoBridge()
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.lang.Class<?>	getModelClass()
java.lang.String	getModelClassName()
java.util.Date	getModifiedDate() Returns the modified date 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.io.Serializable	getPrimaryKeyObj()
java.util.List<java.lang.String>	getRootFieldNames()
com.liferay.exportimport.kernel.lar.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(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay, java.lang.String webDAVToken) Returns the WebDAV URL to access the structure.
DDMStructure	getWrappedModel()
boolean	hasField(java.lang.String fieldName)
int	hashCode()
boolean	isCachedModel()
boolean	isEntityCacheEnabled()
boolean	isEscapedModel()
boolean	isFieldRepeatable(java.lang.String fieldName)
boolean	isFieldTransient(java.lang.String fieldName)
boolean	isFinderCacheEnabled()
boolean	isNew()
void	persist()
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
void	resetOriginalValues()
void	setCachedModel(boolean cachedModel)
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	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	setExpandoBridgeAttributes(com.liferay.portal.kernel.model.BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(com.liferay.expando.kernel.model.ExpandoBridge expandoBridge)
void	setExpandoBridgeAttributes(com.liferay.portal.kernel.service.ServiceContext serviceContext)
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	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	setNew(boolean n)
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	setPrimaryKeyObj(java.io.Serializable primaryKeyObj)
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.
com.liferay.portal.kernel.model.CacheModel<DDMStructure>	toCacheModel()
DDMStructure	toEscapedModel()
java.lang.String	toString()
DDMStructure	toUnescapedModel()
java.lang.String	toXmlString()

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 com.liferay.portal.kernel.model.ClassedModel

getModelClassName

public java.lang.String getModelClassName()

Specified by:

getModelClassName in interface com.liferay.portal.kernel.model.ClassedModel

getModelAttributes

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

Specified by:

getModelAttributes in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

setModelAttributes

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

Specified by:

setModelAttributes in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

createFullHierarchyDDMForm

public DDMForm createFullHierarchyDDMForm()
                                   throws com.liferay.portal.kernel.exception.PortalException

Specified by:

createFullHierarchyDDMForm in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

getDDMForm

public DDMForm getDDMForm()

Specified by:

getDDMForm in interface DDMStructure

getFullHierarchyDDMForm

public DDMForm getFullHierarchyDDMForm()

Specified by:

getFullHierarchyDDMForm in interface DDMStructure

getDDMFormField

public DDMFormField getDDMFormField(java.lang.String fieldName)
                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getDDMFormField in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

getDDMFormLayout

public DDMFormLayout getDDMFormLayout()
                               throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getDDMFormLayout in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

toEscapedModel

public DDMStructure toEscapedModel()

Specified by:

toEscapedModel in interface DDMStructureModel

Specified by:

toEscapedModel in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

toUnescapedModel

public DDMStructure toUnescapedModel()

Specified by:

toUnescapedModel in interface DDMStructureModel

Specified by:

toUnescapedModel in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

getLatestStructureVersion

public DDMStructureVersion getLatestStructureVersion()
                                              throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getLatestStructureVersion in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

getStructureVersion

public DDMStructureVersion getStructureVersion()
                                        throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getStructureVersion in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

getFieldRepeatable

public boolean getFieldRepeatable(java.lang.String fieldName)
                           throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getFieldRepeatable in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

getFieldRequired

public boolean getFieldRequired(java.lang.String fieldName)
                         throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getFieldRequired in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

hasField

public boolean hasField(java.lang.String fieldName)

Specified by:

hasField in interface DDMStructure

isCachedModel

public boolean isCachedModel()

Specified by:

isCachedModel in interface DDMStructureModel

Specified by:

isCachedModel in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

isEscapedModel

public boolean isEscapedModel()

Specified by:

isEscapedModel in interface DDMStructureModel

Specified by:

isEscapedModel in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

isFieldRepeatable

public boolean isFieldRepeatable(java.lang.String fieldName)
                          throws com.liferay.portal.kernel.exception.PortalException

Specified by:

isFieldRepeatable in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

isFieldTransient

public boolean isFieldTransient(java.lang.String fieldName)
                         throws com.liferay.portal.kernel.exception.PortalException

Specified by:

isFieldTransient in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

isNew

public boolean isNew()

Specified by:

isNew in interface DDMStructureModel

Specified by:

isNew in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

getExpandoBridge

public com.liferay.expando.kernel.model.ExpandoBridge getExpandoBridge()

Specified by:

getExpandoBridge in interface DDMStructureModel

Specified by:

getExpandoBridge in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

Specified by:

getExpandoBridge in interface com.liferay.portal.kernel.model.ClassedModel

toCacheModel

public com.liferay.portal.kernel.model.CacheModel<DDMStructure> toCacheModel()

Specified by:

toCacheModel in interface DDMStructureModel

Specified by:

toCacheModel in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

compareTo

public int compareTo(DDMStructure ddmStructure)

Specified by:

compareTo in interface DDMStructureModel

Specified by:

compareTo in interface java.lang.Comparable<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

hashCode

public int hashCode()

Specified by:

hashCode in interface DDMStructureModel

Overrides:

hashCode in class java.lang.Object

getPrimaryKeyObj

public java.io.Serializable getPrimaryKeyObj()

Specified by:

getPrimaryKeyObj in interface DDMStructureModel

Specified by:

getPrimaryKeyObj in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

Specified by:

getPrimaryKeyObj in interface com.liferay.portal.kernel.model.ClassedModel

clone

public java.lang.Object clone()

Specified by:

clone in interface DDMStructureModel

Specified by:

clone in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

Specified by:

clone in interface com.liferay.portal.kernel.model.StagedModel

Overrides:

clone in class java.lang.Object

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 com.liferay.portal.kernel.model.TypedModel

Returns:

the fully qualified class name of this ddm structure

getDefaultLanguageId

public java.lang.String getDefaultLanguageId()

Specified by:

getDefaultLanguageId in interface DDMStructureModel

Specified by:

getDefaultLanguageId in interface com.liferay.portal.kernel.model.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.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

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.

getDescriptionCurrentLanguageId

public java.lang.String getDescriptionCurrentLanguageId()

Specified by:

getDescriptionCurrentLanguageId in interface DDMStructureModel

getDescriptionCurrentValue

public java.lang.String getDescriptionCurrentValue()

Specified by:

getDescriptionCurrentValue in interface DDMStructureModel

getFieldDataType

public java.lang.String getFieldDataType(java.lang.String fieldName)
                                  throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getFieldDataType in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

getFieldLabel

public java.lang.String getFieldLabel(java.lang.String fieldName,
                                      java.lang.String locale)
                               throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getFieldLabel in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

getFieldLabel

public java.lang.String getFieldLabel(java.lang.String fieldName,
                                      java.util.Locale locale)
                               throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getFieldLabel in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

getFieldProperty

public java.lang.String getFieldProperty(java.lang.String fieldName,
                                         java.lang.String property)
                                  throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getFieldProperty in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

getFieldTip

public java.lang.String getFieldTip(java.lang.String fieldName,
                                    java.lang.String locale)
                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getFieldTip in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

getFieldTip

public java.lang.String getFieldTip(java.lang.String fieldName,
                                    java.util.Locale locale)
                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getFieldTip in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

getFieldType

public java.lang.String getFieldType(java.lang.String fieldName)
                              throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getFieldType in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

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

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.

getNameCurrentLanguageId

public java.lang.String getNameCurrentLanguageId()

Specified by:

getNameCurrentLanguageId in interface DDMStructureModel

getNameCurrentValue

public java.lang.String getNameCurrentValue()

Specified by:

getNameCurrentValue in interface DDMStructureModel

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

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

getUnambiguousName

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

Specified by:

getUnambiguousName in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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

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(com.liferay.portal.kernel.theme.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

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()

Specified by:

toXmlString in interface DDMStructureModel

Specified by:

toXmlString in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

getAvailableLanguageIds

public java.lang.String[] getAvailableLanguageIds()

Specified by:

getAvailableLanguageIds in interface DDMStructureModel

Specified by:

getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModel

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 com.liferay.portal.kernel.model.AuditedModel

Specified by:

getCreateDate in interface com.liferay.portal.kernel.model.StagedModel

Returns:

the create date 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 com.liferay.portal.kernel.model.StagedGroupedModel

Returns:

the last publish date of this ddm structure

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 com.liferay.portal.kernel.model.AuditedModel

Specified by:

getModifiedDate in interface com.liferay.portal.kernel.model.StagedModel

Returns:

the modified date of this ddm structure

getChildrenFieldNames

public java.util.List<java.lang.String> getChildrenFieldNames(java.lang.String fieldName)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getChildrenFieldNames in interface DDMStructure

Throws:

com.liferay.portal.kernel.exception.PortalException

getDDMFormFields

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

Specified by:

getDDMFormFields in interface DDMStructure

getRootFieldNames

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

Specified by:

getRootFieldNames in interface DDMStructure

getTemplates

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

Specified by:

getTemplates in interface DDMStructure

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

getFullHierarchyDDMFormFieldsMap

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

Specified by:

getFullHierarchyDDMFormFieldsMap in interface DDMStructure

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

getFieldNames

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

Specified by:

getFieldNames in interface DDMStructure

getClassNameId

public long getClassNameId()

Returns the class name ID of this ddm structure.

Specified by:

getClassNameId in interface DDMStructureModel

Specified by:

getClassNameId in interface com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.AuditedModel

Specified by:

getCompanyId in interface com.liferay.portal.kernel.model.ShardedModel

Specified by:

getCompanyId in interface com.liferay.portal.kernel.model.StagedModel

Returns:

the company ID of this ddm structure

getGroupId

public long getGroupId()

Returns the group ID of this ddm structure.

Specified by:

getGroupId in interface DDMStructureModel

Specified by:

getGroupId in interface com.liferay.portal.kernel.model.GroupedModel

Returns:

the group ID 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

Returns:

the primary key 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

getUserId

public long getUserId()

Returns the user ID of this ddm structure.

Specified by:

getUserId in interface DDMStructureModel

Specified by:

getUserId in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the user ID 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

persist

public void persist()

Specified by:

persist in interface com.liferay.portal.kernel.model.PersistedModel

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport()
                                     throws com.liferay.portal.kernel.exception.LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface DDMStructureModel

Specified by:

prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel

Throws:

com.liferay.portal.kernel.exception.LocaleException

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
                                     throws com.liferay.portal.kernel.exception.LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface DDMStructureModel

Specified by:

prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel

Throws:

com.liferay.portal.kernel.exception.LocaleException

setCachedModel

public void setCachedModel(boolean cachedModel)

Specified by:

setCachedModel in interface DDMStructureModel

Specified by:

setCachedModel in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.AuditedModel

Specified by:

setCompanyId in interface com.liferay.portal.kernel.model.ShardedModel

Specified by:

setCompanyId in interface com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.AuditedModel

Specified by:

setCreateDate in interface com.liferay.portal.kernel.model.StagedModel

Parameters:

createDate - the create date 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

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(com.liferay.expando.kernel.model.ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface DDMStructureModel

Specified by:

setExpandoBridgeAttributes in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(com.liferay.portal.kernel.model.BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface DDMStructureModel

Specified by:

setExpandoBridgeAttributes in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(com.liferay.portal.kernel.service.ServiceContext serviceContext)

Specified by:

setExpandoBridgeAttributes in interface DDMStructureModel

Specified by:

setExpandoBridgeAttributes in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.AuditedModel

Specified by:

setModifiedDate in interface com.liferay.portal.kernel.model.StagedModel

Parameters:

modifiedDate - the modified date 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

setNew

public void setNew(boolean n)

Specified by:

setNew in interface DDMStructureModel

Specified by:

setNew in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

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

Parameters:

primaryKey - the primary key of this ddm structure

setPrimaryKeyObj

public void setPrimaryKeyObj(java.io.Serializable primaryKeyObj)

Specified by:

setPrimaryKeyObj in interface DDMStructureModel

Specified by:

setPrimaryKeyObj in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

Specified by:

setPrimaryKeyObj in interface com.liferay.portal.kernel.model.ClassedModel

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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.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

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getStagedModelType

public com.liferay.exportimport.kernel.lar.StagedModelType getStagedModelType()

Specified by:

getStagedModelType in interface com.liferay.portal.kernel.model.StagedModel

getWrappedModel

public DDMStructure getWrappedModel()

Specified by:

getWrappedModel in interface com.liferay.portal.kernel.model.ModelWrapper<DDMStructure>

isEntityCacheEnabled

public boolean isEntityCacheEnabled()

Specified by:

isEntityCacheEnabled in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

isFinderCacheEnabled

public boolean isFinderCacheEnabled()

Specified by:

isFinderCacheEnabled in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>

resetOriginalValues

public void resetOriginalValues()

Specified by:

resetOriginalValues in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>