@ProviderType public interface DDMStructureVersionModel extends BaseModel<DDMStructureVersion>, LocalizedModel, ShardedModel, WorkflowedModel
This interface and its corresponding implementation com.liferay.dynamic.data.mapping.model.impl.DDMStructureVersionModelImpl
exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.dynamic.data.mapping.model.impl.DDMStructureVersionImpl
.
DDMStructureVersion
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Creates a shallow clone of this model instance.
|
int |
compareTo(DDMStructureVersion ddmStructureVersion) |
java.lang.String[] |
getAvailableLanguageIds() |
long |
getCompanyId()
Returns the company ID of this ddm structure version.
|
java.util.Date |
getCreateDate()
Returns the create date of this ddm structure version.
|
java.lang.String |
getDefaultLanguageId() |
java.lang.String |
getDefinition()
Returns the definition of this ddm structure version.
|
java.lang.String |
getDescription()
Returns the description of this ddm structure version.
|
java.lang.String |
getDescription(java.util.Locale locale)
Returns the localized description of this ddm structure version in the language.
|
java.lang.String |
getDescription(java.util.Locale locale,
boolean useDefault)
Returns the localized description of this ddm structure version 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 version in the language.
|
java.lang.String |
getDescription(java.lang.String languageId,
boolean useDefault)
Returns the localized description of this ddm structure version 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 version.
|
ExpandoBridge |
getExpandoBridge()
Returns the expando bridge for this model instance.
|
long |
getGroupId()
Returns the group ID of this ddm structure version.
|
java.lang.String |
getName()
Returns the name of this ddm structure version.
|
java.lang.String |
getName(java.util.Locale locale)
Returns the localized name of this ddm structure version in the language.
|
java.lang.String |
getName(java.util.Locale locale,
boolean useDefault)
Returns the localized name of this ddm structure version 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 version in the language.
|
java.lang.String |
getName(java.lang.String languageId,
boolean useDefault)
Returns the localized name of this ddm structure version 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 version.
|
long |
getParentStructureId()
Returns the parent structure ID of this ddm structure version.
|
long |
getPrimaryKey()
Returns the primary key of this ddm structure version.
|
java.io.Serializable |
getPrimaryKeyObj()
Returns the primary key of this model instance.
|
int |
getStatus()
Returns the status of this ddm structure version.
|
long |
getStatusByUserId()
Returns the status by user ID of this ddm structure version.
|
java.lang.String |
getStatusByUserName()
Returns the status by user name of this ddm structure version.
|
java.lang.String |
getStatusByUserUuid()
Returns the status by user uuid of this ddm structure version.
|
java.util.Date |
getStatusDate()
Returns the status date of this ddm structure version.
|
java.lang.String |
getStorageType()
Returns the storage type of this ddm structure version.
|
long |
getStructureId()
Returns the structure ID of this ddm structure version.
|
long |
getStructureVersionId()
Returns the structure version ID of this ddm structure version.
|
int |
getType()
Returns the type of this ddm structure version.
|
long |
getUserId()
Returns the user ID of this ddm structure version.
|
java.lang.String |
getUserName()
Returns the user name of this ddm structure version.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this ddm structure version.
|
java.lang.String |
getVersion()
Returns the version of this ddm structure version.
|
int |
hashCode() |
boolean |
isApproved()
Returns
true if this ddm structure version is approved. |
boolean |
isCachedModel()
Returns
true if this model instance was retrieved from the
entity cache. |
boolean |
isDenied()
Returns
true if this ddm structure version is denied. |
boolean |
isDraft()
Returns
true if this ddm structure version is a draft. |
boolean |
isEscapedModel()
Returns
true if this model instance is escaped. |
boolean |
isExpired()
Returns
true if this ddm structure version is expired. |
boolean |
isInactive()
Returns
true if this ddm structure version is inactive. |
boolean |
isIncomplete()
Returns
true if this ddm structure version is incomplete. |
boolean |
isNew()
Returns
true if this model instance does not yet exist in
the database. |
boolean |
isPending()
Returns
true if this ddm structure version is pending. |
boolean |
isScheduled()
Returns
true if this ddm structure version is scheduled. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setCachedModel(boolean cachedModel)
Sets whether this model instance was retrieved from the entity cache.
|
void |
setCompanyId(long companyId)
Sets the company ID of this ddm structure version.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this ddm structure version.
|
void |
setDefinition(java.lang.String definition)
Sets the definition of this ddm structure version.
|
void |
setDescription(java.lang.String description)
Sets the description of this ddm structure version.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets the localized description of this ddm structure version 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 version 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 version 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 version from the map of locales and localized descriptions, and sets the default locale.
|
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 ddm structure version.
|
void |
setName(java.lang.String name)
Sets the name of this ddm structure version.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Sets the localized name of this ddm structure version 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 version 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 version 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 version 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 ddm structure version.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this ddm structure version.
|
void |
setPrimaryKeyObj(java.io.Serializable primaryKeyObj)
Sets the primary key of this model instance.
|
void |
setStatus(int status)
Sets the status of this ddm structure version.
|
void |
setStatusByUserId(long statusByUserId)
Sets the status by user ID of this ddm structure version.
|
void |
setStatusByUserName(java.lang.String statusByUserName)
Sets the status by user name of this ddm structure version.
|
void |
setStatusByUserUuid(java.lang.String statusByUserUuid)
Sets the status by user uuid of this ddm structure version.
|
void |
setStatusDate(java.util.Date statusDate)
Sets the status date of this ddm structure version.
|
void |
setStorageType(java.lang.String storageType)
Sets the storage type of this ddm structure version.
|
void |
setStructureId(long structureId)
Sets the structure ID of this ddm structure version.
|
void |
setStructureVersionId(long structureVersionId)
Sets the structure version ID of this ddm structure version.
|
void |
setType(int type)
Sets the type of this ddm structure version.
|
void |
setUserId(long userId)
Sets the user ID of this ddm structure version.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this ddm structure version.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this ddm structure version.
|
void |
setVersion(java.lang.String version)
Sets the version of this ddm structure version.
|
CacheModel<DDMStructureVersion> |
toCacheModel()
Returns a cache model object for this entity used by entity cache.
|
DDMStructureVersion |
toEscapedModel()
Returns a copy of this entity as an escaped model instance by wrapping it
with an
AutoEscapeBeanHandler . |
java.lang.String |
toString() |
DDMStructureVersion |
toUnescapedModel() |
java.lang.String |
toXmlString()
Returns the XML representation of this model instance.
|
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes
getModelClass, getModelClassName
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this ddm structure versionlong getStructureVersionId()
void setStructureVersionId(long structureVersionId)
structureVersionId
- the structure version ID of this ddm structure versionlong getGroupId()
void setGroupId(long groupId)
groupId
- the group ID of this ddm structure versionlong getCompanyId()
getCompanyId
in interface ShardedModel
void setCompanyId(long companyId)
setCompanyId
in interface ShardedModel
companyId
- the company ID of this ddm structure versionlong getUserId()
void setUserId(long userId)
userId
- the user ID of this ddm structure versionjava.lang.String getUserUuid()
void setUserUuid(java.lang.String userUuid)
userUuid
- the user uuid of this ddm structure version@AutoEscape java.lang.String getUserName()
void setUserName(java.lang.String userName)
userName
- the user name of this ddm structure versionjava.util.Date getCreateDate()
void setCreateDate(java.util.Date createDate)
createDate
- the create date of this ddm structure versionlong getStructureId()
void setStructureId(long structureId)
structureId
- the structure ID of this ddm structure version@AutoEscape java.lang.String getVersion()
void setVersion(java.lang.String version)
version
- the version of this ddm structure versionlong getParentStructureId()
void setParentStructureId(long parentStructureId)
parentStructureId
- the parent structure ID of this ddm structure versionjava.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 structure versionvoid setName(java.lang.String name, java.util.Locale locale)
name
- the localized name of this ddm structure versionlocale
- 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 structure versionlocale
- 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 structure versionvoid setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Locale defaultLocale)
nameMap
- the locales and localized names of this ddm structure versiondefaultLocale
- 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 structure versionvoid setDescription(java.lang.String description, java.util.Locale locale)
description
- the localized description of this ddm structure versionlocale
- 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 structure versionlocale
- 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 structure versionvoid setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Locale defaultLocale)
descriptionMap
- the locales and localized descriptions of this ddm structure versiondefaultLocale
- the default locale@AutoEscape java.lang.String getDefinition()
void setDefinition(java.lang.String definition)
definition
- the definition of this ddm structure version@AutoEscape java.lang.String getStorageType()
void setStorageType(java.lang.String storageType)
storageType
- the storage type of this ddm structure versionint getType()
void setType(int type)
type
- the type of this ddm structure versionint getStatus()
getStatus
in interface WorkflowedModel
void setStatus(int status)
setStatus
in interface WorkflowedModel
status
- the status of this ddm structure versionlong getStatusByUserId()
getStatusByUserId
in interface WorkflowedModel
void setStatusByUserId(long statusByUserId)
setStatusByUserId
in interface WorkflowedModel
statusByUserId
- the status by user ID of this ddm structure versionjava.lang.String getStatusByUserUuid()
getStatusByUserUuid
in interface WorkflowedModel
void setStatusByUserUuid(java.lang.String statusByUserUuid)
setStatusByUserUuid
in interface WorkflowedModel
statusByUserUuid
- the status by user uuid of this ddm structure version@AutoEscape java.lang.String getStatusByUserName()
getStatusByUserName
in interface WorkflowedModel
void setStatusByUserName(java.lang.String statusByUserName)
setStatusByUserName
in interface WorkflowedModel
statusByUserName
- the status by user name of this ddm structure versionjava.util.Date getStatusDate()
getStatusDate
in interface WorkflowedModel
void setStatusDate(java.util.Date statusDate)
setStatusDate
in interface WorkflowedModel
statusDate
- the status date of this ddm structure versionboolean isApproved()
true
if this ddm structure version is approved.isApproved
in interface WorkflowedModel
true
if this ddm structure version is approved; false
otherwiseboolean isDenied()
true
if this ddm structure version is denied.isDenied
in interface WorkflowedModel
true
if this ddm structure version is denied; false
otherwiseboolean isDraft()
true
if this ddm structure version is a draft.isDraft
in interface WorkflowedModel
true
if this ddm structure version is a draft; false
otherwiseboolean isExpired()
true
if this ddm structure version is expired.isExpired
in interface WorkflowedModel
true
if this ddm structure version is expired; false
otherwiseboolean isInactive()
true
if this ddm structure version is inactive.isInactive
in interface WorkflowedModel
true
if this ddm structure version is inactive; false
otherwiseboolean isIncomplete()
true
if this ddm structure version is incomplete.isIncomplete
in interface WorkflowedModel
true
if this ddm structure version is incomplete; false
otherwiseboolean isPending()
true
if this ddm structure version is pending.isPending
in interface WorkflowedModel
true
if this ddm structure version is pending; false
otherwiseboolean isScheduled()
true
if this ddm structure version is scheduled.isScheduled
in interface WorkflowedModel
true
if this ddm structure version is scheduled; false
otherwiseboolean isNew()
BaseModel
true
if this model instance does not yet exist in
the database.isNew
in interface BaseModel<DDMStructureVersion>
true
if this model instance does not yet exist in
the database; false
otherwisevoid setNew(boolean n)
BaseModel
setNew
in interface BaseModel<DDMStructureVersion>
n
- whether this model instance does not yet exist in the databaseboolean isCachedModel()
BaseModel
true
if this model instance was retrieved from the
entity cache.isCachedModel
in interface BaseModel<DDMStructureVersion>
true
if this model instance was retrieved from the
entity cache; false
otherwiseBaseModel.setCachedModel(boolean)
void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel
in interface BaseModel<DDMStructureVersion>
cachedModel
- whether this model instance was retrieved from the
entity cacheEntityCache
boolean isEscapedModel()
BaseModel
true
if this model instance is escaped.isEscapedModel
in interface BaseModel<DDMStructureVersion>
true
if this model instance is escaped;
false
otherwisejava.io.Serializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj
in interface BaseModel<DDMStructureVersion>
getPrimaryKeyObj
in interface ClassedModel
void setPrimaryKeyObj(java.io.Serializable primaryKeyObj)
BaseModel
setPrimaryKeyObj
in interface BaseModel<DDMStructureVersion>
setPrimaryKeyObj
in interface ClassedModel
primaryKeyObj
- the primary key of this model instanceExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge
in interface BaseModel<DDMStructureVersion>
getExpandoBridge
in interface ClassedModel
void setExpandoBridgeAttributes(BaseModel<?> baseModel)
setExpandoBridgeAttributes
in interface BaseModel<DDMStructureVersion>
void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
setExpandoBridgeAttributes
in interface BaseModel<DDMStructureVersion>
void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes
in interface BaseModel<DDMStructureVersion>
serviceContext
- the service context to be appliedServiceContext.getExpandoBridgeAttributes()
java.lang.String[] getAvailableLanguageIds()
getAvailableLanguageIds
in interface LocalizedModel
java.lang.String getDefaultLanguageId()
getDefaultLanguageId
in interface LocalizedModel
void prepareLocalizedFieldsForImport() throws LocaleException
prepareLocalizedFieldsForImport
in interface LocalizedModel
LocaleException
void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) throws LocaleException
prepareLocalizedFieldsForImport
in interface LocalizedModel
LocaleException
java.lang.Object clone()
BaseModel
clone
in interface BaseModel<DDMStructureVersion>
int compareTo(DDMStructureVersion ddmStructureVersion)
compareTo
in interface java.lang.Comparable<DDMStructureVersion>
int hashCode()
hashCode
in class java.lang.Object
CacheModel<DDMStructureVersion> toCacheModel()
BaseModel
toCacheModel
in interface BaseModel<DDMStructureVersion>
DDMStructureVersion toEscapedModel()
BaseModel
AutoEscapeBeanHandler
.toEscapedModel
in interface BaseModel<DDMStructureVersion>
AutoEscapeBeanHandler
DDMStructureVersion toUnescapedModel()
toUnescapedModel
in interface BaseModel<DDMStructureVersion>
java.lang.String toString()
toString
in class java.lang.Object
java.lang.String toXmlString()
BaseModel
toXmlString
in interface BaseModel<DDMStructureVersion>