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 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:
      getMvccVersion in interface com.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:
      setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this sxp element
    • getUuid

      @AutoEscape String getUuid()
      Returns the uuid of this sxp element.
      Specified by:
      getUuid in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the uuid of this sxp element
    • setUuid

      void setUuid(String uuid)
      Sets the uuid of this sxp element.
      Specified by:
      setUuid in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      uuid - the uuid of this sxp element
    • getExternalReferenceCode

      @AutoEscape String getExternalReferenceCode()
      Returns the external reference code of this sxp element.
      Specified by:
      getExternalReferenceCode in interface com.liferay.portal.kernel.model.ExternalReferenceCodeModel
      Returns:
      the external reference code of this sxp element
    • setExternalReferenceCode

      void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this sxp element.
      Specified by:
      setExternalReferenceCode in interface com.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:
      getCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.ShardedModel
      Specified by:
      getCompanyId in interface com.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:
      setCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.ShardedModel
      Specified by:
      setCompanyId in interface com.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:
      getUserId in interface com.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:
      setUserId in interface com.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:
      getUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user uuid of this sxp element
    • setUserUuid

      void setUserUuid(String userUuid)
      Sets the user uuid of this sxp element.
      Specified by:
      setUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userUuid - the user uuid of this sxp element
    • getUserName

      @AutoEscape String getUserName()
      Returns the user name of this sxp element.
      Specified by:
      getUserName in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user name of this sxp element
    • setUserName

      void setUserName(String userName)
      Sets the user name of this sxp element.
      Specified by:
      setUserName in interface com.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:
      getCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getCreateDate in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the create date of this sxp element
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this sxp element.
      Specified by:
      setCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setCreateDate in interface com.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:
      getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getModifiedDate in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the modified date of this sxp element
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this sxp element.
      Specified by:
      setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setModifiedDate in interface com.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

      @AutoEscape String getDescription(Locale locale)
      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

      @AutoEscape String 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.
      Parameters:
      locale - the local of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized description of this sxp element. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getDescription

      @AutoEscape String getDescription(String languageId)
      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

      @AutoEscape String 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.
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized description of this sxp element
    • getDescriptionCurrentLanguageId

      @AutoEscape String getDescriptionCurrentLanguageId()
    • getDescriptionCurrentValue

      @AutoEscape String getDescriptionCurrentValue()
    • getDescriptionMap

      Map<Locale,String> 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

      void setDescription(String description)
      Sets the description of this sxp element.
      Parameters:
      description - the description of this sxp element
    • setDescription

      void setDescription(String description, Locale locale)
      Sets the localized description of this sxp element in the language.
      Parameters:
      description - the localized description of this sxp element
      locale - the locale of the language
    • setDescription

      void setDescription(String description, Locale locale, Locale defaultLocale)
      Sets the localized description of this sxp element in the language, and sets the default locale.
      Parameters:
      description - the localized description of this sxp element
      locale - the locale of the language
      defaultLocale - the default locale
    • setDescriptionCurrentLanguageId

      void setDescriptionCurrentLanguageId(String languageId)
    • setDescriptionMap

      void setDescriptionMap(Map<Locale,String> descriptionMap)
      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

      void setDescriptionMap(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.
      Parameters:
      descriptionMap - the locales and localized descriptions of this sxp element
      defaultLocale - the default locale
    • getElementDefinitionJSON

      @AutoEscape String getElementDefinitionJSON()
      Returns the element definition json of this sxp element.
      Returns:
      the element definition json of this sxp element
    • setElementDefinitionJSON

      void setElementDefinitionJSON(String elementDefinitionJSON)
      Sets the element definition json of this sxp element.
      Parameters:
      elementDefinitionJSON - the element definition json of this sxp element
    • getFallbackDescription

      @AutoEscape String getFallbackDescription()
      Returns the fallback description of this sxp element.
      Returns:
      the fallback description of this sxp element
    • setFallbackDescription

      void setFallbackDescription(String fallbackDescription)
      Sets the fallback description of this sxp element.
      Parameters:
      fallbackDescription - the fallback description of this sxp element
    • getFallbackTitle

      @AutoEscape String getFallbackTitle()
      Returns the fallback title of this sxp element.
      Returns:
      the fallback title of this sxp element
    • setFallbackTitle

      void setFallbackTitle(String fallbackTitle)
      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()
      Returns true if this sxp element is hidden.
      Returns:
      true if this sxp element is hidden; false otherwise
    • 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()
      Returns true if this sxp element is read only.
      Returns:
      true if this sxp element is read only; false otherwise
    • setReadOnly

      void setReadOnly(boolean readOnly)
      Sets whether this sxp element is read only.
      Parameters:
      readOnly - the read only of this sxp element
    • getSchemaVersion

      @AutoEscape String getSchemaVersion()
      Returns the schema version of this sxp element.
      Returns:
      the schema version of this sxp element
    • setSchemaVersion

      void setSchemaVersion(String schemaVersion)
      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

      @AutoEscape String getTitle(Locale locale)
      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

      @AutoEscape String getTitle(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.
      Parameters:
      locale - the local of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized title of this sxp element. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getTitle

      @AutoEscape String getTitle(String languageId)
      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

      @AutoEscape String getTitle(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.
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized title of this sxp element
    • getTitleCurrentLanguageId

      @AutoEscape String getTitleCurrentLanguageId()
    • getTitleCurrentValue

      @AutoEscape String getTitleCurrentValue()
    • getTitleMap

      Map<Locale,String> 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

      void setTitle(String title)
      Sets the title of this sxp element.
      Parameters:
      title - the title of this sxp element
    • setTitle

      void setTitle(String title, Locale locale)
      Sets the localized title of this sxp element in the language.
      Parameters:
      title - the localized title of this sxp element
      locale - the locale of the language
    • setTitle

      void setTitle(String title, Locale locale, Locale defaultLocale)
      Sets the localized title of this sxp element in the language, and sets the default locale.
      Parameters:
      title - the localized title of this sxp element
      locale - the locale of the language
      defaultLocale - the default locale
    • setTitleCurrentLanguageId

      void setTitleCurrentLanguageId(String languageId)
    • setTitleMap

      void setTitleMap(Map<Locale,String> titleMap)
      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

      void setTitleMap(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.
      Parameters:
      titleMap - the locales and localized titles of this sxp element
      defaultLocale - 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

      @AutoEscape String getVersion()
      Returns the version of this sxp element.
      Returns:
      the version of this sxp element
    • setVersion

      void setVersion(String version)
      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:
      getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModel
    • getDefaultLanguageId

      String getDefaultLanguageId()
      Specified by:
      getDefaultLanguageId in interface com.liferay.portal.kernel.model.LocalizedModel
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface com.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 interface com.liferay.portal.kernel.model.LocalizedModel
      Throws:
      com.liferay.portal.kernel.exception.LocaleException
    • cloneWithOriginalValues

      SXPElement cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface com.liferay.portal.kernel.model.BaseModel<SXPElement>
    • toXmlString

      default String toXmlString()