com.ibm.commerce.marketing.promotion

Interface PromotionPersistenceManager

All Superinterfaces:

KeyResolver, java.io.Serializable, XMLizable

public interface PromotionPersistenceManager
extends XMLizable, KeyResolver

This interface represents the Promotion Persistence Manager and its implementation class should be specified in promotion engine configuration file.
At runtime the caller can call PersistenceManagerRegistry.getInstance().getPromotionPersistenceManager() to get the object of the PromotionPersistenceManager implementation class.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright

Method Summary

Modifier and Type	Method and Description
void	changePromotionStatus(PromotionKey key, int status) Changes the status of a promotion.
void	changePromotionStatus(PromotionKey key, int status, java.util.HashMap sessionData) Deprecated.
void	create(Promotion pro) Creates a new promotion.
void	create(Promotion pro, java.util.HashMap sessionData) Deprecated.
PromotionKey	findActivePromotionByCodeAndStoreID(java.lang.String code, java.lang.Integer storeID) Finds all promotions by their code (visualCue) and storeID.
PromotionKey[]	findActivePromotionByCodePatternAndStoreID(java.lang.String code, java.lang.Integer storeID) Finds all promotions by their code (visualCue) and storeID.
PromotionKey	findActivePromotionByNameAndStoreID(java.lang.String name, java.lang.Integer storeID) Finds all active promotions by their Name and storeID.
PromotionKey[]	findActivePromotionByStoreIDAndDate(java.lang.Integer storeID, java.sql.Timestamp aStartDate, java.sql.Timestamp aEndDate) Finds all active promotions of a store that has its start date is before the specified date and its end date is after the specified date.
PromotionKey[]	findActivePromotionsInAGroupByDate(com.ibm.commerce.marketing.promotion.group.PromotionGroupKey aGroupKey, java.sql.Timestamp aStartDate, java.sql.Timestamp aEndDate) Finds all active promotions in a promotion group that has its start date is before the specified date and its end date is after the specified date.
PromotionKey	findCurrentPromotionByNameAndStoreID(java.lang.String name, java.lang.Integer storeID) Finds all promotions that are either active, inactive or suspended, but not deleted or obsolete by their Name and storeID.
PromotionKey	findCurrentPromotionByNameVersionAndStoreID(java.lang.String name, java.lang.Integer version, java.lang.Integer storeID) Finds all promotions that are either active, inactive or suspended, but not deleted or obsolete by their Name, version and storeID.
PromotionKey[]	findCurrentPromotionByStoreID(java.lang.Integer storeID) Finds current promotions by storeID.
PromotionKey[]	findPromotionByStatusAndStoreID(int status, java.lang.Integer storeID) Finds all promotions by status and storeID.
PromotionKey[]	findPromotionByStoreID(java.lang.Integer storeID) Finds all promotions by storeID.
PromotionKey[]	findPromotionsInAGroupByStatus(com.ibm.commerce.marketing.promotion.group.PromotionGroupKey key, int status) Finds all the promotions in a promotion group by status.
Promotion	load(PromotionKey key) Finds promotion by promotion key.
java.lang.Number	nextNumericKey() Returns the next available numeric key value for promotions.
void	reload(PromotionKey key) Reload any cache for the promotion identified by its key.
void	reloadAll() Reloads the entire promotion cache.
void	remove(Promotion pro) Removes the promotion from persistence storage.
void	remove(Promotion pro, java.util.HashMap sessionData) Deprecated.
void	save(Promotion pro) Saves promotion.
void	save(Promotion pro, java.util.HashMap sessionData) Deprecated.
PromotionKey	saveAsANewRevision(Promotion promotion) Saves the promotion as a new revision.
PromotionKey	saveAsANewRevision(Promotion promotion, java.util.HashMap sessionData) Deprecated.
PromotionKey	saveAsANewVersion(Promotion promotion) Saves the promotion as a new version.
PromotionKey	saveAsANewVersion(Promotion promotion, java.util.HashMap sessionData) Deprecated.

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

fromXML, toXML

Methods inherited from interface com.ibm.commerce.marketing.promotion.dependency.KeyResolver

lookup, reverseLookup

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM Copyright

See Also:

Constant Field Values

Method Detail

load

Promotion load(PromotionKey key)
        throws PersistenceObjectNotFoundException,
               PersistenceObjectReadException

Finds promotion by promotion key.

Parameters:

key - is the promotion key.

Returns:

promotion identified by its key.

Throws:

PersistenceObjectNotFoundException - if the promotion object is not found

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

save

void save(Promotion pro)
   throws PersistenceObjectNotFoundException,
          PersistenceObjectWriteException

Saves promotion.

Parameters:

pro - is the promotion object.

Throws:

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

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

create

void create(Promotion pro)
     throws PersistenceObjectAlreadyExistsException,
            PersistenceCreateException

Creates a new promotion.

Parameters:

pro - is the promotion object.

Throws:

PersistenceObjectAlreadyExistsException - when this object to be created already exists in the database.

PersistenceCreateException - when the creation process fails.

