public interface PromotionEngine extends XMLizable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM Copyright
|
Modifier and Type | Method and Description |
---|---|
boolean |
checkTargetingAtRuntime()
By default will targeting conditions be evaluated at runtime or not.
|
void |
cleanup()
Cleans up after engine is shutdown
|
PromotionExecutionAgendaBuilder |
getAgendaBuilder()
Returns configured promotion execution agenda builder
|
CouponManager |
getCouponManager()
Returns configured coupon manager for this engine.
|
java.lang.String |
getEngineName()
Returns the name of a named promotion engine
|
com.ibm.commerce.marketing.promotion.dependency.ExternalEntityFactoryRegistry |
getExternalEntityRegistry()
Returns configured external entity factory registry for this promotion engine.
|
PersistenceManagerRegistry |
getPersistenceManagerRegistry()
Returns configured persistence manager registry for this promotion engine.
|
GenericPromotionCodeManager |
getPromotionCodeManager()
Returns configured promotion code manager.
|
PromotionContextFactory |
getPromotionContextFactory()
Returns configured promotion context factory
|
com.ibm.commerce.marketing.promotion.event.ListenerRegistry |
getPromotionEventListenerRegistry()
Returns configured promotion event listener registry for this promotion engine.
|
PromotionExecutionSequenceBuilder |
getSequenceBuilder()
Returns configured promotion execution sequence builder
|
void |
initialize()
Initializes the promotion engine.
|
PromotionArgument |
invoke(java.lang.String template,
java.lang.Long orderId,
boolean discardPreviousResult,
boolean saveCurrentResult,
java.util.Hashtable NVP)
Invokes the engine.
|
boolean |
isAdjustmentBasedOnStandardOfferPrice()
By default, if all the adjustments will be based on standard offer price or not.
|
boolean |
isInDebugMode()
Whether or not promotion engine is running in debug mode
|
boolean |
isSingleJVMConfiguration()
Is the engine running in a Single JVM environment or not
|
boolean |
isStateless()
Returns the default configuration for invocation mode
|
void |
setInDebugMode(boolean b)
Sets engine debug mode.
|
boolean |
skipTargetingOnCodeEntered()
By default, if a correct promotion code is entered will the engine evaluate targeting condition
or not.
|
static final java.lang.String COPYRIGHT
java.lang.String getEngineName()
boolean isStateless()
boolean isSingleJVMConfiguration()
boolean checkTargetingAtRuntime()
boolean skipTargetingOnCodeEntered()
boolean isAdjustmentBasedOnStandardOfferPrice()
boolean isInDebugMode()
void setInDebugMode(boolean b)
b
- true if the engine is to be set in debug mode.void initialize() throws PromotionRuntimeException
PromotionRuntimeException
- when the initialization failsPromotionArgument invoke(java.lang.String template, java.lang.Long orderId, boolean discardPreviousResult, boolean saveCurrentResult, java.util.Hashtable NVP) throws PromotionRuntimeException
template
- This defines the name of the template used to invoke the engine. Templates are prescribed ways of calling the promotion engine.orderId
- primary key of the order to which promotions will be applieddiscardPreviousResult
- It instructs the promotion engine to eliminate any previous
record about how promotions are applied to the current order,
that is, the order whose primary key is specified in the call.saveCurrentResult
- It tells the promotion engine whether the current results should be persisted in the database.NVP
- name value pair style parameters, if any, null is acceptable.PromotionRuntimeException
- when an error occurs in the invocation.void cleanup()
GenericPromotionCodeManager getPromotionCodeManager()
CouponManager getCouponManager()
PromotionContextFactory getPromotionContextFactory()
PromotionExecutionAgendaBuilder getAgendaBuilder()
PromotionExecutionSequenceBuilder getSequenceBuilder()
com.ibm.commerce.marketing.promotion.dependency.ExternalEntityFactoryRegistry getExternalEntityRegistry()
PersistenceManagerRegistry getPersistenceManagerRegistry()
com.ibm.commerce.marketing.promotion.event.ListenerRegistry getPromotionEventListenerRegistry()