Interface CPOptionModel

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

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

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

See Also:
Generated:
  • Method Details

    • getPrimaryKey

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

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

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

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

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

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

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

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

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

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

      long getCPOptionId()
      Returns the cp option ID of this cp option.
      Returns:
      the cp option ID of this cp option
    • setCPOptionId

      void setCPOptionId(long CPOptionId)
      Sets the cp option ID of this cp option.
      Parameters:
      CPOptionId - the cp option ID of this cp option
    • getCompanyId

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

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

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

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

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

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

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

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

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

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

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

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

      String getName()
      Returns the name of this cp option.
      Returns:
      the name of this cp option
    • getName

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

      @AutoEscape String getName(Locale locale, boolean useDefault)
      Returns the localized name of this cp 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 name of this cp option. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getName

      @AutoEscape String getName(String languageId)
      Returns the localized name of this cp 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 name of this cp option
    • getName

      @AutoEscape String getName(String languageId, boolean useDefault)
      Returns the localized name of this cp 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 name of this cp option
    • getNameCurrentLanguageId

      @AutoEscape String getNameCurrentLanguageId()
    • getNameCurrentValue

      @AutoEscape String getNameCurrentValue()
    • getNameMap

      Map<Locale,String> getNameMap()
      Returns a map of the locales and localized names of this cp option.
      Returns:
      the locales and localized names of this cp option
    • setName

      void setName(String name)
      Sets the name of this cp option.
      Parameters:
      name - the name of this cp option
    • setName

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

      void setName(String name, Locale locale, Locale defaultLocale)
      Sets the localized name of this cp option in the language, and sets the default locale.
      Parameters:
      name - the localized name of this cp option
      locale - the locale of the language
      defaultLocale - the default locale
    • setNameCurrentLanguageId

      void setNameCurrentLanguageId(String languageId)
    • setNameMap

      void setNameMap(Map<Locale,String> nameMap)
      Sets the localized names of this cp option from the map of locales and localized names.
      Parameters:
      nameMap - the locales and localized names of this cp option
    • setNameMap

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

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

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

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

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

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

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

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

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

      @AutoEscape String getCommerceOptionTypeKey()
      Returns the commerce option type key of this cp option.
      Returns:
      the commerce option type key of this cp option
    • setCommerceOptionTypeKey

      void setCommerceOptionTypeKey(String commerceOptionTypeKey)
      Sets the commerce option type key of this cp option.
      Parameters:
      commerceOptionTypeKey - the commerce option type key of this cp option
    • getFacetable

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

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

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

      boolean getRequired()
      Returns the required of this cp option.
      Returns:
      the required of this cp option
    • isRequired

      boolean isRequired()
      Returns true if this cp option is required.
      Returns:
      true if this cp option is required; false otherwise
    • setRequired

      void setRequired(boolean required)
      Sets whether this cp option is required.
      Parameters:
      required - the required of this cp option
    • getSkuContributor

      boolean getSkuContributor()
      Returns the sku contributor of this cp option.
      Returns:
      the sku contributor of this cp option
    • isSkuContributor

      boolean isSkuContributor()
      Returns true if this cp option is sku contributor.
      Returns:
      true if this cp option is sku contributor; false otherwise
    • setSkuContributor

      void setSkuContributor(boolean skuContributor)
      Sets whether this cp option is sku contributor.
      Parameters:
      skuContributor - the sku contributor of this cp option
    • getKey

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

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

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

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

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

      default String toXmlString()