Package com.broadleafcommerce.catalog.web.endpoint.dto

Class OptionGenerationRequest

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.dto.OptionGenerationRequest

All Implemented Interfaces:

Serializable

public class OptionGenerationRequest
extends Object
implements Serializable

DTO representing a request to generate a Product's options from a OptionTemplate or OptionTemplateGroup.

Author:

Nathan Moore (nathandmoore)

See Also:

• OptionTemplate
• OptionTemplateGroup
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OptionGenerationRequest()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getGenerationType()	The type of the generation: Either OptionGenerationType.TEMPLATE or OptionGenerationType.TEMPLATE_GROUP.
String	getOptionTemplateGroupId()	A direct getter for the ID of the OptionTemplateGroup to be used for generating options for a product.
String	getOptionTemplateId()	A direct getter for the ID of the OptionTemplate to be used for generating options for a product.
String	getProductId()	ID of the Product for which options should be generated.
OptionTemplateRef	getTemplate()	The OptionTemplateRef of the OptionTemplate to be used for generating options for a product if the generationType is OptionGenerationType.TEMPLATE, then this field is used.
OptionTemplateGroupRef	getTemplateGroup()	The OptionTemplateGroupRef of the OptionTemplateGroup to be used for generating options for a product if the generationType is OptionGenerationType.TEMPLATE_GROUP, then this field is used.
int	hashCode()
void	setGenerationType(String generationType)	The type of the generation: Either OptionGenerationType.TEMPLATE or OptionGenerationType.TEMPLATE_GROUP.
void	setProductId(String productId)	ID of the Product for which options should be generated.
void	setTemplate(OptionTemplateRef template)	The OptionTemplateRef of the OptionTemplate to be used for generating options for a product if the generationType is OptionGenerationType.TEMPLATE, then this field is used.
void	setTemplateGroup(OptionTemplateGroupRef templateGroup)	The OptionTemplateGroupRef of the OptionTemplateGroup to be used for generating options for a product if the generationType is OptionGenerationType.TEMPLATE_GROUP, then this field is used.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OptionGenerationRequest

public OptionGenerationRequest()

Method Details

getOptionTemplateId

public String getOptionTemplateId()

A direct getter for the ID of the OptionTemplate to be used for generating options for a product.

Returns:

The ID of the OptionTemplate

getOptionTemplateGroupId

public String getOptionTemplateGroupId()

A direct getter for the ID of the OptionTemplateGroup to be used for generating options for a product.

Returns:

The ID of the OptionTemplateGroup

getProductId

public String getProductId()

ID of the Product for which options should be generated.

Returns:

ID of the Product for which options should be generated.

getGenerationType

public String getGenerationType()

The type of the generation: Either OptionGenerationType.TEMPLATE or OptionGenerationType.TEMPLATE_GROUP.

Returns:

The type of the generation

getTemplate

public OptionTemplateRef getTemplate()

The OptionTemplateRef of the OptionTemplate to be used for generating options for a product if the generationType is OptionGenerationType.TEMPLATE, then this field is used.

Returns:

The OptionTemplateRef to be used for generating options for a product

getTemplateGroup

public OptionTemplateGroupRef getTemplateGroup()

The OptionTemplateGroupRef of the OptionTemplateGroup to be used for generating options for a product if the generationType is OptionGenerationType.TEMPLATE_GROUP, then this field is used.

Returns:

The OptionTemplateGroupRef to be used for generating options for a product

setProductId

public void setProductId(String productId)

ID of the Product for which options should be generated.

Parameters:

productId - ID of the Product for which options should be generated.

setGenerationType

public void setGenerationType(String generationType)

The type of the generation: Either OptionGenerationType.TEMPLATE or OptionGenerationType.TEMPLATE_GROUP.

Parameters:

generationType - The type of the generation

setTemplate

public void setTemplate(OptionTemplateRef template)

The OptionTemplateRef of the OptionTemplate to be used for generating options for a product if the generationType is OptionGenerationType.TEMPLATE, then this field is used.

Parameters:

optionTemplate - The OptionTemplateRef to be used for generating options for a product

setTemplateGroup

public void setTemplateGroup(OptionTemplateGroupRef templateGroup)

The OptionTemplateGroupRef of the OptionTemplateGroup to be used for generating options for a product if the generationType is OptionGenerationType.TEMPLATE_GROUP, then this field is used.

Parameters:

optionTemplate - The OptionTemplateGroupRef to be used for generating options for a product

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object