org.broadleafcommerce.core.catalog.domain

Class RelatedProductDTO

java.lang.Object

org.broadleafcommerce.core.catalog.domain.RelatedProductDTO

public class RelatedProductDTO
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RelatedProductDTO()

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getCategoryId() Returns the categoryId for which the system should find related products.
java.lang.Long	getProductId() Returns the productId for which the system should find related products.
java.lang.Integer	getQuantity() The number of results to return.
RelatedProductTypeEnum	getType() Returns the type of relationship that is desired.
boolean	isCumulativeResults() Returns whether cumulative results are desired.
void	setCategoryId(java.lang.Long categoryId) Sets the categoryId for which the system should find related products.
void	setCumulativeResults(boolean cumulativeResults) Sets whether cumulative results are desired.
void	setProductId(java.lang.Long productId) Sets the productId for which the system should find related products.
void	setQuantity(java.lang.Integer quantity) The number of results to return.
void	setType(RelatedProductTypeEnum type) Sets the type of relationship that is desired.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RelatedProductDTO

public RelatedProductDTO()

Method Detail

getCategoryId

public java.lang.Long getCategoryId()

Returns the categoryId for which the system should find related products.

setCategoryId

public void setCategoryId(java.lang.Long categoryId)

Sets the categoryId for which the system should find related products. May be ignored by implementations if an productId is also specified.

Parameters:

categoryId -

getProductId

public java.lang.Long getProductId()

Returns the productId for which the system should find related products.

setProductId

public void setProductId(java.lang.Long productId)

Sets the productId for which the system should find related products.

Parameters:

productId -

getType

public RelatedProductTypeEnum getType()

Returns the type of relationship that is desired.

Returns:

See Also:

RelatedProductTypeEnum

setType

public void setType(RelatedProductTypeEnum type)

Sets the type of relationship that is desired.

Parameters:

type -

See Also:

RelatedProductTypeEnum

isCumulativeResults

public boolean isCumulativeResults()

Returns whether cumulative results are desired. Defaults to true.

Returns:

setCumulativeResults

public void setCumulativeResults(boolean cumulativeResults)

Sets whether cumulative results are desired.

Parameters:

cumulativeResults -

getQuantity

public java.lang.Integer getQuantity()

The number of results to return. The system will not look for additional results after the quantity has been met. Null indicates to return all results.

Returns:

setQuantity

public void setQuantity(java.lang.Integer quantity)

The number of results to return. Null indicates to return all results.

Parameters:

maxQuantity -