Package com.liferay.list.type.model
Interface ListTypeDefinitionModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel
,com.liferay.portal.kernel.model.BaseModel<ListTypeDefinition>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<ListTypeDefinition>
,com.liferay.portal.kernel.model.ExternalReferenceCodeModel
,com.liferay.portal.kernel.model.LocalizedModel
,com.liferay.portal.kernel.model.MVCCModel
,Serializable
,com.liferay.portal.kernel.model.ShardedModel
,com.liferay.portal.kernel.model.StagedAuditedModel
,com.liferay.portal.kernel.model.StagedModel
- All Known Subinterfaces:
ListTypeDefinition
- All Known Implementing Classes:
ListTypeDefinitionWrapper
@ProviderType
public interface ListTypeDefinitionModel
extends com.liferay.portal.kernel.model.BaseModel<ListTypeDefinition>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel
The base model interface for the ListTypeDefinition service. Represents a row in the "ListTypeDefinition" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation com.liferay.list.type.model.impl.ListTypeDefinitionModelImpl
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.list.type.model.impl.ListTypeDefinitionImpl
.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]
long
Returns the company ID of this list type definition.Returns the create date of this list type definition.Returns the external reference code of this list type definition.long
Returns the list type definition ID of this list type definition.Returns the modified date of this list type definition.long
Returns the mvcc version of this list type definition.getName()
Returns the name of this list type definition.Returns the localized name of this list type definition in the language.Returns the localized name of this list type definition in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this list type definition in the language.Returns the localized name of this list type definition 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 list type definition.long
Returns the primary key of this list type definition.boolean
Returns the system of this list type definition.long
Returns the user ID of this list type definition.Returns the user name of this list type definition.Returns the user uuid of this list type definition.getUuid()
Returns the uuid of this list type definition.boolean
isSystem()
Returnstrue
if this list type definition is system.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setCompanyId
(long companyId) Sets the company ID of this list type definition.void
setCreateDate
(Date createDate) Sets the create date of this list type definition.void
setExternalReferenceCode
(String externalReferenceCode) Sets the external reference code of this list type definition.void
setListTypeDefinitionId
(long listTypeDefinitionId) Sets the list type definition ID of this list type definition.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this list type definition.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this list type definition.void
Sets the name of this list type definition.void
Sets the localized name of this list type definition in the language.void
Sets the localized name of this list type definition in the language, and sets the default locale.void
setNameCurrentLanguageId
(String languageId) void
setNameMap
(Map<Locale, String> nameMap) Sets the localized names of this list type definition from the map of locales and localized names.void
setNameMap
(Map<Locale, String> nameMap, Locale defaultLocale) Sets the localized names of this list type definition from the map of locales and localized names, and sets the default locale.void
setPrimaryKey
(long primaryKey) Sets the primary key of this list type definition.void
setSystem
(boolean system) Sets whether this list type definition is system.void
setUserId
(long userId) Sets the user ID of this list type definition.void
setUserName
(String userName) Sets the user name of this list type definition.void
setUserUuid
(String userUuid) Sets the user uuid of this list type definition.void
Sets the uuid of this list type definition.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
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this list type definition.- Returns:
- the primary key of this list type definition
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this list type definition.- Parameters:
primaryKey
- the primary key of this list type definition
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this list type definition.- Specified by:
getMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Returns:
- the mvcc version of this list type definition
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this list type definition.- Specified by:
setMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this list type definition
-
getUuid
Returns the uuid of this list type definition.- Specified by:
getUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the uuid of this list type definition
-
setUuid
Sets the uuid of this list type definition.- Specified by:
setUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
uuid
- the uuid of this list type definition
-
getExternalReferenceCode
Returns the external reference code of this list type definition.- Specified by:
getExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- Returns:
- the external reference code of this list type definition
-
setExternalReferenceCode
Sets the external reference code of this list type definition.- Specified by:
setExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- Parameters:
externalReferenceCode
- the external reference code of this list type definition
-
getListTypeDefinitionId
long getListTypeDefinitionId()Returns the list type definition ID of this list type definition.- Returns:
- the list type definition ID of this list type definition
-
setListTypeDefinitionId
void setListTypeDefinitionId(long listTypeDefinitionId) Sets the list type definition ID of this list type definition.- Parameters:
listTypeDefinitionId
- the list type definition ID of this list type definition
-
getCompanyId
long getCompanyId()Returns the company ID of this list type definition.- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the company ID of this list type definition
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this list type definition.- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
companyId
- the company ID of this list type definition
-
getUserId
long getUserId()Returns the user ID of this list type definition.- Specified by:
getUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user ID of this list type definition
-
setUserId
void setUserId(long userId) Sets the user ID of this list type definition.- Specified by:
setUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userId
- the user ID of this list type definition
-
getUserUuid
String getUserUuid()Returns the user uuid of this list type definition.- Specified by:
getUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user uuid of this list type definition
-
setUserUuid
Sets the user uuid of this list type definition.- Specified by:
setUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userUuid
- the user uuid of this list type definition
-
getUserName
Returns the user name of this list type definition.- Specified by:
getUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user name of this list type definition
-
setUserName
Sets the user name of this list type definition.- Specified by:
setUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userName
- the user name of this list type definition
-
getCreateDate
Date getCreateDate()Returns the create date of this list type definition.- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the create date of this list type definition
-
setCreateDate
Sets the create date of this list type definition.- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
createDate
- the create date of this list type definition
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this list type definition.- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the modified date of this list type definition
-
setModifiedDate
Sets the modified date of this list type definition.- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
modifiedDate
- the modified date of this list type definition
-
getName
String getName()Returns the name of this list type definition.- Returns:
- the name of this list type definition
-
getName
Returns the localized name of this list type definition 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 list type definition
-
getName
Returns the localized name of this list type definition 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 list type definition. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getName
Returns the localized name of this list type definition 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 list type definition
-
getName
Returns the localized name of this list type definition 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 list type definition
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this list type definition.- Returns:
- the locales and localized names of this list type definition
-
setName
Sets the name of this list type definition.- Parameters:
name
- the name of this list type definition
-
setName
Sets the localized name of this list type definition in the language.- Parameters:
name
- the localized name of this list type definitionlocale
- the locale of the language
-
setName
Sets the localized name of this list type definition in the language, and sets the default locale.- Parameters:
name
- the localized name of this list type definitionlocale
- the locale of the languagedefaultLocale
- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this list type definition from the map of locales and localized names.- Parameters:
nameMap
- the locales and localized names of this list type definition
-
setNameMap
Sets the localized names of this list type definition from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap
- the locales and localized names of this list type definitiondefaultLocale
- the default locale
-
getSystem
boolean getSystem()Returns the system of this list type definition.- Returns:
- the system of this list type definition
-
isSystem
boolean isSystem()Returnstrue
if this list type definition is system.- Returns:
true
if this list type definition is system;false
otherwise
-
setSystem
void setSystem(boolean system) Sets whether this list type definition is system.- Parameters:
system
- the system of this list type definition
-
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
ListTypeDefinition cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<ListTypeDefinition>
-
toXmlString
-