com.broadleafcommerce.contenttests.domain

Interface ContentTestGoal

All Superinterfaces:

org.broadleafcommerce.common.copy.MultiTenantCloneable<ContentTestGoal>, Serializable

All Known Implementing Classes:

ContentTestGoalImpl

public interface ContentTestGoal
extends Serializable, org.broadleafcommerce.common.copy.MultiTenantCloneable<ContentTestGoal>

Basic interface for Content Goals. For integrations with 3rd party providers, we should normally be able to represent the goals as a string id. For example, with google experiments, the goal reference would be something like "ga:timeOnSite". See specific 3rd party integration documentation for details on the required format.

Author:

bpolster

Method Summary

Modifier and Type	Method and Description
GoalOptimizationType	getDefaultOptimizationType() Returns the optimization type for this goal.
Long	getId() Returns the id for the goal.
String	getName() Returns the friendly name of this goal
String	getReference() Returns the reference name for this goal.
void	setDefaultOptimizationType(GoalOptimizationType defaultOptimizationType) Sets the GoalOptimizationType.
void	setId(Long id) Sets the id for the goal.
void	setName(String name) Sets the friendly name of this goal
void	setReference(String reference) Sets the reference for this goal.

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

createOrRetrieveCopyInstance

Method Detail

getId

Long getId()

Returns the id for the goal.

Returns:

setId

void setId(Long id)

Sets the id for the goal.

getName

String getName()

Returns the friendly name of this goal

Returns:

setName

void setName(String name)

Sets the friendly name of this goal

getReference

String getReference()

Returns the reference name for this goal. Generally intended for use as the string representation required by a third party integration.

Returns:

setReference

void setReference(String reference)

Sets the reference for this goal.

Parameters:

reference -

See Also:

getReference()

getDefaultOptimizationType

GoalOptimizationType getDefaultOptimizationType()

Returns the optimization type for this goal. If not set, returns GoalOptimizationType.MAXIMUM.

Returns:

setDefaultOptimizationType

void setDefaultOptimizationType(GoalOptimizationType defaultOptimizationType)

Sets the GoalOptimizationType. If null or default is passed in, the type will be set to GoalOptimizationType.MAXIMUM.

Parameters:

defaultOptimizationType -