Interface SXPBlueprintModel

All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<SXPBlueprint>, com.liferay.portal.kernel.model.ClassedModel, Cloneable, Comparable<SXPBlueprint>, 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, com.liferay.portal.kernel.model.WorkflowedModel
All Known Subinterfaces:
SXPBlueprint
All Known Implementing Classes:
SXPBlueprintWrapper

@ProviderType public interface SXPBlueprintModel extends com.liferay.portal.kernel.model.BaseModel<SXPBlueprint>, 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, com.liferay.portal.kernel.model.WorkflowedModel
The base model interface for the SXPBlueprint service. Represents a row in the "SXPBlueprint" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.search.experiences.model.impl.SXPBlueprintModelImpl 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.SXPBlueprintImpl.

See Also:
Generated:
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this sxp blueprint.
      Returns:
      the primary key of this sxp blueprint
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this sxp blueprint.
      Parameters:
      primaryKey - the primary key of this sxp blueprint
    • getMvccVersion

      long getMvccVersion()
      Returns the mvcc version of this sxp blueprint.
      Specified by:
      getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Returns:
      the mvcc version of this sxp blueprint
    • setMvccVersion

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this sxp blueprint.
      Specified by:
      setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this sxp blueprint
    • getUuid

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

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

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

      void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this sxp blueprint.
      Specified by:
      setExternalReferenceCode in interface com.liferay.portal.kernel.model.ExternalReferenceCodeModel
      Parameters:
      externalReferenceCode - the external reference code of this sxp blueprint
    • getSXPBlueprintId

      long getSXPBlueprintId()
      Returns the sxp blueprint ID of this sxp blueprint.
      Returns:
      the sxp blueprint ID of this sxp blueprint
    • setSXPBlueprintId

      void setSXPBlueprintId(long sxpBlueprintId)
      Sets the sxp blueprint ID of this sxp blueprint.
      Parameters:
      sxpBlueprintId - the sxp blueprint ID of this sxp blueprint
    • getCompanyId

      long getCompanyId()
      Returns the company ID of this sxp blueprint.
      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 blueprint
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this sxp blueprint.
      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 blueprint
    • getUserId

      long getUserId()
      Returns the user ID of this sxp blueprint.
      Specified by:
      getUserId in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user ID of this sxp blueprint
    • setUserId

      void setUserId(long userId)
      Sets the user ID of this sxp blueprint.
      Specified by:
      setUserId in interface com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userId - the user ID of this sxp blueprint
    • getUserUuid

      String getUserUuid()
      Returns the user uuid of this sxp blueprint.
      Specified by:
      getUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user uuid of this sxp blueprint
    • setUserUuid

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

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

      void setUserName(String userName)
      Sets the user name of this sxp blueprint.
      Specified by:
      setUserName in interface com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userName - the user name of this sxp blueprint
    • getCreateDate

      Date getCreateDate()
      Returns the create date of this sxp blueprint.
      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 blueprint
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this sxp blueprint.
      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 blueprint
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this sxp blueprint.
      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 blueprint
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this sxp blueprint.
      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 blueprint
    • getConfigurationJSON

      @AutoEscape String getConfigurationJSON()
      Returns the configuration json of this sxp blueprint.
      Returns:
      the configuration json of this sxp blueprint
    • setConfigurationJSON

      void setConfigurationJSON(String configurationJSON)
      Sets the configuration json of this sxp blueprint.
      Parameters:
      configurationJSON - the configuration json of this sxp blueprint
    • getDescription

      String getDescription()
      Returns the description of this sxp blueprint.
      Returns:
      the description of this sxp blueprint
    • getDescription

      @AutoEscape String getDescription(Locale locale)
      Returns the localized description of this sxp blueprint 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 blueprint
    • getDescription

      @AutoEscape String getDescription(Locale locale, boolean useDefault)
      Returns the localized description of this sxp blueprint 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 blueprint. 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 blueprint 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 blueprint
    • getDescription

      @AutoEscape String getDescription(String languageId, boolean useDefault)
      Returns the localized description of this sxp blueprint 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 blueprint
    • 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 blueprint.
      Returns:
      the locales and localized descriptions of this sxp blueprint
    • setDescription

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

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

      void setDescription(String description, Locale locale, Locale defaultLocale)
      Sets the localized description of this sxp blueprint in the language, and sets the default locale.
      Parameters:
      description - the localized description of this sxp blueprint
      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 blueprint from the map of locales and localized descriptions.
      Parameters:
      descriptionMap - the locales and localized descriptions of this sxp blueprint
    • setDescriptionMap

      void setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
      Sets the localized descriptions of this sxp blueprint from the map of locales and localized descriptions, and sets the default locale.
      Parameters:
      descriptionMap - the locales and localized descriptions of this sxp blueprint
      defaultLocale - the default locale
    • getElementInstancesJSON

      @AutoEscape String getElementInstancesJSON()
      Returns the element instances json of this sxp blueprint.
      Returns:
      the element instances json of this sxp blueprint
    • setElementInstancesJSON

      void setElementInstancesJSON(String elementInstancesJSON)
      Sets the element instances json of this sxp blueprint.
      Parameters:
      elementInstancesJSON - the element instances json of this sxp blueprint
    • getSchemaVersion

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

      void setSchemaVersion(String schemaVersion)
      Sets the schema version of this sxp blueprint.
      Parameters:
      schemaVersion - the schema version of this sxp blueprint
    • getTitle

      String getTitle()
      Returns the title of this sxp blueprint.
      Returns:
      the title of this sxp blueprint
    • getTitle

      @AutoEscape String getTitle(Locale locale)
      Returns the localized title of this sxp blueprint 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 blueprint
    • getTitle

      @AutoEscape String getTitle(Locale locale, boolean useDefault)
      Returns the localized title of this sxp blueprint 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 blueprint. 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 blueprint 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 blueprint
    • getTitle

      @AutoEscape String getTitle(String languageId, boolean useDefault)
      Returns the localized title of this sxp blueprint 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 blueprint
    • 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 blueprint.
      Returns:
      the locales and localized titles of this sxp blueprint
    • setTitle

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

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

      void setTitle(String title, Locale locale, Locale defaultLocale)
      Sets the localized title of this sxp blueprint in the language, and sets the default locale.
      Parameters:
      title - the localized title of this sxp blueprint
      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 blueprint from the map of locales and localized titles.
      Parameters:
      titleMap - the locales and localized titles of this sxp blueprint
    • setTitleMap

      void setTitleMap(Map<Locale,String> titleMap, Locale defaultLocale)
      Sets the localized titles of this sxp blueprint from the map of locales and localized titles, and sets the default locale.
      Parameters:
      titleMap - the locales and localized titles of this sxp blueprint
      defaultLocale - the default locale
    • getVersion

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

      void setVersion(String version)
      Sets the version of this sxp blueprint.
      Parameters:
      version - the version of this sxp blueprint
    • getStatus

      int getStatus()
      Returns the status of this sxp blueprint.
      Specified by:
      getStatus in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      the status of this sxp blueprint
    • setStatus

      void setStatus(int status)
      Sets the status of this sxp blueprint.
      Specified by:
      setStatus in interface com.liferay.portal.kernel.model.WorkflowedModel
      Parameters:
      status - the status of this sxp blueprint
    • getStatusByUserId

      long getStatusByUserId()
      Returns the status by user ID of this sxp blueprint.
      Specified by:
      getStatusByUserId in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      the status by user ID of this sxp blueprint
    • setStatusByUserId

      void setStatusByUserId(long statusByUserId)
      Sets the status by user ID of this sxp blueprint.
      Specified by:
      setStatusByUserId in interface com.liferay.portal.kernel.model.WorkflowedModel
      Parameters:
      statusByUserId - the status by user ID of this sxp blueprint
    • getStatusByUserUuid

      String getStatusByUserUuid()
      Returns the status by user uuid of this sxp blueprint.
      Specified by:
      getStatusByUserUuid in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      the status by user uuid of this sxp blueprint
    • setStatusByUserUuid

      void setStatusByUserUuid(String statusByUserUuid)
      Sets the status by user uuid of this sxp blueprint.
      Specified by:
      setStatusByUserUuid in interface com.liferay.portal.kernel.model.WorkflowedModel
      Parameters:
      statusByUserUuid - the status by user uuid of this sxp blueprint
    • getStatusByUserName

      @AutoEscape String getStatusByUserName()
      Returns the status by user name of this sxp blueprint.
      Specified by:
      getStatusByUserName in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      the status by user name of this sxp blueprint
    • setStatusByUserName

      void setStatusByUserName(String statusByUserName)
      Sets the status by user name of this sxp blueprint.
      Specified by:
      setStatusByUserName in interface com.liferay.portal.kernel.model.WorkflowedModel
      Parameters:
      statusByUserName - the status by user name of this sxp blueprint
    • getStatusDate

      Date getStatusDate()
      Returns the status date of this sxp blueprint.
      Specified by:
      getStatusDate in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      the status date of this sxp blueprint
    • setStatusDate

      void setStatusDate(Date statusDate)
      Sets the status date of this sxp blueprint.
      Specified by:
      setStatusDate in interface com.liferay.portal.kernel.model.WorkflowedModel
      Parameters:
      statusDate - the status date of this sxp blueprint
    • isApproved

      boolean isApproved()
      Returns true if this sxp blueprint is approved.
      Specified by:
      isApproved in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      true if this sxp blueprint is approved; false otherwise
    • isDenied

      boolean isDenied()
      Returns true if this sxp blueprint is denied.
      Specified by:
      isDenied in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      true if this sxp blueprint is denied; false otherwise
    • isDraft

      boolean isDraft()
      Returns true if this sxp blueprint is a draft.
      Specified by:
      isDraft in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      true if this sxp blueprint is a draft; false otherwise
    • isExpired

      boolean isExpired()
      Returns true if this sxp blueprint is expired.
      Specified by:
      isExpired in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      true if this sxp blueprint is expired; false otherwise
    • isInactive

      boolean isInactive()
      Returns true if this sxp blueprint is inactive.
      Specified by:
      isInactive in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      true if this sxp blueprint is inactive; false otherwise
    • isIncomplete

      boolean isIncomplete()
      Returns true if this sxp blueprint is incomplete.
      Specified by:
      isIncomplete in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      true if this sxp blueprint is incomplete; false otherwise
    • isPending

      boolean isPending()
      Returns true if this sxp blueprint is pending.
      Specified by:
      isPending in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      true if this sxp blueprint is pending; false otherwise
    • isScheduled

      boolean isScheduled()
      Returns true if this sxp blueprint is scheduled.
      Specified by:
      isScheduled in interface com.liferay.portal.kernel.model.WorkflowedModel
      Returns:
      true if this sxp blueprint is scheduled; false otherwise
    • 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

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

      default String toXmlString()