Interface CPSpecificationOptionModel

All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<CPSpecificationOption>, com.liferay.portal.kernel.model.ClassedModel, Cloneable, Comparable<CPSpecificationOption>, com.liferay.portal.kernel.model.change.tracking.CTModel<CPSpecificationOption>, 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:
CPSpecificationOption
All Known Implementing Classes:
CPSpecificationOptionWrapper

@ProviderType public interface CPSpecificationOptionModel extends com.liferay.portal.kernel.model.BaseModel<CPSpecificationOption>, com.liferay.portal.kernel.model.change.tracking.CTModel<CPSpecificationOption>, 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 CPSpecificationOption service. Represents a row in the "CPSpecificationOption" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.commerce.product.model.impl.CPSpecificationOptionModelImpl 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.commerce.product.model.impl.CPSpecificationOptionImpl.

See Also:
Generated:
  • Method Summary

    Modifier and Type
    Method
    Description
     
     
    long
    Returns the company ID of this cp specification option.
    long
    Returns the cp option category ID of this cp specification option.
    long
    Returns the cp specification option ID of this cp specification option.
    Returns the create date of this cp specification option.
    long
    Returns the ct collection ID of this cp specification option.
     
    Returns the description of this cp specification option.
    getDescription(String languageId)
    Returns the localized description of this cp specification option in the language.
    getDescription(String languageId, boolean useDefault)
    Returns the localized description of this cp specification option in the language, optionally using the default language if no localization exists for the requested language.
    Returns the localized description of this cp specification option in the language.
    getDescription(Locale locale, boolean useDefault)
    Returns the localized description of this cp specification option 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 cp specification option.
    Returns the external reference code of this cp specification option.
    boolean
    Returns the facetable of this cp specification option.
    Returns the key of this cp specification option.
    Returns the last publish date of this cp specification option.
    Returns the modified date of this cp specification option.
    long
    Returns the mvcc version of this cp specification option.
    long
    Returns the primary key of this cp specification option.
    double
    Returns the priority of this cp specification option.
    Returns the title of this cp specification option.
    getTitle(String languageId)
    Returns the localized title of this cp specification option in the language.
    getTitle(String languageId, boolean useDefault)
    Returns the localized title of this cp specification option in the language, optionally using the default language if no localization exists for the requested language.
    getTitle(Locale locale)
    Returns the localized title of this cp specification option in the language.
    getTitle(Locale locale, boolean useDefault)
    Returns the localized title of this cp specification option 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 cp specification option.
    long
    Returns the user ID of this cp specification option.
    Returns the user name of this cp specification option.
    Returns the user uuid of this cp specification option.
    Returns the uuid of this cp specification option.
    boolean
    Returns true if this cp specification option is facetable.
    void
     
    void
     
    void
    setCompanyId(long companyId)
    Sets the company ID of this cp specification option.
    void
    setCPOptionCategoryId(long CPOptionCategoryId)
    Sets the cp option category ID of this cp specification option.
    void
    setCPSpecificationOptionId(long CPSpecificationOptionId)
    Sets the cp specification option ID of this cp specification option.
    void
    setCreateDate(Date createDate)
    Sets the create date of this cp specification option.
    void
    setCtCollectionId(long ctCollectionId)
    Sets the ct collection ID of this cp specification option.
    void
    setDescription(String description)
    Sets the description of this cp specification option.
    void
    setDescription(String description, Locale locale)
    Sets the localized description of this cp specification option in the language.
    void
    setDescription(String description, Locale locale, Locale defaultLocale)
    Sets the localized description of this cp specification option in the language, and sets the default locale.
    void
     
    void
    Sets the localized descriptions of this cp specification option from the map of locales and localized descriptions.
    void
    setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
    Sets the localized descriptions of this cp specification option from the map of locales and localized descriptions, and sets the default locale.
    void
    setExternalReferenceCode(String externalReferenceCode)
    Sets the external reference code of this cp specification option.
    void
    setFacetable(boolean facetable)
    Sets whether this cp specification option is facetable.
    void
    Sets the key of this cp specification option.
    void
    setLastPublishDate(Date lastPublishDate)
    Sets the last publish date of this cp specification option.
    void
    setModifiedDate(Date modifiedDate)
    Sets the modified date of this cp specification option.
    void
    setMvccVersion(long mvccVersion)
    Sets the mvcc version of this cp specification option.
    void
    setPrimaryKey(long primaryKey)
    Sets the primary key of this cp specification option.
    void
    setPriority(double priority)
    Sets the priority of this cp specification option.
    void
    Sets the title of this cp specification option.
    void
    setTitle(String title, Locale locale)
    Sets the localized title of this cp specification option in the language.
    void
    setTitle(String title, Locale locale, Locale defaultLocale)
    Sets the localized title of this cp specification option in the language, and sets the default locale.
    void
     
    void
    Sets the localized titles of this cp specification option from the map of locales and localized titles.
    void
    setTitleMap(Map<Locale,String> titleMap, Locale defaultLocale)
    Sets the localized titles of this cp specification option from the map of locales and localized titles, and sets the default locale.
    void
    setUserId(long userId)
    Sets the user ID of this cp specification option.
    void
    setUserName(String userName)
    Sets the user name of this cp specification option.
    void
    setUserUuid(String userUuid)
    Sets the user uuid of this cp specification option.
    void
    Sets the uuid of this cp specification option.
    default String
     

    Methods 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, toUnescapedModel

    Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

    getModelClass, getModelClassName

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface com.liferay.portal.kernel.model.StagedModel

    clone, getStagedModelType
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this cp specification option.
      Specified by:
      getPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<CPSpecificationOption>
      Returns:
      the primary key of this cp specification option
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this cp specification option.
      Specified by:
      setPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<CPSpecificationOption>
      Parameters:
      primaryKey - the primary key of this cp specification option
    • getMvccVersion

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

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this cp specification option.
      Specified by:
      setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this cp specification option
    • getCtCollectionId

      long getCtCollectionId()
      Returns the ct collection ID of this cp specification option.
      Specified by:
      getCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<CPSpecificationOption>
      Returns:
      the ct collection ID of this cp specification option
    • setCtCollectionId

      void setCtCollectionId(long ctCollectionId)
      Sets the ct collection ID of this cp specification option.
      Specified by:
      setCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<CPSpecificationOption>
      Parameters:
      ctCollectionId - the ct collection ID of this cp specification option
    • getUuid

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

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

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

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

      long getCPSpecificationOptionId()
      Returns the cp specification option ID of this cp specification option.
      Returns:
      the cp specification option ID of this cp specification option
    • setCPSpecificationOptionId

      void setCPSpecificationOptionId(long CPSpecificationOptionId)
      Sets the cp specification option ID of this cp specification option.
      Parameters:
      CPSpecificationOptionId - the cp specification option ID of this cp specification option
    • getCompanyId

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

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

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

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

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

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

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

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

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

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

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

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this cp specification option.
      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 cp specification option
    • getCPOptionCategoryId

      long getCPOptionCategoryId()
      Returns the cp option category ID of this cp specification option.
      Returns:
      the cp option category ID of this cp specification option
    • setCPOptionCategoryId

      void setCPOptionCategoryId(long CPOptionCategoryId)
      Sets the cp option category ID of this cp specification option.
      Parameters:
      CPOptionCategoryId - the cp option category ID of this cp specification option
    • getTitle

      String getTitle()
      Returns the title of this cp specification option.
      Returns:
      the title of this cp specification option
    • getTitle

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

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

      @AutoEscape String getTitle(String languageId, boolean useDefault)
      Returns the localized title of this cp specification option 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 cp specification option
    • getTitleCurrentLanguageId

      @AutoEscape String getTitleCurrentLanguageId()
    • getTitleCurrentValue

      @AutoEscape String getTitleCurrentValue()
    • getTitleMap

      Map<Locale,String> getTitleMap()
      Returns a map of the locales and localized titles of this cp specification option.
      Returns:
      the locales and localized titles of this cp specification option
    • setTitle

      void setTitle(String title)
      Sets the title of this cp specification option.
      Parameters:
      title - the title of this cp specification option
    • setTitle

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

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

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

      String getDescription()
      Returns the description of this cp specification option.
      Returns:
      the description of this cp specification option
    • getDescription

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

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

      @AutoEscape String getDescription(String languageId, boolean useDefault)
      Returns the localized description of this cp specification option 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 cp specification option
    • getDescriptionCurrentLanguageId

      @AutoEscape String getDescriptionCurrentLanguageId()
    • getDescriptionCurrentValue

      @AutoEscape String getDescriptionCurrentValue()
    • getDescriptionMap

      Map<Locale,String> getDescriptionMap()
      Returns a map of the locales and localized descriptions of this cp specification option.
      Returns:
      the locales and localized descriptions of this cp specification option
    • setDescription

      void setDescription(String description)
      Sets the description of this cp specification option.
      Parameters:
      description - the description of this cp specification option
    • setDescription

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

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

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

      boolean getFacetable()
      Returns the facetable of this cp specification option.
      Returns:
      the facetable of this cp specification option
    • isFacetable

      boolean isFacetable()
      Returns true if this cp specification option is facetable.
      Returns:
      true if this cp specification option is facetable; false otherwise
    • setFacetable

      void setFacetable(boolean facetable)
      Sets whether this cp specification option is facetable.
      Parameters:
      facetable - the facetable of this cp specification option
    • getKey

      @AutoEscape String getKey()
      Returns the key of this cp specification option.
      Returns:
      the key of this cp specification option
    • setKey

      void setKey(String key)
      Sets the key of this cp specification option.
      Parameters:
      key - the key of this cp specification option
    • getPriority

      double getPriority()
      Returns the priority of this cp specification option.
      Returns:
      the priority of this cp specification option
    • setPriority

      void setPriority(double priority)
      Sets the priority of this cp specification option.
      Parameters:
      priority - the priority of this cp specification option
    • getLastPublishDate

      Date getLastPublishDate()
      Returns the last publish date of this cp specification option.
      Returns:
      the last publish date of this cp specification option
    • setLastPublishDate

      void setLastPublishDate(Date lastPublishDate)
      Sets the last publish date of this cp specification option.
      Parameters:
      lastPublishDate - the last publish date of this cp specification option
    • 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

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

      default String toXmlString()