com.elasticpath.domain.catalog
Interface CategoryLoadTuner

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

public interface CategoryLoadTuner
extends Transient

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


Method Summary
 CategoryTypeLoadTuner getCategoryTypeLoadTuner()
          Returns the CategoryTypeLoadTuner.
 boolean isLoadingAttributeValue()
          Return true if attribute value is requested.
 boolean isLoadingCategoryType()
          Return true if category type requested.
 boolean isLoadingChildren()
          Return true if children is requested.
 boolean isLoadingParent()
          Return true if parent is requested.
 void setCategoryTypeLoadTuner(CategoryTypeLoadTuner tuner)
          Sets the CategoryTypeLoadTuner.
 void setLoadingAttributeValue(boolean flag)
          Sets the flag of loading attribute values.
 void setLoadingCategoryType(boolean flag)
          Sets the flag of loading category type.
 void setLoadingChildren(boolean flag)
          Sets the flag of loading children.
 void setLoadingParent(boolean flag)
          Sets the flag of loading parent.
 
Methods inherited from interface com.elasticpath.domain.EpDomain
getElasticPath, setElasticPath
 

Method Detail

getCategoryTypeLoadTuner

CategoryTypeLoadTuner getCategoryTypeLoadTuner()
Returns the CategoryTypeLoadTuner.

Returns:
the CategoryTypeLoadTuner

isLoadingAttributeValue

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

Returns:
true if attribute value is requested.

isLoadingCategoryType

boolean isLoadingCategoryType()
Return true if category type requested.

Returns:
true if category type requested.

isLoadingChildren

boolean isLoadingChildren()
Return true if children is requested.

Returns:
true if children is requested.

isLoadingParent

boolean isLoadingParent()
Return true if parent is requested.

Returns:
true if parent is requested.

setCategoryTypeLoadTuner

void setCategoryTypeLoadTuner(CategoryTypeLoadTuner tuner)
Sets the CategoryTypeLoadTuner.

Parameters:
tuner - the CategoryTypeLoadTuner

setLoadingAttributeValue

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

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

setLoadingCategoryType

void setLoadingCategoryType(boolean flag)
Sets the flag of loading category type.

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

setLoadingChildren

void setLoadingChildren(boolean flag)
Sets the flag of loading children.

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

setLoadingParent

void setLoadingParent(boolean flag)
Sets the flag of loading parent.

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