com.liferay.content.targeting.api.model

Class BaseTrackingAction

java.lang.Object

com.liferay.content.targeting.api.model.BaseTrackingAction

All Implemented Interfaces:

TrackingAction

Direct Known Subclasses:

BaseFreemarkerTrackingAction, BaseJSPTrackingAction

public abstract class BaseTrackingAction
extends java.lang.Object
implements TrackingAction

Constructor Summary

Constructors

Constructor and Description
BaseTrackingAction()

Method Summary

Modifier and Type	Method and Description
void	activate() Does processing when the tracking action is installed.
void	deActivate() Does processing when the tracking action is uninstalled.
void	deleteData(TrackingActionInstance trackingActionInstance) Removes any additional data added by this tracking action when the tracking action instance is removed.
void	exportData(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element campaignElement, Campaign campaign, com.liferay.portal.kernel.xml.Element trackingInstanceElement, TrackingActionInstance trackingActionInstance) Exports any additional data added by this tracking action when the tracking action instance is exported.
java.lang.String	getDescription(java.util.Locale locale) Returns the tracking action's localized description.
protected java.lang.String	getExportImportErrorMessage(Campaign campaign, TrackingActionInstance trackingActionInstance, java.lang.String missingReferenceClassName, java.lang.String missingReferenceId, java.lang.String action)
java.lang.String	getIcon() Returns the Font Awesome CSS class for the tracking action icon.
java.lang.String	getName(java.util.Locale locale) Returns the tracking action's localized name.
java.lang.String	getShortDescription(java.util.Locale locale) Returns the tracking action's localized short description.
java.lang.String	getTrackingActionKey() Returns the key that identifies the tracking action.
void	importData(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext, Campaign campaign, TrackingActionInstance trackingActionInstance) Imports any additional data added by this tracking action when the tracking action instance is imported.
boolean	isInstantiable() Returns true if the tracking action can be used more than once with different values for a campaign.
boolean	isVisible() Returns true if the tracking action is visible.
boolean	isVisible(java.lang.String className, long classPK) Returns true if the tracking action is visible.
java.lang.String	processTrackingAction(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse, java.lang.String id, java.util.Map<java.lang.String,java.lang.String> values) Returns the result of evaluating the tracking action form fields in the context of the request and response.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.content.targeting.api.model.TrackingAction

getEventTypes, getFormHTML, getSummary

Constructor Detail

BaseTrackingAction

public BaseTrackingAction()

Method Detail

activate

public void activate()

Description copied from interface: TrackingAction

Does processing when the tracking action is installed.

Specified by:

activate in interface TrackingAction

deActivate

public void deActivate()

Description copied from interface: TrackingAction

Does processing when the tracking action is uninstalled.

Specified by:

deActivate in interface TrackingAction

deleteData

public void deleteData(TrackingActionInstance trackingActionInstance)
                throws com.liferay.portal.kernel.exception.PortalException

Description copied from interface: TrackingAction

Removes any additional data added by this tracking action when the tracking action instance is removed.

Specified by:

deleteData in interface TrackingAction

Parameters:

trackingActionInstance - the tracking action instance with the stored configuration

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

exportData

public void exportData(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext,
                       com.liferay.portal.kernel.xml.Element campaignElement,
                       Campaign campaign,
                       com.liferay.portal.kernel.xml.Element trackingInstanceElement,
                       TrackingActionInstance trackingActionInstance)
                throws java.lang.Exception

Description copied from interface: TrackingAction

Exports any additional data added by this tracking action when the tracking action instance is exported.

Specified by:

exportData in interface TrackingAction

Parameters:

portletDataContext - the context of the data export

campaignElement - the element with the campaign export data

campaign - the campaign containing the tracking action instance

trackingInstanceElement - the element with the tracking action instance export data

trackingActionInstance - the tracking action instance with stored configuration

Throws:

java.lang.Exception - if an exception occurred

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Description copied from interface: TrackingAction

