atg.commerce.promotion

Class PromotionImportExportSession

java.lang.Object

atg.commerce.promotion.PromotionImportExportSession

public class PromotionImportExportSession
extends java.lang.Object

This class contains the details of an import export session which uses the Promotions Import Export API.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static int	SESSION_ERROR
static int	SESSION_OK

Constructor Summary

Constructors

Constructor and Description
PromotionImportExportSession()

Method Summary

Modifier and Type	Method and Description
int	decrementPromotionsTransactionCount() Decrement the transaction count
int	getPromotionsTransactionCount() Get the promotions transaction count.
atg.epub.PublishingSession	getPublishingSession() Get the publishing session.
java.lang.String	getSessionId() Get the session id.
int	getSessionStatus() Get the session status.
int	incrementPromotionsTransactionCount() Increment the transaction count
void	setPromotionsTransactionCount(int pPromotionsTransactionCount) Set the promotions transaction count.
void	setPublishingSession(atg.epub.PublishingSession pPublishingSession) Set the publishing session.
void	setSessionId(java.lang.String pSessionId) Set the session id.
void	setSessionStatus(int pSessionStatus) Set the session status.
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

SESSION_OK

public static final int SESSION_OK

See Also:

Constant Field Values

SESSION_ERROR

public static final int SESSION_ERROR

See Also:

Constant Field Values

Constructor Detail

PromotionImportExportSession

public PromotionImportExportSession()

Method Detail

setSessionId

public void setSessionId(java.lang.String pSessionId)

Set the session id. A unique identifier for the promotion import export session.

Parameters:

pSessionId - - the id of the import export session.

getSessionId

public java.lang.String getSessionId()

Get the session id.

Returns:

- the id of the import export session.

setSessionStatus

public void setSessionStatus(int pSessionStatus)

Set the session status. Specifies whether or not the session is in an error state.

Parameters:

pSessionStatus - - the status of the import export session.

getSessionStatus

public int getSessionStatus()

Get the session status.

Returns:

- the status of the import export session.

setPromotionsTransactionCount

public void setPromotionsTransactionCount(int pPromotionsTransactionCount)

Set the promotions transaction count. A count of the successful promotions transactions.

Parameters:

pPromotionsTransactionCount - - the count of transactions in the import export session.

getPromotionsTransactionCount

public int getPromotionsTransactionCount()

Get the promotions transaction count.

Returns:

- the count of transactions in the import export session.

setPublishingSession

public void setPublishingSession(atg.epub.PublishingSession pPublishingSession)

Set the publishing session.

Parameters:

pPublishingSession - - the publishing session associated with the import export session.

getPublishingSession

public atg.epub.PublishingSession getPublishingSession()

Get the publishing session.

Returns:

- the publishing session associated with the import export session.

incrementPromotionsTransactionCount

public int incrementPromotionsTransactionCount()

Increment the transaction count

Returns:

- the new value for promotionsTransactionCount.

decrementPromotionsTransactionCount

public int decrementPromotionsTransactionCount()

Decrement the transaction count

Returns:

- the new value for promotionsTransactionCount.

toString

public java.lang.String toString()

Get information about the class values.

Overrides:

toString in class java.lang.Object

Returns:

- the class data values.