Package com.liferay.segments.model
Interface SegmentsEntryModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel,com.liferay.portal.kernel.model.BaseModel<SegmentsEntry>,com.liferay.portal.kernel.model.ClassedModel,Cloneable,Comparable<SegmentsEntry>,com.liferay.portal.kernel.model.change.tracking.CTModel<SegmentsEntry>,com.liferay.portal.kernel.model.GroupedModel,com.liferay.portal.kernel.model.LocalizedModel,com.liferay.portal.kernel.model.MVCCModel,Serializable,com.liferay.portal.kernel.model.ShardedModel,com.liferay.portal.kernel.model.StagedGroupedModel,com.liferay.portal.kernel.model.StagedModel
- All Known Subinterfaces:
SegmentsEntry
- All Known Implementing Classes:
SegmentsEntryWrapper
@ProviderType
public interface SegmentsEntryModel
extends com.liferay.portal.kernel.model.BaseModel<SegmentsEntry>, com.liferay.portal.kernel.model.change.tracking.CTModel<SegmentsEntry>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel
The base model interface for the SegmentsEntry service. Represents a row in the "SegmentsEntry" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation com.liferay.segments.model.impl.SegmentsEntryModelImpl 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.segments.model.impl.SegmentsEntryImpl.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns the active of this segments entry.String[]longReturns the company ID of this segments entry.Returns the create date of this segments entry.Returns the criteria of this segments entry.longReturns the ct collection ID of this segments entry.Returns the description of this segments entry.getDescription(String languageId) Returns the localized description of this segments entry in the language.getDescription(String languageId, boolean useDefault) Returns the localized description of this segments entry 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 segments entry in the language.getDescription(Locale locale, boolean useDefault) Returns the localized description of this segments entry 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 segments entry.longReturns the group ID of this segments entry.Returns the last publish date of this segments entry.Returns the modified date of this segments entry.longReturns the mvcc version of this segments entry.getName()Returns the name of this segments entry.Returns the localized name of this segments entry in the language.Returns the localized name of this segments entry in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this segments entry in the language.Returns the localized name of this segments entry 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 segments entry.longReturns the primary key of this segments entry.longReturns the segments entry ID of this segments entry.Returns the segments entry key of this segments entry.Returns the source of this segments entry.longReturns the user ID of this segments entry.Returns the user name of this segments entry.Returns the user uuid of this segments entry.getUuid()Returns the uuid of this segments entry.booleanisActive()Returnstrueif this segments entry is active.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidsetActive(boolean active) Sets whether this segments entry is active.voidsetCompanyId(long companyId) Sets the company ID of this segments entry.voidsetCreateDate(Date createDate) Sets the create date of this segments entry.voidsetCriteria(String criteria) Sets the criteria of this segments entry.voidsetCtCollectionId(long ctCollectionId) Sets the ct collection ID of this segments entry.voidsetDescription(String description) Sets the description of this segments entry.voidsetDescription(String description, Locale locale) Sets the localized description of this segments entry in the language.voidsetDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this segments entry in the language, and sets the default locale.voidsetDescriptionCurrentLanguageId(String languageId) voidsetDescriptionMap(Map<Locale, String> descriptionMap) Sets the localized descriptions of this segments entry from the map of locales and localized descriptions.voidsetDescriptionMap(Map<Locale, String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this segments entry from the map of locales and localized descriptions, and sets the default locale.voidsetGroupId(long groupId) Sets the group ID of this segments entry.voidsetLastPublishDate(Date lastPublishDate) Sets the last publish date of this segments entry.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this segments entry.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this segments entry.voidSets the name of this segments entry.voidSets the localized name of this segments entry in the language.voidSets the localized name of this segments entry in the language, and sets the default locale.voidsetNameCurrentLanguageId(String languageId) voidsetNameMap(Map<Locale, String> nameMap) Sets the localized names of this segments entry from the map of locales and localized names.voidsetNameMap(Map<Locale, String> nameMap, Locale defaultLocale) Sets the localized names of this segments entry from the map of locales and localized names, and sets the default locale.voidsetPrimaryKey(long primaryKey) Sets the primary key of this segments entry.voidsetSegmentsEntryId(long segmentsEntryId) Sets the segments entry ID of this segments entry.voidsetSegmentsEntryKey(String segmentsEntryKey) Sets the segments entry key of this segments entry.voidSets the source of this segments entry.voidsetUserId(long userId) Sets the user ID of this segments entry.voidsetUserName(String userName) Sets the user name of this segments entry.voidsetUserUuid(String userUuid) Sets the user uuid of this segments entry.voidSets the uuid of this segments entry.default StringMethods 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, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this segments entry.- Specified by:
getPrimaryKeyin interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<SegmentsEntry>- Returns:
- the primary key of this segments entry
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this segments entry.- Specified by:
setPrimaryKeyin interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<SegmentsEntry>- Parameters:
primaryKey- the primary key of this segments entry
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this segments entry.- Specified by:
getMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Returns:
- the mvcc version of this segments entry
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this segments entry.- Specified by:
setMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Parameters:
mvccVersion- the mvcc version of this segments entry
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this segments entry.- Specified by:
getCtCollectionIdin interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<SegmentsEntry>- Returns:
- the ct collection ID of this segments entry
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this segments entry.- Specified by:
setCtCollectionIdin interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<SegmentsEntry>- Parameters:
ctCollectionId- the ct collection ID of this segments entry
-
getUuid
Returns the uuid of this segments entry.- Specified by:
getUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the uuid of this segments entry
-
setUuid
Sets the uuid of this segments entry.- Specified by:
setUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
uuid- the uuid of this segments entry
-
getSegmentsEntryId
long getSegmentsEntryId()Returns the segments entry ID of this segments entry.- Returns:
- the segments entry ID of this segments entry
-
setSegmentsEntryId
void setSegmentsEntryId(long segmentsEntryId) Sets the segments entry ID of this segments entry.- Parameters:
segmentsEntryId- the segments entry ID of this segments entry
-
getGroupId
long getGroupId()Returns the group ID of this segments entry.- Specified by:
getGroupIdin interfacecom.liferay.portal.kernel.model.GroupedModel- Returns:
- the group ID of this segments entry
-
setGroupId
void setGroupId(long groupId) Sets the group ID of this segments entry.- Specified by:
setGroupIdin interfacecom.liferay.portal.kernel.model.GroupedModel- Parameters:
groupId- the group ID of this segments entry
-
getCompanyId
long getCompanyId()Returns the company ID of this segments entry.- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.ShardedModel- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the company ID of this segments entry
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this segments entry.- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.ShardedModel- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
companyId- the company ID of this segments entry
-
getUserId
long getUserId()Returns the user ID of this segments entry.- Specified by:
getUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user ID of this segments entry
-
setUserId
void setUserId(long userId) Sets the user ID of this segments entry.- Specified by:
setUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userId- the user ID of this segments entry
-
getUserUuid
String getUserUuid()Returns the user uuid of this segments entry.- Specified by:
getUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user uuid of this segments entry
-
setUserUuid
Sets the user uuid of this segments entry.- Specified by:
setUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userUuid- the user uuid of this segments entry
-
getUserName
Returns the user name of this segments entry.- Specified by:
getUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user name of this segments entry
-
setUserName
Sets the user name of this segments entry.- Specified by:
setUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userName- the user name of this segments entry
-
getCreateDate
Date getCreateDate()Returns the create date of this segments entry.- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the create date of this segments entry
-
setCreateDate
Sets the create date of this segments entry.- Specified by:
setCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
createDate- the create date of this segments entry
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this segments entry.- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the modified date of this segments entry
-
setModifiedDate
Sets the modified date of this segments entry.- Specified by:
setModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
modifiedDate- the modified date of this segments entry
-
getSegmentsEntryKey
Returns the segments entry key of this segments entry.- Returns:
- the segments entry key of this segments entry
-
setSegmentsEntryKey
Sets the segments entry key of this segments entry.- Parameters:
segmentsEntryKey- the segments entry key of this segments entry
-
getName
String getName()Returns the name of this segments entry.- Returns:
- the name of this segments entry
-
getName
Returns the localized name of this segments entry 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 segments entry
-
getName
Returns the localized name of this segments entry 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 segments entry. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getName
Returns the localized name of this segments entry 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 segments entry
-
getName
Returns the localized name of this segments entry 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 segments entry
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this segments entry.- Returns:
- the locales and localized names of this segments entry
-
setName
Sets the name of this segments entry.- Parameters:
name- the name of this segments entry
-
setName
Sets the localized name of this segments entry in the language.- Parameters:
name- the localized name of this segments entrylocale- the locale of the language
-
setName
Sets the localized name of this segments entry in the language, and sets the default locale.- Parameters:
name- the localized name of this segments entrylocale- the locale of the languagedefaultLocale- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this segments entry from the map of locales and localized names.- Parameters:
nameMap- the locales and localized names of this segments entry
-
setNameMap
Sets the localized names of this segments entry from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap- the locales and localized names of this segments entrydefaultLocale- the default locale
-
getDescription
String getDescription()Returns the description of this segments entry.- Returns:
- the description of this segments entry
-
getDescription
Returns the localized description of this segments entry 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 segments entry
-
getDescription
Returns the localized description of this segments entry 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 segments entry. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getDescription
Returns the localized description of this segments entry 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 segments entry
-
getDescription
Returns the localized description of this segments entry 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 segments entry
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this segments entry.- Returns:
- the locales and localized descriptions of this segments entry
-
setDescription
Sets the description of this segments entry.- Parameters:
description- the description of this segments entry
-
setDescription
Sets the localized description of this segments entry in the language.- Parameters:
description- the localized description of this segments entrylocale- the locale of the language
-
setDescription
Sets the localized description of this segments entry in the language, and sets the default locale.- Parameters:
description- the localized description of this segments entrylocale- the locale of the languagedefaultLocale- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this segments entry from the map of locales and localized descriptions.- Parameters:
descriptionMap- the locales and localized descriptions of this segments entry
-
setDescriptionMap
Sets the localized descriptions of this segments entry from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap- the locales and localized descriptions of this segments entrydefaultLocale- the default locale
-
getActive
boolean getActive()Returns the active of this segments entry.- Returns:
- the active of this segments entry
-
isActive
boolean isActive()Returnstrueif this segments entry is active.- Returns:
trueif this segments entry is active;falseotherwise
-
setActive
void setActive(boolean active) Sets whether this segments entry is active.- Parameters:
active- the active of this segments entry
-
getCriteria
Returns the criteria of this segments entry.- Returns:
- the criteria of this segments entry
-
setCriteria
Sets the criteria of this segments entry.- Parameters:
criteria- the criteria of this segments entry
-
getSource
Returns the source of this segments entry.- Returns:
- the source of this segments entry
-
setSource
Sets the source of this segments entry.- Parameters:
source- the source of this segments entry
-
getLastPublishDate
Date getLastPublishDate()Returns the last publish date of this segments entry.- Specified by:
getLastPublishDatein interfacecom.liferay.portal.kernel.model.StagedGroupedModel- Returns:
- the last publish date of this segments entry
-
setLastPublishDate
Sets the last publish date of this segments entry.- Specified by:
setLastPublishDatein interfacecom.liferay.portal.kernel.model.StagedGroupedModel- Parameters:
lastPublishDate- the last publish date of this segments entry
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIdsin interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageIdin interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImportin 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:
prepareLocalizedFieldsForImportin interfacecom.liferay.portal.kernel.model.LocalizedModel- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
SegmentsEntry cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfacecom.liferay.portal.kernel.model.BaseModel<SegmentsEntry>
-
toXmlString
-