@ProviderType public interface DDMStructureModel extends com.liferay.portal.kernel.model.BaseModel<DDMStructure>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel, com.liferay.portal.kernel.model.TypedModel
This interface and its corresponding implementation DDMStructureModelImpl
exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in DDMStructureImpl
.
DDMStructure
,
DDMStructureImpl
,
DDMStructureModelImpl
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone() |
int |
compareTo(DDMStructure ddmStructure) |
java.lang.String[] |
getAvailableLanguageIds() |
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.
|
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() |
long |
getGroupId()
Returns the group ID of this ddm structure.
|
java.util.Date |
getLastPublishDate()
Returns the last publish date of this ddm structure.
|
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.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.
|
int |
getType()
Returns the type of this ddm structure.
|
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.
|
int |
hashCode() |
boolean |
isCachedModel() |
boolean |
isEscapedModel() |
boolean |
isNew() |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
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 |
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 |
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() |
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this ddm structure@AutoEscape java.lang.String getUuid()
getUuid
in interface com.liferay.portal.kernel.model.StagedModel
void setUuid(java.lang.String uuid)
setUuid
in interface com.liferay.portal.kernel.model.StagedModel
uuid
- the uuid of this ddm structurelong getStructureId()
void setStructureId(long structureId)
structureId
- the structure ID of this ddm structurelong getGroupId()
getGroupId
in interface com.liferay.portal.kernel.model.GroupedModel
void setGroupId(long groupId)
setGroupId
in interface com.liferay.portal.kernel.model.GroupedModel
groupId
- the group ID of this ddm structurelong getCompanyId()
getCompanyId
in interface com.liferay.portal.kernel.model.AuditedModel
getCompanyId
in interface com.liferay.portal.kernel.model.ShardedModel
getCompanyId
in interface com.liferay.portal.kernel.model.StagedModel
void setCompanyId(long companyId)
setCompanyId
in interface com.liferay.portal.kernel.model.AuditedModel
setCompanyId
in interface com.liferay.portal.kernel.model.ShardedModel
setCompanyId
in interface com.liferay.portal.kernel.model.StagedModel
companyId
- the company ID of this ddm structurelong getUserId()
getUserId
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserId(long userId)
setUserId
in interface com.liferay.portal.kernel.model.AuditedModel
userId
- the user ID of this ddm structurejava.lang.String getUserUuid()
getUserUuid
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserUuid(java.lang.String userUuid)
setUserUuid
in interface com.liferay.portal.kernel.model.AuditedModel
userUuid
- the user uuid of this ddm structure@AutoEscape java.lang.String getUserName()
getUserName
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserName(java.lang.String userName)
setUserName
in interface com.liferay.portal.kernel.model.AuditedModel
userName
- the user name of this ddm structurelong getVersionUserId()
void setVersionUserId(long versionUserId)
versionUserId
- the version user ID of this ddm structurejava.lang.String getVersionUserUuid()
void setVersionUserUuid(java.lang.String versionUserUuid)
versionUserUuid
- the version user uuid of this ddm structure@AutoEscape java.lang.String getVersionUserName()
void setVersionUserName(java.lang.String versionUserName)
versionUserName
- the version user name of this ddm structurejava.util.Date getCreateDate()
getCreateDate
in interface com.liferay.portal.kernel.model.AuditedModel
getCreateDate
in interface com.liferay.portal.kernel.model.StagedModel
void setCreateDate(java.util.Date createDate)
setCreateDate
in interface com.liferay.portal.kernel.model.AuditedModel
setCreateDate
in interface com.liferay.portal.kernel.model.StagedModel
createDate
- the create date of this ddm structurejava.util.Date getModifiedDate()
getModifiedDate
in interface com.liferay.portal.kernel.model.AuditedModel
getModifiedDate
in interface com.liferay.portal.kernel.model.StagedModel
void setModifiedDate(java.util.Date modifiedDate)
setModifiedDate
in interface com.liferay.portal.kernel.model.AuditedModel
setModifiedDate
in interface com.liferay.portal.kernel.model.StagedModel
modifiedDate
- the modified date of this ddm structurelong getParentStructureId()
void setParentStructureId(long parentStructureId)
parentStructureId
- the parent structure ID of this ddm structurejava.lang.String getClassName()
getClassName
in interface com.liferay.portal.kernel.model.TypedModel
void setClassName(java.lang.String className)
long getClassNameId()
getClassNameId
in interface com.liferay.portal.kernel.model.TypedModel
void setClassNameId(long classNameId)
setClassNameId
in interface com.liferay.portal.kernel.model.TypedModel
classNameId
- the class name ID of this ddm structurejava.lang.String getStructureKey()
void setStructureKey(java.lang.String structureKey)
structureKey
- the structure key of this ddm structure@AutoEscape java.lang.String getVersion()
void setVersion(java.lang.String version)
version
- the version of this ddm structurejava.lang.String getName()
@AutoEscape java.lang.String getName(java.util.Locale locale)
locale
- the locale of the language@AutoEscape java.lang.String getName(java.util.Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested languageuseDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getName(java.lang.String languageId)
languageId
- the ID of the language@AutoEscape java.lang.String getName(java.lang.String languageId, boolean useDefault)
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language@AutoEscape java.lang.String getNameCurrentLanguageId()
@AutoEscape java.lang.String getNameCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getNameMap()
void setName(java.lang.String name)
name
- the name of this ddm structurevoid setName(java.lang.String name, java.util.Locale locale)
name
- the localized name of this ddm structurelocale
- the locale of the languagevoid setName(java.lang.String name, java.util.Locale locale, java.util.Locale defaultLocale)
name
- the localized name of this ddm structurelocale
- the locale of the languagedefaultLocale
- the default localevoid setNameCurrentLanguageId(java.lang.String languageId)
void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)
nameMap
- the locales and localized names of this ddm structurevoid setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Locale defaultLocale)
nameMap
- the locales and localized names of this ddm structuredefaultLocale
- the default localejava.lang.String getDescription()
@AutoEscape java.lang.String getDescription(java.util.Locale locale)
locale
- the locale of the language@AutoEscape java.lang.String getDescription(java.util.Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested languageuseDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getDescription(java.lang.String languageId)
languageId
- the ID of the language@AutoEscape java.lang.String getDescription(java.lang.String languageId, boolean useDefault)
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language@AutoEscape java.lang.String getDescriptionCurrentLanguageId()
@AutoEscape java.lang.String getDescriptionCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()
void setDescription(java.lang.String description)
description
- the description of this ddm structurevoid setDescription(java.lang.String description, java.util.Locale locale)
description
- the localized description of this ddm structurelocale
- the locale of the languagevoid setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale)
description
- the localized description of this ddm structurelocale
- the locale of the languagedefaultLocale
- the default localevoid setDescriptionCurrentLanguageId(java.lang.String languageId)
void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)
descriptionMap
- the locales and localized descriptions of this ddm structurevoid setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Locale defaultLocale)
descriptionMap
- the locales and localized descriptions of this ddm structuredefaultLocale
- the default locale@AutoEscape java.lang.String getDefinition()
void setDefinition(java.lang.String definition)
definition
- the definition of this ddm structure@AutoEscape java.lang.String getStorageType()
void setStorageType(java.lang.String storageType)
storageType
- the storage type of this ddm structureint getType()
void setType(int type)
type
- the type of this ddm structurejava.util.Date getLastPublishDate()
getLastPublishDate
in interface com.liferay.portal.kernel.model.StagedGroupedModel
void setLastPublishDate(java.util.Date lastPublishDate)
setLastPublishDate
in interface com.liferay.portal.kernel.model.StagedGroupedModel
lastPublishDate
- the last publish date of this ddm structureboolean isNew()
isNew
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
void setNew(boolean n)
setNew
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
boolean isCachedModel()
isCachedModel
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
void setCachedModel(boolean cachedModel)
setCachedModel
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
boolean isEscapedModel()
isEscapedModel
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
java.io.Serializable getPrimaryKeyObj()
getPrimaryKeyObj
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
getPrimaryKeyObj
in interface com.liferay.portal.kernel.model.ClassedModel
void setPrimaryKeyObj(java.io.Serializable primaryKeyObj)
setPrimaryKeyObj
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
setPrimaryKeyObj
in interface com.liferay.portal.kernel.model.ClassedModel
com.liferay.expando.kernel.model.ExpandoBridge getExpandoBridge()
getExpandoBridge
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
getExpandoBridge
in interface com.liferay.portal.kernel.model.ClassedModel
void setExpandoBridgeAttributes(com.liferay.portal.kernel.model.BaseModel<?> baseModel)
setExpandoBridgeAttributes
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
void setExpandoBridgeAttributes(com.liferay.expando.kernel.model.ExpandoBridge expandoBridge)
setExpandoBridgeAttributes
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
void setExpandoBridgeAttributes(com.liferay.portal.kernel.service.ServiceContext serviceContext)
setExpandoBridgeAttributes
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
java.lang.String[] getAvailableLanguageIds()
getAvailableLanguageIds
in interface com.liferay.portal.kernel.model.LocalizedModel
java.lang.String getDefaultLanguageId()
getDefaultLanguageId
in interface com.liferay.portal.kernel.model.LocalizedModel
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport
in interface com.liferay.portal.kernel.model.LocalizedModel
com.liferay.portal.kernel.exception.LocaleException
void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport
in interface com.liferay.portal.kernel.model.LocalizedModel
com.liferay.portal.kernel.exception.LocaleException
java.lang.Object clone()
clone
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
clone
in interface com.liferay.portal.kernel.model.StagedModel
int compareTo(DDMStructure ddmStructure)
compareTo
in interface java.lang.Comparable<DDMStructure>
int hashCode()
hashCode
in class java.lang.Object
com.liferay.portal.kernel.model.CacheModel<DDMStructure> toCacheModel()
toCacheModel
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
DDMStructure toEscapedModel()
toEscapedModel
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
DDMStructure toUnescapedModel()
toUnescapedModel
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>
java.lang.String toString()
toString
in class java.lang.Object
java.lang.String toXmlString()
toXmlString
in interface com.liferay.portal.kernel.model.BaseModel<DDMStructure>