Interface CPOptionValueModel

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

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

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

See Also:
Generated:
  • Method Summary

    Modifier and Type
    Method
    Description
     
     
    long
    Returns the company ID of this cp option value.
    long
    Returns the cp option ID of this cp option value.
    long
    Returns the cp option value ID of this cp option value.
    Returns the create date of this cp option value.
    long
    Returns the ct collection ID of this cp option value.
     
    Returns the external reference code of this cp option value.
    Returns the key of this cp option value.
    Returns the last publish date of this cp option value.
    Returns the modified date of this cp option value.
    long
    Returns the mvcc version of this cp option value.
    Returns the name of this cp option value.
    getName(String languageId)
    Returns the localized name of this cp option value in the language.
    getName(String languageId, boolean useDefault)
    Returns the localized name of this cp option value in the language, optionally using the default language if no localization exists for the requested language.
    getName(Locale locale)
    Returns the localized name of this cp option value in the language.
    getName(Locale locale, boolean useDefault)
    Returns the localized name of this cp option value in the language, optionally using the default language if no localization exists for the requested language.
     
     
    Returns a map of the locales and localized names of this cp option value.
    long
    Returns the primary key of this cp option value.
    double
    Returns the priority of this cp option value.
    long
    Returns the user ID of this cp option value.
    Returns the user name of this cp option value.
    Returns the user uuid of this cp option value.
    Returns the uuid of this cp option value.
    void
     
    void
     
    void
    setCompanyId(long companyId)
    Sets the company ID of this cp option value.
    void
    setCPOptionId(long CPOptionId)
    Sets the cp option ID of this cp option value.
    void
    setCPOptionValueId(long CPOptionValueId)
    Sets the cp option value ID of this cp option value.
    void
    setCreateDate(Date createDate)
    Sets the create date of this cp option value.
    void
    setCtCollectionId(long ctCollectionId)
    Sets the ct collection ID of this cp option value.
    void
    setExternalReferenceCode(String externalReferenceCode)
    Sets the external reference code of this cp option value.
    void
    Sets the key of this cp option value.
    void
    setLastPublishDate(Date lastPublishDate)
    Sets the last publish date of this cp option value.
    void
    setModifiedDate(Date modifiedDate)
    Sets the modified date of this cp option value.
    void
    setMvccVersion(long mvccVersion)
    Sets the mvcc version of this cp option value.
    void
    Sets the name of this cp option value.
    void
    setName(String name, Locale locale)
    Sets the localized name of this cp option value in the language.
    void
    setName(String name, Locale locale, Locale defaultLocale)
    Sets the localized name of this cp option value in the language, and sets the default locale.
    void
     
    void
    Sets the localized names of this cp option value from the map of locales and localized names.
    void
    setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
    Sets the localized names of this cp option value from the map of locales and localized names, and sets the default locale.
    void
    setPrimaryKey(long primaryKey)
    Sets the primary key of this cp option value.
    void
    setPriority(double priority)
    Sets the priority of this cp option value.
    void
    setUserId(long userId)
    Sets the user ID of this cp option value.
    void
    setUserName(String userName)
    Sets the user name of this cp option value.
    void
    setUserUuid(String userUuid)
    Sets the user uuid of this cp option value.
    void
    Sets the uuid of this cp option value.
    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 option value.
      Specified by:
      getPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<CPOptionValue>
      Returns:
      the primary key of this cp option value
    • setPrimaryKey

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

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

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

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

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

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

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

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

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

      long getCPOptionValueId()
      Returns the cp option value ID of this cp option value.
      Returns:
      the cp option value ID of this cp option value
    • setCPOptionValueId

      void setCPOptionValueId(long CPOptionValueId)
      Sets the cp option value ID of this cp option value.
      Parameters:
      CPOptionValueId - the cp option value ID of this cp option value
    • getCompanyId

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      @AutoEscape String getName(String languageId, boolean useDefault)
      Returns the localized name of this cp option value 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 value
    • 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 value.
      Returns:
      the locales and localized names of this cp option value
    • setName

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

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

      void setName(String name, Locale locale, Locale defaultLocale)
      Sets the localized name of this cp option value in the language, and sets the default locale.
      Parameters:
      name - the localized name of this cp option value
      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 value from the map of locales and localized names.
      Parameters:
      nameMap - the locales and localized names of this cp option value
    • setNameMap

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

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

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

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

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

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

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

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

      default String toXmlString()