com.elasticpath.domain.catalog
Interface ProductLoadTuner

All Superinterfaces:
EpDomain, java.io.Serializable, Transient
All Known Implementing Classes:
ProductLoadTunerImpl

public interface ProductLoadTuner
extends Transient

Represents a tuner to control product load. A product load tuner can be used in some services to fine control what data to be loaded for a product. The main purpose is to achieve maximum performance for some specific performance-critical pages.


Method Summary
 boolean contains(ProductLoadTuner productLoadTuner)
          Returns true if this load tuner is super set of the given load tuner, otherwise, false.
 ProductSkuLoadTuner getProductSkuLoadTuner()
          Returns the ProductSkuLoadTuner.
 ProductTypeLoadTuner getProductTypeLoadTuner()
          Returns the ProductTypeLoadTuner.
 boolean isLoadingAttributeValue()
          Return true if attribute value is requested.
 boolean isLoadingCategories()
          Return true if category is requested.
 boolean isLoadingDefaultCategory()
          Return true if default category is requested.
 boolean isLoadingDefaultSku()
          Return true if default sku is requested.
 boolean isLoadingPrice()
          Return true if price is requested.
 boolean isLoadingProductAssociations()
          Return true if product association is requested.
 boolean isLoadingProductType()
          Return true if sku product type requested.
 boolean isLoadingSkus()
          Return true if sku is requested.
 ProductLoadTuner merge(ProductLoadTuner productLoadTuner)
          Merges the given product load tuner with this one and returns the merged product load tuner.
 void setLoadingAttributeValue(boolean flag)
          Sets the flag of loading attribute values.
 void setLoadingCategories(boolean flag)
          Sets the flag of loading categories.
 void setLoadingDefaultCategory(boolean flag)
          Sets the flag of loading default category.
 void setLoadingDefaultSku(boolean flag)
          Sets the flag of loading default sku.
 void setLoadingPrice(boolean flag)
          Sets the flag of loading price.
 void setLoadingProductAssociations(boolean flag)
          Sets the flag of loading product associations.
 void setLoadingProductType(boolean flag)
          Sets the flag of loading product type.
 void setLoadingSkus(boolean flag)
          Sets the flag of loading skus.
 void setProductSkuLoadTuner(ProductSkuLoadTuner tuner)
          Sets the ProductSkuLoadTuner.
 void setProductTypeLoadTuner(ProductTypeLoadTuner tuner)
          Sets the ProductTypeLoadTuner.
 
Methods inherited from interface com.elasticpath.domain.EpDomain
getElasticPath, setElasticPath
 

Method Detail

contains

boolean contains(ProductLoadTuner productLoadTuner)
Returns true if this load tuner is super set of the given load tuner, otherwise, false.

Parameters:
productLoadTuner - the product load tuner
Returns:
true if this load tuner is super set of the given load tuner, otherwise, false

getProductSkuLoadTuner

ProductSkuLoadTuner getProductSkuLoadTuner()
Returns the ProductSkuLoadTuner.

Returns:
the ProductSkuLoadTuner

getProductTypeLoadTuner

ProductTypeLoadTuner getProductTypeLoadTuner()
Returns the ProductTypeLoadTuner.

Returns:
the ProductTypeLoadTuner

isLoadingAttributeValue

boolean isLoadingAttributeValue()
Return true if attribute value is requested.

Returns:
true if attribute value is requested.

isLoadingCategories

boolean isLoadingCategories()
Return true if category is requested.

Returns:
true if category is requested.

isLoadingDefaultCategory

boolean isLoadingDefaultCategory()
Return true if default category is requested.

Returns:
true if default category is requested.

isLoadingDefaultSku

boolean isLoadingDefaultSku()
Return true if default sku is requested.

Returns:
true if default sku is requested.

isLoadingPrice

boolean isLoadingPrice()
Return true if price is requested.

Returns:
true if price is requested.

isLoadingProductAssociations

boolean isLoadingProductAssociations()
Return true if product association is requested.

Returns:
true if product association is requested.

isLoadingProductType

boolean isLoadingProductType()
Return true if sku product type requested.

Returns:
true if sku product type requested.

isLoadingSkus

boolean isLoadingSkus()
Return true if sku is requested.

Returns:
true if sku is requested.

merge

ProductLoadTuner merge(ProductLoadTuner productLoadTuner)
Merges the given product load tuner with this one and returns the merged product load tuner.

Parameters:
productLoadTuner - the product load tuner
Returns:
the merged product load tuner

setLoadingAttributeValue

void setLoadingAttributeValue(boolean flag)
Sets the flag of loading attribute values.

Parameters:
flag - sets it to true to request loading attribute values.

setLoadingCategories

void setLoadingCategories(boolean flag)
Sets the flag of loading categories.

Parameters:
flag - sets it to true to request loading categories.

setLoadingDefaultCategory

void setLoadingDefaultCategory(boolean flag)
Sets the flag of loading default category.

Parameters:
flag - sets it to true to request loading default category.

setLoadingDefaultSku

void setLoadingDefaultSku(boolean flag)
Sets the flag of loading default sku.

Parameters:
flag - sets it to true to request loading default sku.

setLoadingPrice

void setLoadingPrice(boolean flag)
Sets the flag of loading price.

Parameters:
flag - sets it to true to request loading price.

setLoadingProductAssociations

void setLoadingProductAssociations(boolean flag)
Sets the flag of loading product associations.

Parameters:
flag - sets it to true to request loading product associations.

setLoadingProductType

void setLoadingProductType(boolean flag)
Sets the flag of loading product type.

Parameters:
flag - sets it to true to request loading product type.

setLoadingSkus

void setLoadingSkus(boolean flag)
Sets the flag of loading skus.

Parameters:
flag - sets it to true to request loading skus.

setProductSkuLoadTuner

void setProductSkuLoadTuner(ProductSkuLoadTuner tuner)
Sets the ProductSkuLoadTuner.

Parameters:
tuner - the ProductSkuLoadTuner

setProductTypeLoadTuner

void setProductTypeLoadTuner(ProductTypeLoadTuner tuner)
Sets the ProductTypeLoadTuner.

Parameters:
tuner - the ProductTypeLoadTuner