atg.commerce.promotion

Class PromotionImportExportStatus

java.lang.Object

atg.commerce.promotion.PromotionImportExportStatus

public class PromotionImportExportStatus
extends java.lang.Object

This class details the status information for a promotions import transaction.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static int	STATUS_FAILURE
static int	STATUS_SUCCESS

Constructor Summary

Constructors

Constructor and Description
PromotionImportExportStatus()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorMessage() Get the error message.
java.lang.String	getPromotionId() Get the promotion id.
int	getPromotionStatus() Get the promotion status.
atg.epub.PublishingWorkflowSession	getPublishingSession() Get the publishing workflow session.
PromotionImportExportSession	getSession() Get the session.
void	setErrorMessage(java.lang.String pErrorMessage) Set the error message.
void	setPromotionId(java.lang.String pPromotionId) Set the promotion id.
void	setPromotionStatus(int pPromotionStatus) Set the promotion status.
void	setPublishingSession(atg.epub.PublishingWorkflowSession pPublishingSession) Set the publishing workflow session.
void	setSession(PromotionImportExportSession pSession) Set the session.
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

STATUS_SUCCESS

public static final int STATUS_SUCCESS

See Also:

Constant Field Values

STATUS_FAILURE

public static final int STATUS_FAILURE

See Also:

Constant Field Values

Constructor Detail

PromotionImportExportStatus

public PromotionImportExportStatus()

Method Detail

setPromotionId

public void setPromotionId(java.lang.String pPromotionId)

Set the promotion id. The id of the promotion being imported.

Parameters:

pPromotionId - - the id of the promotion.

getPromotionId

public java.lang.String getPromotionId()

Get the promotion id.

Returns:

- the id of the promotion.

setPromotionStatus

public void setPromotionStatus(int pPromotionStatus)

Set the promotion status. Specifies whether or not the promotion import transaction was successful.

Parameters:

pPromotionStatus - - the status of the promotion import.

getPromotionStatus

public int getPromotionStatus()

Get the promotion status.

Returns:

- the status of the promotion import.

setErrorMessage

public void setErrorMessage(java.lang.String pErrorMessage)

Set the error message. Indicates the nature of the error when the promotionStatus is set to STATUS_FAILURE.

Parameters:

pErrorMessage - - the error message.

getErrorMessage

public java.lang.String getErrorMessage()

Get the error message.

Returns:

- the error message.

setSession

public void setSession(PromotionImportExportSession pSession)

Set the session. Contains the up to date PromotionImportExportSession object.

Parameters:

pSession - - the promotion import export session.

getSession

public PromotionImportExportSession getSession()

Get the session.

Returns:

- the promotion import export session.

setPublishingSession

public void setPublishingSession(atg.epub.PublishingWorkflowSession pPublishingSession)

Set the publishing workflow session.

Parameters:

pPublishingSession - - the promotion publishing session.

getPublishingSession

public atg.epub.PublishingWorkflowSession getPublishingSession()

Get the publishing workflow session.

Returns:

- the promotion publishing session.

toString

public java.lang.String toString()

Get information about the class values.

Overrides:

toString in class java.lang.Object

Returns:

- the class data values.