com.ibm.commerce.marketing.promotion.choice

Interface PromotionRewardOptionPersistenceManager

All Superinterfaces:

java.io.Serializable, XMLizable

public interface PromotionRewardOptionPersistenceManager
extends XMLizable

The interface for PromotionRewardOptionPersistenceManager that handles PromotionRewardOption records.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_NAME_IMPL XML attribute name - impl
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	TAG_PROMOTION_REWARD_OPTION_PERSISTENCE_MANAGER XML tag - PromotionRewardOptionPersistenceManager
static java.lang.String	XML_DOCUMENT_HEADER XML document header - <?xml version=\"1.0\" encoding=\"UTF-8\"?>

Method Summary

Modifier and Type	Method and Description
void	createPromotionRewardOption(RewardOption aRewardOption) Creates a PromotionRewardOption record.
java.util.List	findPromotionRewardOptionByOrderKey(OrderKey aOrderKey) Finds all RewardOption with the specified OrderKey.
RewardOption	loadPromotionRewardOption(PromotionRewardOptionKey aPromotionRewardOptionKey) Load a RewardOption according to the PromotionRewardOptionKey.
void	removePromotionRewardOption(PromotionRewardOptionKey aPromotionRewardOptionKey) Removes the PromotionRewardOption record.
void	removePromotionRewardOptionByOrderKey(OrderKey aOrderKey) Removes the PromotionRewardOption records according to the OrderKey.
void	resetCache() Reset cache.
void	updatePromotionRewardOption(RewardOption aRewardOption) Updates the PromotionRewardOption record.
void	updatePromotionRewardOptionChoice(PromotionRewardOptionKey aPromotionRewardOptionKey, RewardChoice aRewardChoice) Updates the RewardChoice of the PromotionRewardOption.

Methods inherited from interface com.ibm.commerce.marketing.promotion.xml.XMLizable

fromXML, toXML

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

TAG_PROMOTION_REWARD_OPTION_PERSISTENCE_MANAGER

static final java.lang.String TAG_PROMOTION_REWARD_OPTION_PERSISTENCE_MANAGER

XML tag - PromotionRewardOptionPersistenceManager

See Also:

Constant Field Values

ATTRIBUTE_NAME_IMPL

static final java.lang.String ATTRIBUTE_NAME_IMPL

XML attribute name - impl

See Also:

Constant Field Values

XML_DOCUMENT_HEADER

static final java.lang.String XML_DOCUMENT_HEADER

XML document header - <?xml version=\"1.0\" encoding=\"UTF-8\"?>

See Also:

Constant Field Values

Method Detail

loadPromotionRewardOption

RewardOption loadPromotionRewardOption(PromotionRewardOptionKey aPromotionRewardOptionKey)
                                throws PersistenceObjectNotFoundException,
                                       PersistenceObjectReadException

Load a RewardOption according to the PromotionRewardOptionKey.

Parameters:

aPromotionRewardOptionKey - The key of RewardOption.

Returns:

The PromotionRewardOption object.

Throws:

PersistenceObjectNotFoundException - if the PromotionRewardOption object is not found

PersistenceObjectReadException - if the PromotionRewardOption object can not be read properly from the database.

findPromotionRewardOptionByOrderKey

java.util.List findPromotionRewardOptionByOrderKey(OrderKey aOrderKey)
                                            throws PersistenceObjectNotFoundException,
                                                   PersistenceObjectReadException

Finds all RewardOption with the specified OrderKey.

Parameters:

aOrderKey - The OrderKey.

Returns:

A list of RewardOption with the specified OrderKey.

Throws:

PersistenceObjectNotFoundException - if the PromotionRewardOption objects are not found

PersistenceObjectReadException - if the PromotionRewardOption object can not be read properly from the database.

createPromotionRewardOption

void createPromotionRewardOption(RewardOption aRewardOption)
                          throws PersistenceObjectAlreadyExistsException,
                                 PersistenceCreateException

Creates a PromotionRewardOption record.

Parameters:

aRewardOption - The RewardOption object to create.

Throws:

PersistenceObjectAlreadyExistsException - when the PromotionRewardOption already exists

PersistenceCreateException - when creating the PromotionRewardOption fails

updatePromotionRewardOption

void updatePromotionRewardOption(RewardOption aRewardOption)
                          throws PersistenceObjectNotFoundException,
                                 PersistenceObjectWriteException

Updates the PromotionRewardOption record.

Parameters:

aRewardOption - The RewardOption object to update.

Throws:

PersistenceObjectNotFoundException - when this PromotionRewardOption object does not exist in the database.

PersistenceObjectWriteException - when it fails to write this PromotionRewardOption to DB.

updatePromotionRewardOptionChoice

void updatePromotionRewardOptionChoice(PromotionRewardOptionKey aPromotionRewardOptionKey,
                                       RewardChoice aRewardChoice)
                                throws PersistenceObjectNotFoundException,
                                       PersistenceObjectWriteException

Updates the RewardChoice of the PromotionRewardOption.

Parameters:

aPromotionRewardOptionKey - The key for the PromotionRewardOption record.

aRewardChoice - The RewardChoice to be updated.

Throws:

PersistenceObjectNotFoundException - when this PromotionRewardOption object does not exist in the database.

PersistenceObjectWriteException - when it fails to write this PromotionRewardOption to DB.

removePromotionRewardOption

void removePromotionRewardOption(PromotionRewardOptionKey aPromotionRewardOptionKey)
                          throws PersistenceObjectNotFoundException,
                                 PersistenceRemoveException

Removes the PromotionRewardOption record.

Parameters:

aPromotionRewardOptionKey - The key for the PromotionRewardOption record.

Throws:

PersistenceObjectNotFoundException - when the object to be removed does not exist in the database.

PersistenceRemoveException - when the object removal fails.

removePromotionRewardOptionByOrderKey

void removePromotionRewardOptionByOrderKey(OrderKey aOrderKey)
                                    throws PersistenceObjectNotFoundException,
                                           PersistenceRemoveException

Removes the PromotionRewardOption records according to the OrderKey.

Parameters:

aOrderKey - The OrderKey for PromotionRewardOption records.

Throws:

PersistenceObjectNotFoundException - when the object to be removed does not exist in the database.

PersistenceRemoveException - when the object removal fails.

resetCache

void resetCache()

Reset cache.