Interface SXPElementModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel,com.liferay.portal.kernel.model.BaseModel<SXPElement>,com.liferay.portal.kernel.model.ClassedModel,Cloneable,Comparable<SXPElement>,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:
SXPElement
- All Known Implementing Classes:
SXPElementWrapper
@ProviderType
public interface SXPElementModel
extends com.liferay.portal.kernel.model.BaseModel<SXPElement>, 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 SXPElement service. Represents a row in the "SXPElement" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation com.liferay.search.experiences.model.impl.SXPElementModelImpl 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.search.experiences.model.impl.SXPElementImpl.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]longReturns the company ID of this sxp element.Returns the create date of this sxp element.Returns the description of this sxp element.getDescription(String languageId) Returns the localized description of this sxp element in the language.getDescription(String languageId, boolean useDefault) Returns the localized description of this sxp element 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 sxp element in the language.getDescription(Locale locale, boolean useDefault) Returns the localized description of this sxp element 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 sxp element.Returns the element definition json of this sxp element.Returns the external reference code of this sxp element.Returns the fallback description of this sxp element.Returns the fallback title of this sxp element.booleanReturns the hidden of this sxp element.Returns the modified date of this sxp element.longReturns the mvcc version of this sxp element.longReturns the primary key of this sxp element.booleanReturns the read only of this sxp element.Returns the schema version of this sxp element.intReturns the status of this sxp element.longReturns the sxp element ID of this sxp element.getTitle()Returns the title of this sxp element.Returns the localized title of this sxp element in the language.Returns the localized title of this sxp element in the language, optionally using the default language if no localization exists for the requested language.Returns the localized title of this sxp element in the language.Returns the localized title of this sxp element in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized titles of this sxp element.intgetType()Returns the type of this sxp element.longReturns the user ID of this sxp element.Returns the user name of this sxp element.Returns the user uuid of this sxp element.getUuid()Returns the uuid of this sxp element.Returns the version of this sxp element.booleanisHidden()Returnstrueif this sxp element is hidden.booleanReturnstrueif this sxp element is read only.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidsetCompanyId(long companyId) Sets the company ID of this sxp element.voidsetCreateDate(Date createDate) Sets the create date of this sxp element.voidsetDescription(String description) Sets the description of this sxp element.voidsetDescription(String description, Locale locale) Sets the localized description of this sxp element in the language.voidsetDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this sxp element in the language, and sets the default locale.voidsetDescriptionCurrentLanguageId(String languageId) voidsetDescriptionMap(Map<Locale, String> descriptionMap) Sets the localized descriptions of this sxp element from the map of locales and localized descriptions.voidsetDescriptionMap(Map<Locale, String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this sxp element from the map of locales and localized descriptions, and sets the default locale.voidsetElementDefinitionJSON(String elementDefinitionJSON) Sets the element definition json of this sxp element.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this sxp element.voidsetFallbackDescription(String fallbackDescription) Sets the fallback description of this sxp element.voidsetFallbackTitle(String fallbackTitle) Sets the fallback title of this sxp element.voidsetHidden(boolean hidden) Sets whether this sxp element is hidden.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this sxp element.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this sxp element.voidsetPrimaryKey(long primaryKey) Sets the primary key of this sxp element.voidsetReadOnly(boolean readOnly) Sets whether this sxp element is read only.voidsetSchemaVersion(String schemaVersion) Sets the schema version of this sxp element.voidsetStatus(int status) Sets the status of this sxp element.voidsetSXPElementId(long sxpElementId) Sets the sxp element ID of this sxp element.voidSets the title of this sxp element.voidSets the localized title of this sxp element in the language.voidSets the localized title of this sxp element in the language, and sets the default locale.voidsetTitleCurrentLanguageId(String languageId) voidsetTitleMap(Map<Locale, String> titleMap) Sets the localized titles of this sxp element from the map of locales and localized titles.voidsetTitleMap(Map<Locale, String> titleMap, Locale defaultLocale) Sets the localized titles of this sxp element from the map of locales and localized titles, and sets the default locale.voidsetType(int type) Sets the type of this sxp element.voidsetUserId(long userId) Sets the user ID of this sxp element.voidsetUserName(String userName) Sets the user name of this sxp element.voidsetUserUuid(String userUuid) Sets the user uuid of this sxp element.voidSets the uuid of this sxp element.voidsetVersion(String version) Sets the version of this sxp element.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 sxp element.- Returns:
- the primary key of this sxp element
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this sxp element.- Parameters:
primaryKey- the primary key of this sxp element
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this sxp element.- Specified by:
getMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Returns:
- the mvcc version of this sxp element
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this sxp element.- Specified by:
setMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Parameters:
mvccVersion- the mvcc version of this sxp element
-
getUuid
Returns the uuid of this sxp element.- Specified by:
getUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the uuid of this sxp element
-
setUuid
Sets the uuid of this sxp element.- Specified by:
setUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
uuid- the uuid of this sxp element
-
getExternalReferenceCode
Returns the external reference code of this sxp element.- Specified by:
getExternalReferenceCodein interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel- Returns:
- the external reference code of this sxp element
-
setExternalReferenceCode
Sets the external reference code of this sxp element.- Specified by:
setExternalReferenceCodein interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel- Parameters:
externalReferenceCode- the external reference code of this sxp element
-
getSXPElementId
long getSXPElementId()Returns the sxp element ID of this sxp element.- Returns:
- the sxp element ID of this sxp element
-
setSXPElementId
void setSXPElementId(long sxpElementId) Sets the sxp element ID of this sxp element.- Parameters:
sxpElementId- the sxp element ID of this sxp element
-
getCompanyId
long getCompanyId()Returns the company ID of this sxp element.- 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 sxp element
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this sxp element.- 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 sxp element
-
getUserId
long getUserId()Returns the user ID of this sxp element.- Specified by:
getUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user ID of this sxp element
-
setUserId
void setUserId(long userId) Sets the user ID of this sxp element.- Specified by:
setUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userId- the user ID of this sxp element
-
getUserUuid
String getUserUuid()Returns the user uuid of this sxp element.- Specified by:
getUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user uuid of this sxp element
-
setUserUuid
Sets the user uuid of this sxp element.- Specified by:
setUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userUuid- the user uuid of this sxp element
-
getUserName
Returns the user name of this sxp element.- Specified by:
getUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user name of this sxp element
-
setUserName
Sets the user name of this sxp element.- Specified by:
setUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userName- the user name of this sxp element
-
getCreateDate
Date getCreateDate()Returns the create date of this sxp element.- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the create date of this sxp element
-
setCreateDate
Sets the create date of this sxp element.- 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 sxp element
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this sxp element.- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the modified date of this sxp element
-
setModifiedDate
Sets the modified date of this sxp element.- 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 sxp element
-
getDescription
String getDescription()Returns the description of this sxp element.- Returns:
- the description of this sxp element
-
getDescription
Returns the localized description of this sxp element 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 sxp element
-
getDescription
Returns the localized description of this sxp element 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 sxp element. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getDescription
Returns the localized description of this sxp element 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 sxp element
-
getDescription
Returns the localized description of this sxp element 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 sxp element
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this sxp element.- Returns:
- the locales and localized descriptions of this sxp element
-
setDescription
Sets the description of this sxp element.- Parameters:
description- the description of this sxp element
-
setDescription
Sets the localized description of this sxp element in the language.- Parameters:
description- the localized description of this sxp elementlocale- the locale of the language
-
setDescription
Sets the localized description of this sxp element in the language, and sets the default locale.- Parameters:
description- the localized description of this sxp elementlocale- the locale of the languagedefaultLocale- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this sxp element from the map of locales and localized descriptions.- Parameters:
descriptionMap- the locales and localized descriptions of this sxp element
-
setDescriptionMap
Sets the localized descriptions of this sxp element from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap- the locales and localized descriptions of this sxp elementdefaultLocale- the default locale
-
getElementDefinitionJSON
Returns the element definition json of this sxp element.- Returns:
- the element definition json of this sxp element
-
setElementDefinitionJSON
Sets the element definition json of this sxp element.- Parameters:
elementDefinitionJSON- the element definition json of this sxp element
-
getFallbackDescription
Returns the fallback description of this sxp element.- Returns:
- the fallback description of this sxp element
-
setFallbackDescription
Sets the fallback description of this sxp element.- Parameters:
fallbackDescription- the fallback description of this sxp element
-
getFallbackTitle
Returns the fallback title of this sxp element.- Returns:
- the fallback title of this sxp element
-
setFallbackTitle
Sets the fallback title of this sxp element.- Parameters:
fallbackTitle- the fallback title of this sxp element
-
getHidden
boolean getHidden()Returns the hidden of this sxp element.- Returns:
- the hidden of this sxp element
-
isHidden
boolean isHidden()Returnstrueif this sxp element is hidden.- Returns:
trueif this sxp element is hidden;falseotherwise
-
setHidden
void setHidden(boolean hidden) Sets whether this sxp element is hidden.- Parameters:
hidden- the hidden of this sxp element
-
getReadOnly
boolean getReadOnly()Returns the read only of this sxp element.- Returns:
- the read only of this sxp element
-
isReadOnly
boolean isReadOnly()Returnstrueif this sxp element is read only.- Returns:
trueif this sxp element is read only;falseotherwise
-
setReadOnly
void setReadOnly(boolean readOnly) Sets whether this sxp element is read only.- Parameters:
readOnly- the read only of this sxp element
-
getSchemaVersion
Returns the schema version of this sxp element.- Returns:
- the schema version of this sxp element
-
setSchemaVersion
Sets the schema version of this sxp element.- Parameters:
schemaVersion- the schema version of this sxp element
-
getTitle
String getTitle()Returns the title of this sxp element.- Returns:
- the title of this sxp element
-
getTitle
Returns the localized title of this sxp element 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 title of this sxp element
-
getTitle
Returns the localized title of this sxp element 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 title of this sxp element. If
useDefaultisfalseand no localization exists for the requested language, an empty string will be returned.
-
getTitle
Returns the localized title of this sxp element 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 title of this sxp element
-
getTitle
Returns the localized title of this sxp element 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 title of this sxp element
-
getTitleCurrentLanguageId
-
getTitleCurrentValue
-
getTitleMap
Returns a map of the locales and localized titles of this sxp element.- Returns:
- the locales and localized titles of this sxp element
-
setTitle
Sets the title of this sxp element.- Parameters:
title- the title of this sxp element
-
setTitle
Sets the localized title of this sxp element in the language.- Parameters:
title- the localized title of this sxp elementlocale- the locale of the language
-
setTitle
Sets the localized title of this sxp element in the language, and sets the default locale.- Parameters:
title- the localized title of this sxp elementlocale- the locale of the languagedefaultLocale- the default locale
-
setTitleCurrentLanguageId
-
setTitleMap
Sets the localized titles of this sxp element from the map of locales and localized titles.- Parameters:
titleMap- the locales and localized titles of this sxp element
-
setTitleMap
Sets the localized titles of this sxp element from the map of locales and localized titles, and sets the default locale.- Parameters:
titleMap- the locales and localized titles of this sxp elementdefaultLocale- the default locale
-
getType
int getType()Returns the type of this sxp element.- Returns:
- the type of this sxp element
-
setType
void setType(int type) Sets the type of this sxp element.- Parameters:
type- the type of this sxp element
-
getVersion
Returns the version of this sxp element.- Returns:
- the version of this sxp element
-
setVersion
Sets the version of this sxp element.- Parameters:
version- the version of this sxp element
-
getStatus
int getStatus()Returns the status of this sxp element.- Returns:
- the status of this sxp element
-
setStatus
void setStatus(int status) Sets the status of this sxp element.- Parameters:
status- the status of this sxp element
-
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
SXPElement cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfacecom.liferay.portal.kernel.model.BaseModel<SXPElement>
-
toXmlString
-