com.ibm.commerce.marketing.promotion.policy

Interface PromotionPolicyPersistenceManager

All Superinterfaces:

KeyResolver, java.io.Serializable, XMLizable

All Known Implementing Classes:

PromotionPolicyJDBCPersistenceManager, PromotionPolicySessionBeanPersistenceManager

public interface PromotionPolicyPersistenceManager
extends XMLizable, KeyResolver

The PromotionPolicyPersistenceManager interface provides the functions needed to create, store, delete or find the different promotion policy entities.

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	create(PromotionPolicy pro) Create a new promotion policy.
PromotionPolicyKey[]	findGlobalPolicyKeysByStore(StoreKey key) Finds all global promotion policies within a store
PromotionPolicyKey[]	findPolicyKeysByGroupAndStatus(com.ibm.commerce.marketing.promotion.group.PromotionGroupKey gkey, int status) Finds promotion policies based on the group with which they are associated and their status
PromotionPolicy	load(PromotionPolicyKey key) Finds promotion policy by promotion policy key.
java.lang.Number	nextNumericKey() Returns the next numeric key associated with the PromotionPolicyKey.
void	reload(PromotionPolicyKey key) Invalidates the cache for one promotion policy
void	reloadAll() Invalidates all policies currently in the cache
void	remove(PromotionPolicy pro) This removing is referring to marked for deletion.
void	save(PromotionPolicy pro) Save promotion policy.

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

PromotionPolicy load(PromotionPolicyKey key)
              throws PersistenceObjectNotFoundException,
                     PersistenceObjectReadException

Finds promotion policy by promotion policy key.

Parameters:

key - PromotionPolicyKey

Returns:

PromotionPolicy

Throws:

PersistenceObjectNotFoundException - when the object identified by the key is not found

PersistenceObjectReadException - when fails to load this object

save

void save(PromotionPolicy pro)
   throws PersistenceObjectNotFoundException,
          PersistenceObjectWriteException

Save promotion policy.

Parameters:

pro - PromotionPolicy

Throws:

PersistenceObjectNotFoundException - when the object identified by the key is not found

PersistenceObjectWriteException - when fails to write to this object

create

void create(PromotionPolicy pro)
     throws PersistenceObjectAlreadyExistsException,
            PersistenceCreateException

Create a new promotion policy.

Parameters:

pro - PromotionPolicy

Throws:

PersistenceObjectAlreadyExistsException - when the object to create as identified by the key already exists

PersistenceCreateException - when fails to create this object

remove

void remove(PromotionPolicy pro)
     throws PersistenceObjectNotFoundException,
            PersistenceRemoveException

This removing is referring to marked for deletion.

Parameters:

pro - PromotionPolicy

Throws:

PersistenceObjectNotFoundException - when the object identified by the key is not found

PersistenceRemoveException - when fails to remove this object

findGlobalPolicyKeysByStore

PromotionPolicyKey[] findGlobalPolicyKeysByStore(StoreKey key)

Finds all global promotion policies within a store

Parameters:

key - identifies the store

Returns:

an array of global policy keys

findPolicyKeysByGroupAndStatus

PromotionPolicyKey[] findPolicyKeysByGroupAndStatus(com.ibm.commerce.marketing.promotion.group.PromotionGroupKey gkey,
                                                    int status)

Finds promotion policies based on the group with which they are associated and their status

Parameters:

gkey - the key of the group with which the policies are associated.

status - the status of the policies

Returns:

an array of policy keys

reload

void reload(PromotionPolicyKey key)

Invalidates the cache for one promotion policy

Parameters:

key - to the promotion policy

reloadAll

void reloadAll()

Invalidates all policies currently in the cache

nextNumericKey

java.lang.Number nextNumericKey()

Returns the next numeric key associated with the PromotionPolicyKey.

Returns:

next numeric key associated with the PromotionPolicyKey.