remove

void remove(Promotion pro)
     throws PersistenceObjectNotFoundException,
            PersistenceRemoveException

Removes the promotion from persistence storage.

Parameters:

pro - promotion to be removed.

Throws:

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

PersistenceRemoveException - when the object removal fails.

changePromotionStatus

void changePromotionStatus(PromotionKey key,
                           int status)
                    throws PersistenceObjectNotFoundException,
                           PersistenceObjectWriteException

Changes the status of a promotion.

Parameters:

key - the key of the promotion whose status is about to be changed.

status - the new status for the promotion.

Throws:

PersistenceObjectNotFoundException - when the object as referenced by the key does not exist in the persistence storage.

PersistenceObjectWriteException - when it failes to write the object to DB.

findPromotionsInAGroupByStatus

PromotionKey[] findPromotionsInAGroupByStatus(com.ibm.commerce.marketing.promotion.group.PromotionGroupKey key,
                                              int status)
                                       throws PersistenceObjectReadException

Finds all the promotions in a promotion group by status.

Parameters:

key - is the key of promotion group.

status - is promotion status.

Returns:

an array of promotion keys of the matching promotions.

Throws:

PersistenceObjectReadException - when reading objects in the database fails.

saveAsANewRevision

PromotionKey saveAsANewRevision(Promotion promotion)
                         throws PersistenceObjectWriteException,
                                PersistenceCreateException

Saves the promotion as a new revision.

Parameters:

promotion - the promotion to be saved.

Returns:

Key to the new revision of the promotion.

Throws:

PersistenceObjectWriteException - when writing a promotion to persistence storage fails.

PersistenceCreateException - when system fails to create the new revision of this promotion.

saveAsANewVersion

PromotionKey saveAsANewVersion(Promotion promotion)
                        throws PersistenceObjectWriteException,
                               PersistenceCreateException

Saves the promotion as a new version.

Parameters:

promotion - the promotion to be saved.

Returns:

Key of the new version of this promotion.

Throws:

PersistenceObjectWriteException - when writing a promotion to persistence storage fails.

PersistenceCreateException - when creation of the new version of this promotion fails.

nextNumericKey

java.lang.Number nextNumericKey()

Returns the next available numeric key value for promotions.

Returns:

Next numeric key value for promotions.

reload

void reload(PromotionKey key)

Reload any cache for the promotion identified by its key.

Parameters:

key - representing promotion whose cache needs to be reloaded.

reloadAll

void reloadAll()

Reloads the entire promotion cache.

findActivePromotionByCodeAndStoreID

PromotionKey findActivePromotionByCodeAndStoreID(java.lang.String code,
                                                 java.lang.Integer storeID)

Finds all promotions by their code (visualCue) and storeID.

Parameters:

code - visual cue of the promotion to be found.

storeID - is the ID of the store.

Returns:

the key of the promotion.

findActivePromotionByNameAndStoreID

PromotionKey findActivePromotionByNameAndStoreID(java.lang.String name,
                                                 java.lang.Integer storeID)

Finds all active promotions by their Name and storeID.

Parameters:

name - is the name of the promotion to be found.

storeID - is the ID of the store.

Returns:

the key of the promotion.

findCurrentPromotionByNameAndStoreID

PromotionKey findCurrentPromotionByNameAndStoreID(java.lang.String name,
                                                  java.lang.Integer storeID)
                                           throws PersistenceObjectNotFoundException,
                                                  PersistenceObjectReadException

Finds all promotions that are either active, inactive or suspended, but not deleted or obsolete by their Name and storeID.

Parameters:

name - of the promotion to be found.

storeID - is the store ID of the store.

Returns:

the key of the promotion.

Throws:

PersistenceObjectNotFoundException - when no current object is found.

PersistenceObjectReadException - when reading of the object fails.

findCurrentPromotionByNameVersionAndStoreID

PromotionKey findCurrentPromotionByNameVersionAndStoreID(java.lang.String name,
                                                         java.lang.Integer version,
                                                         java.lang.Integer storeID)
                                                  throws PersistenceObjectNotFoundException,
                                                         PersistenceObjectReadException

Finds all promotions that are either active, inactive or suspended, but not deleted or obsolete by their Name, version and storeID.

Parameters:

name - is the name of the promotion to be found.

version - is the version of the promotion to be found.

storeID - is the store ID of the store.

Returns:

the key of the promotion.

Throws:

PersistenceObjectNotFoundException - when no current object is found.

PersistenceObjectReadException - when reading of the object fails.

findPromotionByStatusAndStoreID

PromotionKey[] findPromotionByStatusAndStoreID(int status,
                                               java.lang.Integer storeID)

Finds all promotions by status and storeID.

Parameters:

status - is the status of the promotion to be found.

storeID - ID of the store.

Returns:

an array of keys of matched promotions.

findCurrentPromotionByStoreID

PromotionKey[] findCurrentPromotionByStoreID(java.lang.Integer storeID)

Finds current promotions by storeID. The definition of a current promotion is defined as a promotion that is in one of the following status: active, inactive, suspended. Deleted and Obsolete promotions are not counted towards "current" promotions.

