@ProviderType public interface SXPElementModel extends com.liferay.portal.kernel.model.BaseModel<SXPElement>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel
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.
SXPElement| Modifier and Type | Method and Description |
|---|---|
java.lang.String[] |
getAvailableLanguageIds() |
long |
getCompanyId()
Returns the company ID of this sxp element.
|
java.util.Date |
getCreateDate()
Returns the create date of this sxp element.
|
java.lang.String |
getDefaultLanguageId() |
java.lang.String |
getDescription()
Returns the description of this sxp element.
|
java.lang.String |
getDescription(java.util.Locale locale)
Returns the localized description of this sxp element in the language.
|
java.lang.String |
getDescription(java.util.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.
|
java.lang.String |
getDescription(java.lang.String languageId)
Returns the localized description of this sxp element in the language.
|
java.lang.String |
getDescription(java.lang.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.
|
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 sxp element.
|
java.lang.String |
getElementDefinitionJSON()
Returns the element definition json of this sxp element.
|
boolean |
getHidden()
Returns the hidden of this sxp element.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this sxp element.
|
long |
getMvccVersion()
Returns the mvcc version of this sxp element.
|
long |
getPrimaryKey()
Returns the primary key of this sxp element.
|
boolean |
getReadOnly()
Returns the read only of this sxp element.
|
java.lang.String |
getSchemaVersion()
Returns the schema version of this sxp element.
|
int |
getStatus()
Returns the status of this sxp element.
|
long |
getSXPElementId()
Returns the sxp element ID of this sxp element.
|
java.lang.String |
getTitle()
Returns the title of this sxp element.
|
java.lang.String |
getTitle(java.util.Locale locale)
Returns the localized title of this sxp element in the language.
|
java.lang.String |
getTitle(java.util.Locale locale,
boolean useDefault)
Returns the localized title of this sxp element in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getTitle(java.lang.String languageId)
Returns the localized title of this sxp element in the language.
|
java.lang.String |
getTitle(java.lang.String languageId,
boolean useDefault)
Returns the localized title of this sxp element in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getTitleCurrentLanguageId() |
java.lang.String |
getTitleCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getTitleMap()
Returns a map of the locales and localized titles of this sxp element.
|
int |
getType()
Returns the type of this sxp element.
|
long |
getUserId()
Returns the user ID of this sxp element.
|
java.lang.String |
getUserName()
Returns the user name of this sxp element.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this sxp element.
|
java.lang.String |
getUuid()
Returns the uuid of this sxp element.
|
boolean |
isHidden()
Returns
true if this sxp element is hidden. |
boolean |
isReadOnly()
Returns
true if this sxp element is read only. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setCompanyId(long companyId)
Sets the company ID of this sxp element.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this sxp element.
|
void |
setDescription(java.lang.String description)
Sets the description of this sxp element.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets the localized description of this sxp element in the language.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized description of this sxp element 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 sxp element 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 sxp element from the map of locales and localized descriptions, and sets the default locale.
|
void |
setElementDefinitionJSON(java.lang.String elementDefinitionJSON)
Sets the element definition json of this sxp element.
|
void |
setHidden(boolean hidden)
Sets whether this sxp element is hidden.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this sxp element.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this sxp element.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this sxp element.
|
void |
setReadOnly(boolean readOnly)
Sets whether this sxp element is read only.
|
void |
setSchemaVersion(java.lang.String schemaVersion)
Sets the schema version of this sxp element.
|
void |
setStatus(int status)
Sets the status of this sxp element.
|
void |
setSXPElementId(long sxpElementId)
Sets the sxp element ID of this sxp element.
|
void |
setTitle(java.lang.String title)
Sets the title of this sxp element.
|
void |
setTitle(java.lang.String title,
java.util.Locale locale)
Sets the localized title of this sxp element in the language.
|
void |
setTitle(java.lang.String title,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized title of this sxp element in the language, and sets the default locale.
|
void |
setTitleCurrentLanguageId(java.lang.String languageId) |
void |
setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap)
Sets the localized titles of this sxp element from the map of locales and localized titles.
|
void |
setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Locale defaultLocale)
Sets the localized titles of this sxp element from the map of locales and localized titles, and sets the default locale.
|
void |
setType(int type)
Sets the type of this sxp element.
|
void |
setUserId(long userId)
Sets the user ID of this sxp element.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this sxp element.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this sxp element.
|
void |
setUuid(java.lang.String uuid)
Sets the uuid of this sxp element.
|
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlStringlong getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey - the primary key of this sxp elementlong getMvccVersion()
getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModelvoid setMvccVersion(long mvccVersion)
setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModelmvccVersion - the mvcc version of this sxp element@AutoEscape java.lang.String getUuid()
getUuid in interface com.liferay.portal.kernel.model.StagedModelvoid setUuid(java.lang.String uuid)
setUuid in interface com.liferay.portal.kernel.model.StagedModeluuid - the uuid of this sxp elementlong getSXPElementId()
void setSXPElementId(long sxpElementId)
sxpElementId - the sxp element ID of this sxp elementlong getCompanyId()
getCompanyId in interface com.liferay.portal.kernel.model.AuditedModelgetCompanyId in interface com.liferay.portal.kernel.model.ShardedModelgetCompanyId in interface com.liferay.portal.kernel.model.StagedModelvoid setCompanyId(long companyId)
setCompanyId in interface com.liferay.portal.kernel.model.AuditedModelsetCompanyId in interface com.liferay.portal.kernel.model.ShardedModelsetCompanyId in interface com.liferay.portal.kernel.model.StagedModelcompanyId - the company ID of this sxp elementlong getUserId()
getUserId in interface com.liferay.portal.kernel.model.AuditedModelvoid setUserId(long userId)
setUserId in interface com.liferay.portal.kernel.model.AuditedModeluserId - the user ID of this sxp elementjava.lang.String getUserUuid()
getUserUuid in interface com.liferay.portal.kernel.model.AuditedModelvoid setUserUuid(java.lang.String userUuid)
setUserUuid in interface com.liferay.portal.kernel.model.AuditedModeluserUuid - the user uuid of this sxp element@AutoEscape java.lang.String getUserName()
getUserName in interface com.liferay.portal.kernel.model.AuditedModelvoid setUserName(java.lang.String userName)
setUserName in interface com.liferay.portal.kernel.model.AuditedModeluserName - the user name of this sxp elementjava.util.Date getCreateDate()
getCreateDate in interface com.liferay.portal.kernel.model.AuditedModelgetCreateDate in interface com.liferay.portal.kernel.model.StagedModelvoid setCreateDate(java.util.Date createDate)
setCreateDate in interface com.liferay.portal.kernel.model.AuditedModelsetCreateDate in interface com.liferay.portal.kernel.model.StagedModelcreateDate - the create date of this sxp elementjava.util.Date getModifiedDate()
getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModelgetModifiedDate in interface com.liferay.portal.kernel.model.StagedModelvoid setModifiedDate(java.util.Date modifiedDate)
setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModelsetModifiedDate in interface com.liferay.portal.kernel.model.StagedModelmodifiedDate - the modified date of this sxp elementjava.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 sxp elementvoid setDescription(java.lang.String description,
java.util.Locale locale)
description - the localized description of this sxp elementlocale - the locale of the languagevoid setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
description - the localized description of this sxp elementlocale - 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 sxp elementvoid setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.Locale defaultLocale)
descriptionMap - the locales and localized descriptions of this sxp elementdefaultLocale - the default locale@AutoEscape java.lang.String getElementDefinitionJSON()
void setElementDefinitionJSON(java.lang.String elementDefinitionJSON)
elementDefinitionJSON - the element definition json of this sxp elementboolean getHidden()
boolean isHidden()
true if this sxp element is hidden.true if this sxp element is hidden; false otherwisevoid setHidden(boolean hidden)
hidden - the hidden of this sxp elementboolean getReadOnly()
boolean isReadOnly()
true if this sxp element is read only.true if this sxp element is read only; false otherwisevoid setReadOnly(boolean readOnly)
readOnly - the read only of this sxp element@AutoEscape java.lang.String getSchemaVersion()
void setSchemaVersion(java.lang.String schemaVersion)
schemaVersion - the schema version of this sxp elementjava.lang.String getTitle()
@AutoEscape java.lang.String getTitle(java.util.Locale locale)
locale - the locale of the language@AutoEscape
java.lang.String getTitle(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 getTitle(java.lang.String languageId)
languageId - the ID of the language@AutoEscape
java.lang.String getTitle(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 getTitleCurrentLanguageId()
@AutoEscape java.lang.String getTitleCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getTitleMap()
void setTitle(java.lang.String title)
title - the title of this sxp elementvoid setTitle(java.lang.String title,
java.util.Locale locale)
title - the localized title of this sxp elementlocale - the locale of the languagevoid setTitle(java.lang.String title,
java.util.Locale locale,
java.util.Locale defaultLocale)
title - the localized title of this sxp elementlocale - the locale of the languagedefaultLocale - the default localevoid setTitleCurrentLanguageId(java.lang.String languageId)
void setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap)
titleMap - the locales and localized titles of this sxp elementvoid setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Locale defaultLocale)
titleMap - the locales and localized titles of this sxp elementdefaultLocale - the default localeint getType()
void setType(int type)
type - the type of this sxp elementint getStatus()
void setStatus(int status)
status - the status of this sxp elementjava.lang.String[] getAvailableLanguageIds()
getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModeljava.lang.String getDefaultLanguageId()
getDefaultLanguageId in interface com.liferay.portal.kernel.model.LocalizedModelvoid prepareLocalizedFieldsForImport()
throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModelcom.liferay.portal.kernel.exception.LocaleExceptionvoid prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModelcom.liferay.portal.kernel.exception.LocaleException