com.ibm.commerce.marketing.promotion.runtime

Class DefaultAgendaBuilder

java.lang.Object

com.ibm.commerce.marketing.promotion.runtime.DefaultAgendaBuilder

All Implemented Interfaces:

com.ibm.commerce.marketing.promotion.runtime.CacheablePromotionExecutionAgendaBuilder, PromotionExecutionAgendaBuilder, XMLizable, java.io.Serializable

public class DefaultAgendaBuilder
extends java.lang.Object
implements com.ibm.commerce.marketing.promotion.runtime.CacheablePromotionExecutionAgendaBuilder

The class provides an implementation of the PromotionExecutionAgendaBuilder. This agenda builder does not support B2B business models. It is intended to be used with a store that has small number of active promotions.

XML Snippet of DefaultAgendaBuilder:

   <PromotionExecutionAgendaBuilder impl="com.ibm.commerce.marketing.promotion.runtime.DefaultAgendaBuilder">
        <InvocationTemplates>
                <Template>
                        <TemplateKey>
                                <StoreKey>
                                        <DN>o=root organization</DN>
                                        <Identifier>NullEntity</Identifier>
                                </StoreKey>
                                <Name>All Promotions</Name>
                        </TemplateKey>
                        <MonetaryValuePresence>
                                <Price>true</Price>
                                <ShippingCharge>false</ShippingCharge>
                                <Tax>false</Tax>
                                <ShippingTax>false</ShippingTax>
                        </MonetaryValuePresence>
                        <PromotionGroupKey>
                                <StoreKey>
                                        <DN>o=root organization</DN>
                                        <Identifier>NullEntity</Identifier>
                                </StoreKey>
                                <GroupName>ProductLevelPromotion</GroupName>
                        </PromotionGroupKey>
                        <PromotionGroupKey>
                                <StoreKey>
                                        <DN>o=root organization</DN>
                                        <Identifier>NullEntity</Identifier>
                                </StoreKey>
                                <GroupName>OrderLevelPromotion</GroupName>
                        </PromotionGroupKey>
                        <PromotionGroupKey>
                                <StoreKey>
                                        <DN>o=root organization</DN>
                                        <Identifier>NullEntity</Identifier>
                                </StoreKey>
                                <GroupName>ShippingPromotion</GroupName>
                        </PromotionGroupKey>
                </Template>
                <Template>
                        <TemplateKey>
                                <StoreKey>
                                        <DN>o=root organization</DN>
                                        <Identifier>NullEntity</Identifier>
                                </StoreKey>
                                <Name>Order Level Promotion</Name>
                        </TemplateKey>
                        <MonetaryValuePresence>
                                <Price>true</Price>
                                <ShippingCharge>false</ShippingCharge>
                                <Tax>false</Tax>
                                <ShippingTax>false</ShippingTax>
                        </MonetaryValuePresence>
                        <PromotionGroupKey>
                                <StoreKey>
                                        <DN>o=root organization</DN>
                                        <Identifier>NullEntity</Identifier>
                                </StoreKey>
                                <GroupName>OrderLevelPromotion</GroupName>
                        </PromotionGroupKey>
                </Template>
        </InvocationTemplates>
   </PromotionExecutionAgendaBuilder>
 

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DefaultAgendaBuilder() Constructor for DefaultAgendaBuilder.

Method Summary

Modifier and Type	Method and Description
void	addTemplate(Template aTemplate) Add a template to the default agenda builder
PromotionExecutionAgenda	buildAgenda(PromotionEngine engine, PromotionArgument arg) Builds a promotion execution agenda
void	fromXML(org.w3c.dom.Node anXMLNode) Transforms the XML node into its corresponding real Object.
void	refresh()
java.lang.String	toXML() Converts the object into its corresponding XML format representation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright

See Also:

Constant Field Values

Constructor Detail

DefaultAgendaBuilder

public DefaultAgendaBuilder()

Constructor for DefaultAgendaBuilder.

Method Detail

buildAgenda

public PromotionExecutionAgenda buildAgenda(PromotionEngine engine,
                                            PromotionArgument arg)

Description copied from interface: PromotionExecutionAgendaBuilder

Builds a promotion execution agenda

Specified by:

buildAgenda in interface PromotionExecutionAgendaBuilder

Parameters:

engine - the promotion engine which is invoked

arg - the promotion argument object

Returns:

the promotion execution agenda.

See Also:

com.ibm.commerce.marketing.promotion.runtime.PromotionExecutionAgendaBuilder#buildAgenda(PromotionEngine, PromotionArgument, String)

toXML

public java.lang.String toXML()
                       throws XMLizationException

Description copied from interface: XMLizable

Converts the object into its corresponding XML format representation.

Specified by:

toXML in interface XMLizable

Returns:

The string format of the XML that represents this XMLizable object

Throws:

XMLizationException - when this process fails

See Also:

XMLizable.toXML()

fromXML

public void fromXML(org.w3c.dom.Node anXMLNode)
             throws DeXMLizationException

Description copied from interface: XMLizable

Transforms the XML node into its corresponding real Object.

Specified by:

fromXML in interface XMLizable

Parameters:

anXMLNode - The node that represents an XMLizable object

Throws:

DeXMLizationException - when this process fails

See Also:

XMLizable.fromXML(Node)

addTemplate

public void addTemplate(Template aTemplate)

Add a template to the default agenda builder

Parameters:

aTemplate - The template to add for the default agenda builder

refresh

public void refresh()

Specified by:

refresh in interface com.ibm.commerce.marketing.promotion.runtime.CacheablePromotionExecutionAgendaBuilder

See Also:

CacheablePromotionExecutionAgendaBuilder.refresh()