atg.commerce.promotion

Class CouponImportExportInfo

java.lang.Object

atg.commerce.promotion.CouponImportExportInfo

public class CouponImportExportInfo
extends java.lang.Object

This class contains all of the information about a coupon, in relation to the Promotions Import Export API.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CouponImportExportInfo()

Method Summary

Modifier and Type	Method and Description
int	getAction() Get the action.
java.lang.String	getCouponFolderPath() Get the coupon folder path.
java.util.Map<java.lang.String,java.lang.String>	getCouponPropertyValues() Get the coupon property values.
void	setAction(int pAction) Set the action.
void	setCouponFolderPath(java.lang.String pCouponFolderPath) Set the coupon folder path.
void	setCouponPropertyValues(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues) Set the coupon property 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

ACTION_DELETE

public static final int ACTION_DELETE

See Also:

Constant Field Values

Constructor Detail

CouponImportExportInfo

public CouponImportExportInfo()

Method Detail

setAction

public void setAction(int pAction)

Set the action. Specifies whether the coupon action is to add a new coupon, update an existing one, or delete a coupon.

Parameters:

pAction - - the action to set.

getAction

public int getAction()

Get the action.

Returns:

- the action.

setCouponPropertyValues

public void setCouponPropertyValues(java.util.Map<java.lang.String,java.lang.String> pCouponPropertyValues)

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

Parameters:

pCouponPropertyValues - - the property map to set.

getCouponPropertyValues

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

Get the coupon property values.

Returns:

- the property values map.

setCouponFolderPath

public void setCouponFolderPath(java.lang.String pCouponFolderPath)

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

Parameters:

pCouponFolderPath - - the coupon folder path to set.

getCouponFolderPath

public java.lang.String getCouponFolderPath()

Get the coupon folder path.

Returns:

- the coupon folder path.

toString

public java.lang.String toString()

Get information about the class values.

Overrides:

toString in class java.lang.Object

Returns:

- the class data values.