Interface DDMStructureVersionModel
- All Superinterfaces:
com.liferay.portal.kernel.model.BaseModel<DDMStructureVersion>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<DDMStructureVersion>
,com.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructureVersion>
,com.liferay.portal.kernel.model.LocalizedModel
,com.liferay.portal.kernel.model.MVCCModel
,Serializable
,com.liferay.portal.kernel.model.ShardedModel
,com.liferay.portal.kernel.model.WorkflowedModel
- All Known Subinterfaces:
DDMStructureVersion
- All Known Implementing Classes:
DDMStructureVersionWrapper
@ProviderType
public interface DDMStructureVersionModel
extends com.liferay.portal.kernel.model.BaseModel<DDMStructureVersion>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructureVersion>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.WorkflowedModel
The base model interface for the DDMStructureVersion service. Represents a row in the "DDMStructureVersion" database table, with each column mapped to a property of this class.
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
.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]
long
Returns the company ID of this ddm structure version.Returns the create date of this ddm structure version.long
Returns the ct collection ID of this ddm structure version.Returns the definition of this ddm structure version.Returns the description of this ddm structure version.getDescription
(String languageId) Returns the localized description of this ddm structure version in the language.getDescription
(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.getDescription
(Locale locale) Returns the localized description of this ddm structure version in the language.getDescription
(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.Returns a map of the locales and localized descriptions of this ddm structure version.long
Returns the group ID of this ddm structure version.long
Returns the mvcc version of this ddm structure version.getName()
Returns the name of this ddm structure version.Returns the localized name of this ddm structure version in the language.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.Returns the localized name of this ddm structure version in the language.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.Returns a map of the locales and localized names of this ddm structure version.long
Returns the parent structure ID of this ddm structure version.long
Returns the primary key of this ddm structure version.int
Returns the status of this ddm structure version.long
Returns the status by user ID of this ddm structure version.Returns the status by user name of this ddm structure version.Returns the status by user uuid of this ddm structure version.Returns the status date of this ddm structure version.Returns the storage type of this ddm structure version.long
Returns the structure ID of this ddm structure version.long
Returns the structure version ID of this ddm structure version.int
getType()
Returns the type of this ddm structure version.long
Returns the user ID of this ddm structure version.Returns the user name of this ddm structure version.Returns the user uuid of this ddm structure version.Returns the version of this ddm structure version.boolean
Returnstrue
if this ddm structure version is approved.boolean
isDenied()
Returnstrue
if this ddm structure version is denied.boolean
isDraft()
Returnstrue
if this ddm structure version is a draft.boolean
Returnstrue
if this ddm structure version is expired.boolean
Returnstrue
if this ddm structure version is inactive.boolean
Returnstrue
if this ddm structure version is incomplete.boolean
Returnstrue
if this ddm structure version is pending.boolean
Returnstrue
if this ddm structure version is scheduled.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setCompanyId
(long companyId) Sets the company ID of this ddm structure version.void
setCreateDate
(Date createDate) Sets the create date of this ddm structure version.void
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID of this ddm structure version.void
setDefinition
(String definition) Sets the definition of this ddm structure version.void
setDescription
(String description) Sets the description of this ddm structure version.void
setDescription
(String description, Locale locale) Sets the localized description of this ddm structure version in the language.void
setDescription
(String description, Locale locale, Locale defaultLocale) Sets the localized description of this ddm structure version in the language, and sets the default locale.void
setDescriptionCurrentLanguageId
(String languageId) void
setDescriptionMap
(Map<Locale, String> descriptionMap) Sets the localized descriptions of this ddm structure version from the map of locales and localized descriptions.void
setDescriptionMap
(Map<Locale, String> descriptionMap, 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
setGroupId
(long groupId) Sets the group ID of this ddm structure version.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this ddm structure version.void
Sets the name of this ddm structure version.void
Sets the localized name of this ddm structure version in the language.void
Sets the localized name of this ddm structure version in the language, and sets the default locale.void
setNameCurrentLanguageId
(String languageId) void
setNameMap
(Map<Locale, String> nameMap) Sets the localized names of this ddm structure version from the map of locales and localized names.void
setNameMap
(Map<Locale, String> nameMap, 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
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
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
(String statusByUserName) Sets the status by user name of this ddm structure version.void
setStatusByUserUuid
(String statusByUserUuid) Sets the status by user uuid of this ddm structure version.void
setStatusDate
(Date statusDate) Sets the status date of this ddm structure version.void
setStorageType
(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
(String userName) Sets the user name of this ddm structure version.void
setUserUuid
(String userUuid) Sets the user uuid of this ddm structure version.void
setVersion
(String version) Sets the version of this ddm structure version.default String
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this ddm structure version.- Specified by:
getPrimaryKey
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructureVersion>
- Returns:
- the primary key of this ddm structure version
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this ddm structure version.- Specified by:
setPrimaryKey
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructureVersion>
- Parameters:
primaryKey
- the primary key of this ddm structure version
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this ddm structure version.- Specified by:
getMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Returns:
- the mvcc version of this ddm structure version
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this ddm structure version.- Specified by:
setMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this ddm structure version
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this ddm structure version.- Specified by:
getCtCollectionId
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructureVersion>
- Returns:
- the ct collection ID of this ddm structure version
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this ddm structure version.- Specified by:
setCtCollectionId
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructureVersion>
- Parameters:
ctCollectionId
- the ct collection ID of this ddm structure version
-
getStructureVersionId
long getStructureVersionId()Returns the structure version ID of this ddm structure version.- Returns:
- the structure version ID of this ddm structure version
-
setStructureVersionId
void setStructureVersionId(long structureVersionId) Sets the structure version ID of this ddm structure version.- Parameters:
structureVersionId
- the structure version ID of this ddm structure version
-
getGroupId
long getGroupId()Returns the group ID of this ddm structure version.- Returns:
- the group ID of this ddm structure version
-
setGroupId
void setGroupId(long groupId) Sets the group ID of this ddm structure version.- Parameters:
groupId
- the group ID of this ddm structure version
-
getCompanyId
long getCompanyId()Returns the company ID of this ddm structure version.- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Returns:
- the company ID of this ddm structure version
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this ddm structure version.- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Parameters:
companyId
- the company ID of this ddm structure version
-
getUserId
long getUserId()Returns the user ID of this ddm structure version.- Returns:
- the user ID of this ddm structure version
-
setUserId
void setUserId(long userId) Sets the user ID of this ddm structure version.- Parameters:
userId
- the user ID of this ddm structure version
-
getUserUuid
String getUserUuid()Returns the user uuid of this ddm structure version.- Returns:
- the user uuid of this ddm structure version
-
setUserUuid
Sets the user uuid of this ddm structure version.- Parameters:
userUuid
- the user uuid of this ddm structure version
-
getUserName
Returns the user name of this ddm structure version.- Returns:
- the user name of this ddm structure version
-
setUserName
Sets the user name of this ddm structure version.- Parameters:
userName
- the user name of this ddm structure version
-
getCreateDate
Date getCreateDate()Returns the create date of this ddm structure version.- Returns:
- the create date of this ddm structure version
-
setCreateDate
Sets the create date of this ddm structure version.- Parameters:
createDate
- the create date of this ddm structure version
-
getStructureId
long getStructureId()Returns the structure ID of this ddm structure version.- Returns:
- the structure ID of this ddm structure version
-
setStructureId
void setStructureId(long structureId) Sets the structure ID of this ddm structure version.- Parameters:
structureId
- the structure ID of this ddm structure version
-
getVersion
Returns the version of this ddm structure version.- Returns:
- the version of this ddm structure version
-
setVersion
Sets the version of this ddm structure version.- Parameters:
version
- the version of this ddm structure version
-
getParentStructureId
long getParentStructureId()Returns the parent structure ID of this ddm structure version.- Returns:
- the parent structure ID of this ddm structure version
-
setParentStructureId
void setParentStructureId(long parentStructureId) Sets the parent structure ID of this ddm structure version.- Parameters:
parentStructureId
- the parent structure ID of this ddm structure version
-
getName
String getName()Returns the name of this ddm structure version.- Returns:
- the name of this ddm structure version
-
getName
Returns the localized name of this ddm structure version in the language. Uses the default language if no localization exists for the requested language.- Parameters:
locale
- the locale of the language- Returns:
- the localized name of this ddm structure version
-
getName
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.- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this ddm structure version. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getName
Returns the localized name of this ddm structure version in the language. Uses the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the language- Returns:
- the localized name of this ddm structure version
-
getName
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.- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this ddm structure version
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this ddm structure version.- Returns:
- the locales and localized names of this ddm structure version
-
setName
Sets the name of this ddm structure version.- Parameters:
name
- the name of this ddm structure version
-
setName
Sets the localized name of this ddm structure version in the language.- Parameters:
name
- the localized name of this ddm structure versionlocale
- the locale of the language
-
setName
Sets the localized name of this ddm structure version in the language, and sets the default locale.- Parameters:
name
- the localized name of this ddm structure versionlocale
- the locale of the languagedefaultLocale
- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this ddm structure version from the map of locales and localized names.- Parameters:
nameMap
- the locales and localized names of this ddm structure version
-
setNameMap
Sets the localized names of this ddm structure version from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap
- the locales and localized names of this ddm structure versiondefaultLocale
- the default locale
-
getDescription
String getDescription()Returns the description of this ddm structure version.- Returns:
- the description of this ddm structure version
-
getDescription
Returns the localized description of this ddm structure version in the language. Uses the default language if no localization exists for the requested language.- Parameters:
locale
- the locale of the language- Returns:
- the localized description of this ddm structure version
-
getDescription
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.- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this ddm structure version. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getDescription
Returns the localized description of this ddm structure version in the language. Uses the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the language- Returns:
- the localized description of this ddm structure version
-
getDescription
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.- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this ddm structure version
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this ddm structure version.- Returns:
- the locales and localized descriptions of this ddm structure version
-
setDescription
Sets the description of this ddm structure version.- Parameters:
description
- the description of this ddm structure version
-
setDescription
Sets the localized description of this ddm structure version in the language.- Parameters:
description
- the localized description of this ddm structure versionlocale
- the locale of the language
-
setDescription
Sets the localized description of this ddm structure version in the language, and sets the default locale.- Parameters:
description
- the localized description of this ddm structure versionlocale
- the locale of the languagedefaultLocale
- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this ddm structure version from the map of locales and localized descriptions.- Parameters:
descriptionMap
- the locales and localized descriptions of this ddm structure version
-
setDescriptionMap
Sets the localized descriptions of this ddm structure version from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap
- the locales and localized descriptions of this ddm structure versiondefaultLocale
- the default locale
-
getDefinition
Returns the definition of this ddm structure version.- Returns:
- the definition of this ddm structure version
-
setDefinition
Sets the definition of this ddm structure version.- Parameters:
definition
- the definition of this ddm structure version
-
getStorageType
Returns the storage type of this ddm structure version.- Returns:
- the storage type of this ddm structure version
-
setStorageType
Sets the storage type of this ddm structure version.- Parameters:
storageType
- the storage type of this ddm structure version
-
getType
int getType()Returns the type of this ddm structure version.- Returns:
- the type of this ddm structure version
-
setType
void setType(int type) Sets the type of this ddm structure version.- Parameters:
type
- the type of this ddm structure version
-
getStatus
int getStatus()Returns the status of this ddm structure version.- Specified by:
getStatus
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
- the status of this ddm structure version
-
setStatus
void setStatus(int status) Sets the status of this ddm structure version.- Specified by:
setStatus
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Parameters:
status
- the status of this ddm structure version
-
getStatusByUserId
long getStatusByUserId()Returns the status by user ID of this ddm structure version.- Specified by:
getStatusByUserId
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
- the status by user ID of this ddm structure version
-
setStatusByUserId
void setStatusByUserId(long statusByUserId) Sets the status by user ID of this ddm structure version.- Specified by:
setStatusByUserId
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Parameters:
statusByUserId
- the status by user ID of this ddm structure version
-
getStatusByUserUuid
String getStatusByUserUuid()Returns the status by user uuid of this ddm structure version.- Specified by:
getStatusByUserUuid
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
- the status by user uuid of this ddm structure version
-
setStatusByUserUuid
Sets the status by user uuid of this ddm structure version.- Specified by:
setStatusByUserUuid
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Parameters:
statusByUserUuid
- the status by user uuid of this ddm structure version
-
getStatusByUserName
Returns the status by user name of this ddm structure version.- Specified by:
getStatusByUserName
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
- the status by user name of this ddm structure version
-
setStatusByUserName
Sets the status by user name of this ddm structure version.- Specified by:
setStatusByUserName
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Parameters:
statusByUserName
- the status by user name of this ddm structure version
-
getStatusDate
Date getStatusDate()Returns the status date of this ddm structure version.- Specified by:
getStatusDate
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
- the status date of this ddm structure version
-
setStatusDate
Sets the status date of this ddm structure version.- Specified by:
setStatusDate
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Parameters:
statusDate
- the status date of this ddm structure version
-
isApproved
boolean isApproved()Returnstrue
if this ddm structure version is approved.- Specified by:
isApproved
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this ddm structure version is approved;false
otherwise
-
isDenied
boolean isDenied()Returnstrue
if this ddm structure version is denied.- Specified by:
isDenied
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this ddm structure version is denied;false
otherwise
-
isDraft
boolean isDraft()Returnstrue
if this ddm structure version is a draft.- Specified by:
isDraft
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this ddm structure version is a draft;false
otherwise
-
isExpired
boolean isExpired()Returnstrue
if this ddm structure version is expired.- Specified by:
isExpired
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this ddm structure version is expired;false
otherwise
-
isInactive
boolean isInactive()Returnstrue
if this ddm structure version is inactive.- Specified by:
isInactive
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this ddm structure version is inactive;false
otherwise
-
isIncomplete
boolean isIncomplete()Returnstrue
if this ddm structure version is incomplete.- Specified by:
isIncomplete
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this ddm structure version is incomplete;false
otherwise
-
isPending
boolean isPending()Returnstrue
if this ddm structure version is pending.- Specified by:
isPending
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this ddm structure version is pending;false
otherwise
-
isScheduled
boolean isScheduled()Returnstrue
if this ddm structure version is scheduled.- Specified by:
isScheduled
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this ddm structure version is scheduled;false
otherwise
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIds
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageId
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException - Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
DDMStructureVersion cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<DDMStructureVersion>
-
toXmlString
-