com.bea.commerce.campaign
Class AddAdToPlaceholderAction

java.lang.Object
  |
  +--com.bea.commerce.campaign.action.Action
        |
        +--com.bea.commerce.campaign.AddAdToPlaceholderAction

All Implemented Interfaces:

AdConstants, java.io.Serializable

public class AddAdToPlaceholderAction

extends Action

implements AdConstants

Action implementation to add an Ad query to the users placeholder.

This action understands the following action parameters:

• adQuery (required): either the String ad query expression or the com.bea.commerce.platform.content.query.ContentQueryNode.
• placeholder (required): the array of String placeholder names.
• adWeight (required): the Integer ad weight/priority

See Also:

Serialized Form

Field Summary

static java.lang.String	AD_EXPIRATION_DATE The name of the expiration date parameter.
static java.lang.String	AD_QUERY The name of adQuery action parameter.
static java.lang.String	AD_TTL The name of the time-to-live parameter.
static java.lang.String	AD_WEIGHT The name of the adWeight action parameter.
static java.lang.String	PLACEHOLDER The name of placeholder action parameter.
static java.lang.String	REMOVE The name of the remove action parameter.

Fields inherited from interface com.bea.commerce.platform.ad.AdConstants

AD_EVENT_TRACKING, AD_RENDERING, AD_SERVICE_NAME, ADBUCKET_DB_NAME, ADBUCKET_SERVICE_NAME, ADCOUNT_DB_NAME, CONFLICT_RESOLVER_NAME, EVENT_SERVICE_NAME, GLOBAL_ADBUCKET_NAME

Constructor Summary

AddAdToPlaceholderAction()

Method Summary

static ActionDef	getActionDef() Debug method.
static ActionDef	getActionDef(java.lang.String adQuery) Debug method.
static ActionDef	getActionDef(java.lang.String adQuery, int weight) Debug static routine that will create a new ActionDef for the AddAdToPlaceholderAction.
void	init(java.util.Map params) Initialize this action from a set of action parameters.
void	run() Execute this action.

Methods inherited from class com.bea.commerce.campaign.action.Action

getEvent, getRandom, getRequest, getScenario, getScenarioContainer, getScenarioContainerName, getScenarioId, getScenarioName, getServiceLocator, getSession, getTimestamp, getUser, getUserId, locateService, setEvent, setRandom, setRequest, setScenario, setScenarioContainer, setServiceLocator, setSession, setTimestamp, setUser

Methods inherited from class java.lang.Object

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

Field Detail

AD_QUERY

public static final java.lang.String AD_QUERY

The name of adQuery action parameter.

PLACEHOLDER

public static final java.lang.String PLACEHOLDER

The name of placeholder action parameter.

AD_WEIGHT

public static final java.lang.String AD_WEIGHT

The name of the adWeight action parameter.

REMOVE

public static final java.lang.String REMOVE

The name of the remove action parameter.

AD_TTL

public static final java.lang.String AD_TTL

The name of the time-to-live parameter.

AD_EXPIRATION_DATE

public static final java.lang.String AD_EXPIRATION_DATE

The name of the expiration date parameter.

Constructor Detail

AddAdToPlaceholderAction

public AddAdToPlaceholderAction()

Method Detail

getActionDef

public static ActionDef getActionDef(java.lang.String adQuery,
                                     int weight)

Debug static routine that will create a new ActionDef for the AddAdToPlaceholderAction.

getActionDef

public static ActionDef getActionDef(java.lang.String adQuery)

Debug method.

getActionDef

public static ActionDef getActionDef()

Debug method.

run

public void run()
         throws ActionException

Execute this action.

This will place the adQuery in the user's buckets for the named placeholders with the adWeight.

Overrides:

run in class Action

Throws:

ActionException - thrown on an error.

init

public void init(java.util.Map params)
          throws java.lang.IllegalArgumentException

Initialize this action from a set of action parameters.

See the class notes about that action parameters this action understands and requires.

This method will be invoked by the ActionService.

Overrides:

init in class Action

Throws:

java.lang.IllegalArgumentException - thrown on invalid action paramters.