@ProviderType public interface SegmentsEntryModel extends com.liferay.portal.kernel.model.BaseModel<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
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
.
SegmentsEntry
Modifier and Type | Method and Description |
---|---|
boolean |
getActive()
Returns the active of this segments entry.
|
java.lang.String[] |
getAvailableLanguageIds() |
long |
getCompanyId()
Returns the company ID of this segments entry.
|
java.util.Date |
getCreateDate()
Returns the create date of this segments entry.
|
java.lang.String |
getCriteria()
Returns the criteria of this segments entry.
|
java.lang.String |
getDefaultLanguageId() |
java.lang.String |
getDescription()
Returns the description of this segments entry.
|
java.lang.String |
getDescription(java.util.Locale locale)
Returns the localized description of this segments entry in the language.
|
java.lang.String |
getDescription(java.util.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.
|
java.lang.String |
getDescription(java.lang.String languageId)
Returns the localized description of this segments entry in the language.
|
java.lang.String |
getDescription(java.lang.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.
|
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 segments entry.
|
long |
getGroupId()
Returns the group ID of this segments entry.
|
java.util.Date |
getLastPublishDate()
Returns the last publish date of this segments entry.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this segments entry.
|
long |
getMvccVersion()
Returns the mvcc version of this segments entry.
|
java.lang.String |
getName()
Returns the name of this segments entry.
|
java.lang.String |
getName(java.util.Locale locale)
Returns the localized name of this segments entry in the language.
|
java.lang.String |
getName(java.util.Locale locale,
boolean useDefault)
Returns the localized name of this segments entry 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 segments entry in the language.
|
java.lang.String |
getName(java.lang.String languageId,
boolean useDefault)
Returns the localized name of this segments entry 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 segments entry.
|
long |
getPrimaryKey()
Returns the primary key of this segments entry.
|
long |
getSegmentsEntryId()
Returns the segments entry ID of this segments entry.
|
java.lang.String |
getSegmentsEntryKey()
Returns the segments entry key of this segments entry.
|
java.lang.String |
getSource()
Returns the source of this segments entry.
|
java.lang.String |
getType()
Returns the type of this segments entry.
|
long |
getUserId()
Returns the user ID of this segments entry.
|
java.lang.String |
getUserName()
Returns the user name of this segments entry.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this segments entry.
|
java.lang.String |
getUuid()
Returns the uuid of this segments entry.
|
boolean |
isActive()
Returns
true if this segments entry is active. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setActive(boolean active)
Sets whether this segments entry is active.
|
void |
setCompanyId(long companyId)
Sets the company ID of this segments entry.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this segments entry.
|
void |
setCriteria(java.lang.String criteria)
Sets the criteria of this segments entry.
|
void |
setDescription(java.lang.String description)
Sets the description of this segments entry.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets the localized description of this segments entry in the language.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized description of this segments entry 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 segments entry 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 segments entry from the map of locales and localized descriptions, and sets the default locale.
|
void |
setGroupId(long groupId)
Sets the group ID of this segments entry.
|
void |
setLastPublishDate(java.util.Date lastPublishDate)
Sets the last publish date of this segments entry.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this segments entry.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this segments entry.
|
void |
setName(java.lang.String name)
Sets the name of this segments entry.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Sets the localized name of this segments entry in the language.
|
void |
setName(java.lang.String name,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized name of this segments entry 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 segments entry 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 segments entry from the map of locales and localized names, and sets the default locale.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this segments entry.
|
void |
setSegmentsEntryId(long segmentsEntryId)
Sets the segments entry ID of this segments entry.
|
void |
setSegmentsEntryKey(java.lang.String segmentsEntryKey)
Sets the segments entry key of this segments entry.
|
void |
setSource(java.lang.String source)
Sets the source of this segments entry.
|
void |
setType(java.lang.String type)
Sets the type of this segments entry.
|
void |
setUserId(long userId)
Sets the user ID of this segments entry.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this segments entry.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this segments entry.
|
void |
setUuid(java.lang.String uuid)
Sets the uuid of this segments entry.
|
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this segments entrylong getMvccVersion()
getMvccVersion
in interface com.liferay.portal.kernel.model.MVCCModel
void setMvccVersion(long mvccVersion)
setMvccVersion
in interface com.liferay.portal.kernel.model.MVCCModel
mvccVersion
- the mvcc version of this segments entry@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 segments entrylong getSegmentsEntryId()
void setSegmentsEntryId(long segmentsEntryId)
segmentsEntryId
- the segments entry ID of this segments entrylong 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 segments entrylong 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 segments entrylong 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 segments entryjava.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 segments entry@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 segments entryjava.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 segments entryjava.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 segments entry@AutoEscape java.lang.String getSegmentsEntryKey()
void setSegmentsEntryKey(java.lang.String segmentsEntryKey)
segmentsEntryKey
- the segments entry key of this segments entryjava.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 segments entryvoid setName(java.lang.String name, java.util.Locale locale)
name
- the localized name of this segments entrylocale
- the locale of the languagevoid setName(java.lang.String name, java.util.Locale locale, java.util.Locale defaultLocale)
name
- the localized name of this segments entrylocale
- 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 segments entryvoid setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Locale defaultLocale)
nameMap
- the locales and localized names of this segments entrydefaultLocale
- 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 segments entryvoid setDescription(java.lang.String description, java.util.Locale locale)
description
- the localized description of this segments entrylocale
- the locale of the languagevoid setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale)
description
- the localized description of this segments entrylocale
- 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 segments entryvoid setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Locale defaultLocale)
descriptionMap
- the locales and localized descriptions of this segments entrydefaultLocale
- the default localeboolean getActive()
boolean isActive()
true
if this segments entry is active.true
if this segments entry is active; false
otherwisevoid setActive(boolean active)
active
- the active of this segments entry@AutoEscape java.lang.String getCriteria()
void setCriteria(java.lang.String criteria)
criteria
- the criteria of this segments entry@AutoEscape java.lang.String getSource()
void setSource(java.lang.String source)
source
- the source of this segments entry@AutoEscape java.lang.String getType()
void setType(java.lang.String type)
type
- the type of this segments entryjava.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 segments entryjava.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