com.elasticpath.domain.catalog
Interface ProductType

All Superinterfaces:
Entity, EpDomain, Persistence, java.io.Serializable
All Known Implementing Classes:
ProductTypeImpl

public interface ProductType
extends Entity

Represents the type of a Product, which determines the set of attributes that it has. An example of a product type is "Shoe." Note that this differs from a product category, which might also be called "Shoes" because this describes the characteristics of the product rather than how they are displayed and organized in the store.


Method Summary
 java.lang.String getDescription()
          Get the product type description.
 java.lang.String getName()
          Get the product type name.
 AttributeGroup getProductAttributeGroup()
          Returns the product attribute group.
 AttributeGroup getSkuAttributeGroup()
          Returns the product sku attribute group.
 java.util.Set getSkuOptions()
          Gets the available options for configuring SKUs of this product.
 java.util.Set getSkuOptions(ProductSku defaultSku)
          Gets the available options for configuring SKUs of this product.
 TaxCode getTaxCode()
          Returns the TaxCode associated with this ProductType.
 java.lang.String getTemplate()
          Get the display template of this category.
 boolean isWithMultipleSkus()
          Returns true if the product type may have multiple skus.
 void setDescription(java.lang.String description)
          Set the product type description.
 void setName(java.lang.String name)
          Set the product type name.
 void setProductAttributeGroup(AttributeGroup productAttributeGroup)
          Sets the product attribute group.
 void setSkuAttributeGroup(AttributeGroup skuAttributeGroup)
          Sets the product sku attribute group.
 void setSkuOptions(java.util.Set skuOptions)
          Sets the available options for configuring SKUs of this product.
 void setTaxCode(TaxCode taxCode)
          Set the TaxCode associated with this ProductType.
 void setTemplate(java.lang.String template)
          Set the template.
 void setWithMultipleSkus(boolean multipleSkuFlag)
          Sets multiple sku flag.
 
Methods inherited from interface com.elasticpath.domain.Entity
getGuid, setGuid
 
Methods inherited from interface com.elasticpath.domain.Persistence
executeBeforePersistAction, getUidPk, isPersistent, setDefaultValues, setUidPk
 
Methods inherited from interface com.elasticpath.domain.EpDomain
getElasticPath, setElasticPath
 

Method Detail

getDescription

java.lang.String getDescription()
Get the product type description.

Returns:
the product type description

getName

java.lang.String getName()
Get the product type name.

Returns:
the product type name

getProductAttributeGroup

AttributeGroup getProductAttributeGroup()
Returns the product attribute group.

Returns:
the product attribute group

getSkuAttributeGroup

AttributeGroup getSkuAttributeGroup()
Returns the product sku attribute group.

Returns:
the product sku attribute group

getSkuOptions

java.util.Set getSkuOptions()
Gets the available options for configuring SKUs of this product.

Returns:
the set of options for configuring SKUs of this product or null if there are no configurable options

getSkuOptions

java.util.Set getSkuOptions(ProductSku defaultSku)
Gets the available options for configuring SKUs of this product. Updates the default SKU option values based on the values specified in a given default SKU.

Parameters:
defaultSku - the SKU whose option values are to be the defaults for the given options
Returns:
the set of options for configuring SKUs of this product or null if there are no configurable options

getTaxCode

TaxCode getTaxCode()
Returns the TaxCode associated with this ProductType.

Returns:
the TaxCode

getTemplate

java.lang.String getTemplate()
Get the display template of this category.

Returns:
the template

isWithMultipleSkus

boolean isWithMultipleSkus()
Returns true if the product type may have multiple skus.

Returns:
true if the product type has multiple skus

setDescription

void setDescription(java.lang.String description)
Set the product type description.

Parameters:
description - the product type description

setName

void setName(java.lang.String name)
Set the product type name.

Parameters:
name - the product type name

setProductAttributeGroup

void setProductAttributeGroup(AttributeGroup productAttributeGroup)
Sets the product attribute group.

Parameters:
productAttributeGroup - the product attribute group.

setSkuAttributeGroup

void setSkuAttributeGroup(AttributeGroup skuAttributeGroup)
Sets the product sku attribute group.

Parameters:
skuAttributeGroup - the product attribute group.

setSkuOptions

void setSkuOptions(java.util.Set skuOptions)
Sets the available options for configuring SKUs of this product.

Parameters:
skuOptions - the set of available options for configuring SKUs of this product

setTaxCode

void setTaxCode(TaxCode taxCode)
Set the TaxCode associated with this ProductType.

Parameters:
taxCode - - the tax code for this product type, i.e. "BOOKS".

setTemplate

void setTemplate(java.lang.String template)
Set the template.

Parameters:
template - the template

setWithMultipleSkus

void setWithMultipleSkus(boolean multipleSkuFlag)
Sets multiple sku flag.

Parameters:
multipleSkuFlag - sets it to true if the product type may have multiple skus.