atg.commerce.promotion

Class PromotionImportExportInfo

java.lang.Object

atg.commerce.promotion.PromotionImportExportInfo

public class PromotionImportExportInfo
extends java.lang.Object

This class contains all of the information about a promotion, in relation to the Promotions Import Export API, including coupons and closeness qualifiers.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION_ADD
static int	ACTION_UPDATE
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
PromotionImportExportInfo()

Method Summary

Modifier and Type	Method and Description
int	getAction() Get the action.
java.util.List<ClosenessQualifierImportExportInfo>	getClosenessQualifiers() Get the closeness qualifiers.
java.util.List<CouponImportExportInfo>	getCoupons() Get the associated coupons.
java.lang.String	getPromotionFolderPath() Get the promotion folder path.
java.util.Map<java.lang.String,java.lang.String>	getPromotionPropertyValues() Get the promotion property values.
java.lang.String	getTemplateId() Get the template id.
java.util.Map<java.lang.String,java.lang.String>	getTemplateValues() Get the template values.
void	setAction(int pAction) Set the action.
void	setClosenessQualifiers(java.util.List<ClosenessQualifierImportExportInfo> pClosenessQualifiers) Set the closeness qualifiers.
void	setCoupons(java.util.List<CouponImportExportInfo> pCoupons) Set the coupons.
void	setPromotionFolderPath(java.lang.String pPromotionFolderPath) Set the promotion folder path.
void	setPromotionPropertyValues(java.util.Map<java.lang.String,java.lang.String> pPromotionPropertyValues) Set the promotion property values.
void	setTemplateId(java.lang.String pTemplateId) Set the template id.
void	setTemplateValues(java.util.Map<java.lang.String,java.lang.String> pTemplateValues) Set the template values.
java.lang.String	toString() Get information about the class values.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

ACTION_ADD

public static final int ACTION_ADD

See Also:

Constant Field Values

ACTION_UPDATE

public static final int ACTION_UPDATE

See Also:

Constant Field Values

Constructor Detail

PromotionImportExportInfo

public PromotionImportExportInfo()

Method Detail

setAction

public void setAction(int pAction)

Set the action. Specifies whether the promotion action is to add a new promotion or to update an existing promotion.

Parameters:

pAction - - the promotion action.

getAction

public int getAction()

Get the action.

Returns:

- the promotion action.

setPromotionPropertyValues

public void setPromotionPropertyValues(java.util.Map<java.lang.String,java.lang.String> pPromotionPropertyValues)

Set the promotion property values. This is a map of the promotion property / value pairs. Each map key matches a promotion repository item property name.

Parameters:

pPromotionPropertyValues - - the promotion property values.

getPromotionPropertyValues

public java.util.Map<java.lang.String,java.lang.String> getPromotionPropertyValues()

Get the promotion property values.

Returns:

- the promotion property values.

setPromotionFolderPath

public void setPromotionFolderPath(java.lang.String pPromotionFolderPath)

Set the promotion folder path. This is the logical folder path, associated with the promotion, e.g. "/Summer/Mens/Shoes". It may be null, in which case the promotion remains unassigned. The path gets converted into a series of promotionFolder repository items.

Parameters:

pPromotionFolderPath - - the promotion folder path.

getPromotionFolderPath

public java.lang.String getPromotionFolderPath()

Get the promotion folder path.

Returns:

- the promotion folder path.

setTemplateId

public void setTemplateId(java.lang.String pTemplateId)

Set the template id. This is the id of the template used to create the promotion. It may be null, in which case the PMDL is set using the value in the promotionPropertyValues property map.

Parameters:

pTemplateId - - the promotion template id.

getTemplateId

public java.lang.String getTemplateId()

Get the template id.

Returns:

- the promotion template id.

setTemplateValues

public void setTemplateValues(java.util.Map<java.lang.String,java.lang.String> pTemplateValues)

Set the template values. This is a map of the template place-holder / value pairs. Each map key matches a place-holder in the template.

Parameters:

pTemplateValues - - the promotion template values.

getTemplateValues

public java.util.Map<java.lang.String,java.lang.String> getTemplateValues()

Get the template values.

Returns:

- the promotion template values.

setClosenessQualifiers

public void setClosenessQualifiers(java.util.List<ClosenessQualifierImportExportInfo> pClosenessQualifiers)

Set the closeness qualifiers. These are the closeness qualifiers which are associated with the promotion. Each closeness qualifier is specified in a ClosenessQualifierImportExportInfo object.

Parameters:

pClosenessQualifiers - - the closeness qualifiers associated with the promotion.

getClosenessQualifiers

public java.util.List<ClosenessQualifierImportExportInfo> getClosenessQualifiers()

Get the closeness qualifiers.

Returns:

- the closeness qualifiers associated with the promotion.

setCoupons

public void setCoupons(java.util.List<CouponImportExportInfo> pCoupons)

Set the coupons. These are the coupons which are associated with the promotion, i.e. these coupons grant the promotion to the bearer of the coupon. Each coupon is specified as a CouponImportExportInfo object.

Parameters:

pCoupons - - the coupons associated with the promotion.

getCoupons

public java.util.List<CouponImportExportInfo> getCoupons()

Get the associated coupons.

Returns:

- the coupons associated with the promotion.

toString

public java.lang.String toString()

Get information about the class values.

Overrides:

toString in class java.lang.Object

Returns:

- the class data values.