com.ibm.commerce.bi.taglib

Class CampaignURLBaseTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

com.ibm.commerce.bi.taglib.BaseTag

com.ibm.commerce.bi.taglib.CampaignURLBaseTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class CampaignURLBaseTag
extends BaseTag

Base CampaignURLBaseTag to extend from for the various analytics services. Only the doEndTag() needs to be overridden/implemented.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
CampaignURLBaseTag() Constructor

Method Summary

Modifier and Type	Method and Description
EMarketingSpot	getDatabean() Returns the EMarketingSpot databean.
java.lang.String	getEntry() Returns the category ID or catentry ID.
java.lang.Integer	getInitiative() Returns the ID of an initiative scheduled to the e-marketing spot
java.lang.String	getName() Returns the name of the content (collateral, catalog entry, category or associated catalog entry).
int	getScope() Returns the scope that the modified URL string will be set
java.lang.String	getUrl() Returns the URL that is set before campaign variables are appended
void	setDatabean(EMarketingSpot bean) Sets the EMarketingSpot databean.
void	setEntry(java.lang.String categoryIdIn) Deprecated. replaced by setName()
void	setInitiative(java.lang.Integer initID) Sets the ID of an initiative scheduled to the e-marketing spot.
void	setName(java.lang.String contentName) Sets the name of the content (collateral, catalog entry, category or associated catalog entry).
void	setScope(int newScope) Sets the scope in which to store the modified URL string
void	setUrl(java.lang.String urlIn) Sets the URL to be modified by this tag

Methods inherited from class com.ibm.commerce.bi.taglib.BaseTag

doStartTag, getBiprovider, getCategoryIdForProduct, getCollator, getCommandContext, getConfig, getNumberFormat, getOptionValue, getStoreId, isDebug, isOptionDisabled, isOptionEnabled, setBiprovider, setDebug

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

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 notice field.

See Also:

Constant Field Values

Constructor Detail

CampaignURLBaseTag

public CampaignURLBaseTag()

Constructor

Method Detail

getDatabean

public EMarketingSpot getDatabean()

Returns the EMarketingSpot databean.

Returns:

the EMarketingSpot databean.

setDatabean

public void setDatabean(EMarketingSpot bean)

Sets the EMarketingSpot databean.

Parameters:

bean - the EMarketingSpot databean to set.

getInitiative

public java.lang.Integer getInitiative()

Returns the ID of an initiative scheduled to the e-marketing spot

Returns:

the ID of an initiative scheduled to the e-marketing spot

setInitiative

public void setInitiative(java.lang.Integer initID)

Sets the ID of an initiative scheduled to the e-marketing spot.

Parameters:

initID - the ID of an initiative scheduled to the e-marketing spot.

getEntry

public java.lang.String getEntry()

Returns the category ID or catentry ID. Required for associated catalog entries, associated catalog entries and category recommendations

Returns:

the category ID or catentry ID

setEntry

public void setEntry(java.lang.String categoryIdIn)

Deprecated. replaced by setName()

Sets the category ID or catentry ID. Required for associated catalog entries, associated catalog entries and category recommendations

Parameters:

categoryIdIn -

getName

public java.lang.String getName()

Returns the name of the content (collateral, catalog entry, category or associated catalog entry).

Returns:

the name of the content being shown

setName

public void setName(java.lang.String contentName)

Sets the name of the content (collateral, catalog entry, category or associated catalog entry).

Parameters:

contentName - the name of the content being shown

getUrl

public java.lang.String getUrl()

Returns the URL that is set before campaign variables are appended

Returns:

the URL that is set before campaign variables are appended.

setUrl

public void setUrl(java.lang.String urlIn)

Sets the URL to be modified by this tag

Parameters:

urlIn - the URL to be modified by this tag

getScope

public int getScope()

Returns the scope that the modified URL string will be set

Returns:

the scope that the modified URL string will be set

setScope

public void setScope(int newScope)

Sets the scope in which to store the modified URL string

Parameters:

newScope - the scope in which to store the modified URL string. 1 for "page", 2 for "request", 3 for "session" and 4 for "application"