Parameters:

storeID - is the ID of the store.

Returns:

an array of keys of matched promotions.

findPromotionByStoreID

PromotionKey[] findPromotionByStoreID(java.lang.Integer storeID)

Finds all promotions by storeID.

Parameters:

storeID - is the ID of the store.

Returns:

an array of keys of matched promotions.

changePromotionStatus

void changePromotionStatus(PromotionKey key,
                           int status,
                           java.util.HashMap sessionData)
                    throws PersistenceObjectNotFoundException,
                           PersistenceObjectWriteException

Deprecated.

Changes the status of a promotion.

Parameters:

key - is the key of the promotion whose status is about to be changed.

status - the new status

sessionData - Session data that needs to passed to persistence managers

Throws:

PersistenceObjectNotFoundException - when the object as referenced by the key does not exist in the persistence storage

PersistenceObjectWriteException - when writes to the object fail

create

void create(Promotion pro,
            java.util.HashMap sessionData)
     throws PersistenceObjectAlreadyExistsException,
            PersistenceCreateException

Deprecated.

Creates a new promotion.

Parameters:

pro - The Promotion object to create.

sessionData - Session data that needs to passed to persistence managers

Throws:

PersistenceObjectAlreadyExistsException - when this object to be created already exists in the database.

PersistenceCreateException - when the creation process fails.

remove

void remove(Promotion pro,
            java.util.HashMap sessionData)
     throws PersistenceObjectNotFoundException,
            PersistenceRemoveException

Deprecated.

Removes the promotion from persistence storage.

Parameters:

pro - Promotion to be removed

sessionData - Session data that needs to passed to persistence managers

Throws:

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

PersistenceRemoveException - when the object removal fails

save

void save(Promotion pro,
          java.util.HashMap sessionData)
   throws PersistenceObjectNotFoundException,
          PersistenceObjectWriteException

Deprecated.

Saves promotion.

Parameters:

pro - A Promotion object

sessionData - Session data that needs to passed to persistence managers

Throws:

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

PersistenceObjectWriteException - when writes to this promotion fail.

saveAsANewRevision

PromotionKey saveAsANewRevision(Promotion promotion,
                                java.util.HashMap sessionData)
                         throws PersistenceObjectWriteException,
                                PersistenceCreateException

Deprecated.

Saves the promotion as a new revision.

Parameters:

promotion - the promotion to be saved

sessionData - Session data that needs to passed to persistence managers

Returns:

Key to the new revision of the promotion

Throws:

PersistenceObjectWriteException - when the write operation fails

PersistenceCreateException - when system fails to create the new revision of this promotion

saveAsANewVersion

PromotionKey saveAsANewVersion(Promotion promotion,
                               java.util.HashMap sessionData)
                        throws PersistenceObjectWriteException,
                               PersistenceCreateException

Deprecated.

Saves the promotion as a new version.

Parameters:

promotion - the promotion to be saved

sessionData - Session data that needs to passed to persistence managers

Returns:

Key of the new version of this promotion

Throws:

PersistenceObjectWriteException - when write operation fails

PersistenceCreateException - when creation of the new version of this promotion fails.

findActivePromotionByCodePatternAndStoreID

PromotionKey[] findActivePromotionByCodePatternAndStoreID(java.lang.String code,
                                                          java.lang.Integer storeID)

Finds all promotions by their code (visualCue) and storeID.

Parameters:

code - is the visual cue of the promotion to be found.

storeID - is the ID of the store.

Returns:

the key of the promotion.

findActivePromotionsInAGroupByDate

PromotionKey[] findActivePromotionsInAGroupByDate(com.ibm.commerce.marketing.promotion.group.PromotionGroupKey aGroupKey,
                                                  java.sql.Timestamp aStartDate,
                                                  java.sql.Timestamp aEndDate)
                                           throws PersistenceObjectReadException

Finds all active promotions in a promotion group that has its start date is before the specified date and its end date is after the specified date.

Parameters:

aGroupKey - The key of a promotion group.

aStartDate - The date to check against the promotion start date. If the date is null, then all active promotion will be returned regardless its start date.

aEndDate - The date to check against the promotion end date. If the date is null, then all active promotion will be returned regardless its end date.

Returns:

an array of promotion keys of the matching promotions.

Throws:

PersistenceObjectReadException - when reading objects in the database fails.

findActivePromotionByStoreIDAndDate

PromotionKey[] findActivePromotionByStoreIDAndDate(java.lang.Integer storeID,
                                                   java.sql.Timestamp aStartDate,
                                                   java.sql.Timestamp aEndDate)

Finds all active promotions of a store that has its start date is before the specified date and its end date is after the specified date.

Parameters:

storeID - ID of the store.

aStartDate - The date to check against the promotion start date. If the date is null, then all active promotion will be returned regardless its start date.

aEndDate - The date to check against the promotion end date. If the date is null, then all active promotion will be returned regardless its end date.

Returns:

an array of keys of matched promotions.