com.ibm.commerce.marketing.facade.datatypes

Interface MarketingSpotStatisticsType

public interface MarketingSpotStatisticsType

A representation of the model object 'Spot Statistics Type'. The statistics related to the running of activities on an e-Marketing Spot.

The following features are supported:

• Marketing Spot Identifier
• Views
• Clicks
• Click Ratio
• User Data

See Also:

MarketingPackage.getMarketingSpotStatisticsType()

Method Summary

Modifier and Type	Method and Description
double	getClickRatio() Returns the value of the 'Click Ratio' attribute.
java.math.BigInteger	getClicks() Returns the value of the 'Clicks' attribute.
MarketingSpotIdentifierType	getMarketingSpotIdentifier() Returns the value of the 'Marketing Spot Identifier' containment reference.
UserDataType	getUserData() Returns the value of the 'User Data' containment reference.
java.math.BigInteger	getViews() Returns the value of the 'Views' attribute.
boolean	isSetClickRatio() Returns whether the value of the 'Click Ratio' attribute is set.
void	setClickRatio(double value) Sets the value of the 'Click Ratio' attribute.
void	setClicks(java.math.BigInteger value) Sets the value of the 'Clicks' attribute.
void	setMarketingSpotIdentifier(MarketingSpotIdentifierType value) Sets the value of the 'Marketing Spot Identifier' containment reference.
void	setUserData(UserDataType value) Sets the value of the 'User Data' containment reference.
void	setViews(java.math.BigInteger value) Sets the value of the 'Views' attribute.
void	unsetClickRatio() Unsets the value of the 'Click Ratio' attribute.

Method Detail

getMarketingSpotIdentifier

MarketingSpotIdentifierType getMarketingSpotIdentifier()

Returns the value of the 'Marketing Spot Identifier' containment reference. The unique identifier of the e-marketing spot.

Returns:

the value of the 'Marketing Spot Identifier' containment reference.

See Also:

setMarketingSpotIdentifier(MarketingSpotIdentifierType), MarketingPackage.getMarketingSpotStatisticsType_MarketingSpotIdentifier()

setMarketingSpotIdentifier

void setMarketingSpotIdentifier(MarketingSpotIdentifierType value)

Sets the value of the 'Marketing Spot Identifier' containment reference.

Parameters:

value - the new value of the 'Marketing Spot Identifier' containment reference.

See Also:

getMarketingSpotIdentifier()

getViews

java.math.BigInteger getViews()

Returns the value of the 'Views' attribute. The number of times the e-marketing spot was viewed associated with this activity.

Returns:

the value of the 'Views' attribute.

See Also:

setViews(BigInteger), MarketingPackage.getMarketingSpotStatisticsType_Views()

setViews

void setViews(java.math.BigInteger value)

Sets the value of the 'Views' attribute.

Parameters:

value - the new value of the 'Views' attribute.

See Also:

getViews()

getClicks

java.math.BigInteger getClicks()

Returns the value of the 'Clicks' attribute. The number of times the e-marketing spot was clicked associated with this activity.

Returns:

the value of the 'Clicks' attribute.

See Also:

setClicks(BigInteger), MarketingPackage.getMarketingSpotStatisticsType_Clicks()

setClicks

void setClicks(java.math.BigInteger value)

Sets the value of the 'Clicks' attribute.

Parameters:

value - the new value of the 'Clicks' attribute.

See Also:

getClicks()

getClickRatio

double getClickRatio()

Returns the value of the 'Click Ratio' attribute. The ratio of the number of times the e-marketing spot was clicked to the number of times the e-marketing spot was viewed.

Returns:

the value of the 'Click Ratio' attribute.

See Also:

isSetClickRatio(), unsetClickRatio(), setClickRatio(double), MarketingPackage.getMarketingSpotStatisticsType_ClickRatio()

setClickRatio

void setClickRatio(double value)

Sets the value of the 'Click Ratio' attribute.

Parameters:

value - the new value of the 'Click Ratio' attribute.

See Also:

isSetClickRatio(), unsetClickRatio(), getClickRatio()

unsetClickRatio

void unsetClickRatio()

Unsets the value of the 'Click Ratio' attribute.

See Also:

isSetClickRatio(), getClickRatio(), setClickRatio(double)

isSetClickRatio

boolean isSetClickRatio()

Returns whether the value of the 'Click Ratio' attribute is set.

Returns:

whether the value of the 'Click Ratio' attribute is set.

See Also:

unsetClickRatio(), getClickRatio(), setClickRatio(double)

getUserData

UserDataType getUserData()

Returns the value of the 'User Data' containment reference. User Data.

Returns:

the value of the 'User Data' containment reference.

See Also:

setUserData(UserDataType), MarketingPackage.getMarketingSpotStatisticsType_UserData()

setUserData

void setUserData(UserDataType value)

Sets the value of the 'User Data' containment reference.

Parameters:

value - the new value of the 'User Data' containment reference.

See Also:

getUserData()