Returns the tracking action's localized description.

Specified by:

getDescription in interface TrackingAction

Parameters:

locale - the language locale

Returns:

the tracking action's localized description

getIcon

public java.lang.String getIcon()

Description copied from interface: TrackingAction

Returns the Font Awesome CSS class for the tracking action icon.

Specified by:

getIcon in interface TrackingAction

Returns:

the Font Awesome CSS class for the tracking action icon

See Also:

Font Awesome documentation

getName

public java.lang.String getName(java.util.Locale locale)

Description copied from interface: TrackingAction

Returns the tracking action's localized name.

Specified by:

getName in interface TrackingAction

Parameters:

locale - the language locale

Returns:

the tracking action's localized name

getShortDescription

public java.lang.String getShortDescription(java.util.Locale locale)

Description copied from interface: TrackingAction

Returns the tracking action's localized short description.

Specified by:

getShortDescription in interface TrackingAction

Parameters:

locale - the language locale

Returns:

the tracking action's localized short description

getTrackingActionKey

public java.lang.String getTrackingActionKey()

Description copied from interface: TrackingAction

Returns the key that identifies the tracking action. The tracking action instances of this tracking action are identified by their tracking action key.

Specified by:

getTrackingActionKey in interface TrackingAction

Returns:

the key that identifies the tracking action

importData

public void importData(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext,
                       Campaign campaign,
                       TrackingActionInstance trackingActionInstance)
                throws java.lang.Exception

Description copied from interface: TrackingAction

Imports any additional data added by this tracking action when the tracking action instance is imported.

Specified by:

importData in interface TrackingAction

Parameters:

portletDataContext - the context of the data import

campaign - the campaign containing the tracing action instance

trackingActionInstance - the tracking action instance with stored configuration

Throws:

java.lang.Exception - if an exception occurred

isInstantiable

public boolean isInstantiable()

Description copied from interface: TrackingAction

Returns true if the tracking action can be used more than once with different values for a campaign.

Specified by:

isInstantiable in interface TrackingAction

Returns:

true if the tracking action can be used more than once; false otherwise

isVisible

public boolean isVisible()

Description copied from interface: TrackingAction

Returns true if the tracking action is visible.

Specified by:

isVisible in interface TrackingAction

Returns:

true if the tracking action is visible; false otherwise

isVisible

public boolean isVisible(java.lang.String className,
                         long classPK)

Description copied from interface: TrackingAction

Returns true if the tracking action is visible.

Specified by:

isVisible in interface TrackingAction

Parameters:

className - the class name of the entity to check if the tracking action is visible within this entity

classPK - the ID of the entity to check if the tracking action is visible within this entity

Returns:

true if the tracking action is visible within specific entity; false otherwise

processTrackingAction

public java.lang.String processTrackingAction(javax.portlet.PortletRequest portletRequest,
                                              javax.portlet.PortletResponse portletResponse,
                                              java.lang.String id,
                                              java.util.Map<java.lang.String,java.lang.String> values)
                                       throws InvalidTrackingActionException

Description copied from interface: TrackingAction

Returns the result of evaluating the tracking action form fields in the context of the request and response.

Specified by:

processTrackingAction in interface TrackingAction

Parameters:

portletRequest - the request from which to get the request parameters

portletResponse - the response to receive the render parameters

id - the identifier that differentiates between tracking action instances of the same type of an instantiable tracing action

values - the values configured by users for the current tracking action instance based on the form controls from the HTML

Returns:

the result of evaluating the tracking action form fields in the context of the request and response

Throws:

InvalidTrackingActionException - if an invalid tracking action exception occurred

getExportImportErrorMessage

protected java.lang.String getExportImportErrorMessage(Campaign campaign,
                                                       TrackingActionInstance trackingActionInstance,
                                                       java.lang.String missingReferenceClassName,
                                                       java.lang.String missingReferenceId,
                                                       java.lang.String action)