AddAdToPlaceholderAction Class
- public class AddAdToPlaceholderAction
extends Action
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
ContentQueryNode - placeholder (required): the array of String placeholder ids.
- adWeight (required): the Integer ad weight/priority
- ttl (optional): time-to-live string in the form of "days:hours:minutes"
- expireDate (optional): TimeInstant or Timestamp of the expiration date.
- clearingPolicy (optional): String of either "campaign" (to clear all
ads in the placeholders from the campaign), "all" (to clear all ads in the
placeholders), or anything else to not clear the placeholders at all.
-
Hierarchy
-
Object
Action
AddAdToPlaceholderAction
-
All Implemented Interfaces
-
Serializable
public void |
-
init(Map params)
- Initialize this action from a set of action parameters.
|
public void |
-
run()
- Execute this action.
|
public String |
-
toString()
- Get string representation of this.
|
Methods from com.bea.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 |
AD_EXPIRATION_DATE
public static final String AD_EXPIRATION_DATE
- The name of the expiration date parameter.
AD_QUERY
public static final String AD_QUERY
- The name of adQuery action parameter.
AD_TTL
public static final String AD_TTL
- The name of the time-to-live parameter.
AD_WEIGHT
public static final String AD_WEIGHT
- The name of the adWeight action parameter.
CLEARING_POLICY
public static final String CLEARING_POLICY
- The name of the clearing policy paramter.
PLACEHOLDER
public static final String PLACEHOLDER
- The name of placeholder action parameter.
REMOVE
public static final String REMOVE
- The name of the remove action parameter.
AddAdToPlaceholderAction
public AddAdToPlaceholderAction()
init(Map) Method
public void init(Map params)
throws 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
-
Action.init(Map)
Parameters
-
params
- action parameters.
Exceptions
-
IllegalArgumentException
- thrown on invalid action paramters.
run() Method
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
-
Action.run()
Exceptions
-
ActionException
- thrown on an error.
toString() Method
public String toString()
Get string representation of this.
-
Overrides
-
Object.toString()