com.liferay.content.targeting.api.model

Class BaseChannel

java.lang.Object

com.liferay.content.targeting.api.model.BaseChannel

All Implemented Interfaces:

Channel

Direct Known Subclasses:

BaseFreemarkerChannel, BaseJSPChannel

public abstract class BaseChannel
extends java.lang.Object
implements Channel

Constructor Summary

Constructors

Constructor and Description
BaseChannel()

Method Summary

Modifier and Type	Method and Description
void	activate() Does processing when the channel is installed.
void	deActivate() Does processing when the channel is uninstalled.
void	deleteData(ChannelInstance channelInstance) Removes any additional data added by this channel when the channel instance is removed.
void	exportData(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element tacticElement, Tactic tactic, com.liferay.portal.kernel.xml.Element channelInstanceElement, ChannelInstance channelInstance) Exports any additional data added by this channel when the channel instance is exported.
java.lang.String	getChannelKey() Returns the key that identifies the channel.
java.lang.String	getDescription(java.util.Locale locale) Returns the channel's localized description.
protected java.lang.String	getExportImportErrorMessage(Tactic tactic, ChannelInstance channelInstance, java.lang.String missingReferenceClassName, java.lang.String missingReferenceId, java.lang.String action)
java.lang.String	getIcon() Returns the Font Awesome CSS class for the channel icon.
java.lang.String	getName(java.util.Locale locale) Returns the channel's localized name.
java.lang.String	getShortDescription(java.util.Locale locale) Returns the channel's localized short description.
void	importData(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext, Tactic tactic, ChannelInstance channelInstance) Imports any additional data added by this channel when the channel instance is imported.
boolean	isInstantiable() Returns true if the channel can be used more than once with different values for a campaign.
boolean	isVisible() Returns true if the channel is visible.
java.lang.String	processChannel(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 channel form fields in the context of the request and response.
void	updateChannel(java.lang.String typeSettings, long channelInstanceId) Associates the current channel with the channel instance matching the ID.

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.Channel

getFormHTML, getSummary

Constructor Detail

BaseChannel

public BaseChannel()

Method Detail

activate

public void activate()

Description copied from interface: Channel

Does processing when the channel is installed.

Specified by:

activate in interface Channel

deActivate

public void deActivate()

Description copied from interface: Channel

Does processing when the channel is uninstalled.

Specified by:

deActivate in interface Channel

deleteData

public void deleteData(ChannelInstance channelInstance)
                throws com.liferay.portal.kernel.exception.PortalException

Description copied from interface: Channel

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

Specified by:

deleteData in interface Channel

Parameters:

channelInstance - the channel 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 tacticElement,
                       Tactic tactic,
                       com.liferay.portal.kernel.xml.Element channelInstanceElement,
                       ChannelInstance channelInstance)
                throws java.lang.Exception

Description copied from interface: Channel

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

Specified by:

exportData in interface Channel

Parameters:

portletDataContext - the context of the data export

tacticElement - the element with the tactic export data

tactic - the tactic containing the channel instance

channelInstanceElement - the element with the channel instance export data

channelInstance - the channel instance with stored configuration

Throws:

java.lang.Exception - if an exception occurred

getChannelKey

public java.lang.String getChannelKey()

Description copied from interface: Channel

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

Specified by:

getChannelKey in interface Channel

Returns:

the key that identifies the channel

getDescription

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

Description copied from interface: Channel

Returns the channel's localized description.

Specified by:

getDescription in interface Channel

Parameters:

locale - the language locale

Returns:

the channel localized description

getIcon

public java.lang.String getIcon()

Description copied from interface: Channel

Returns the Font Awesome CSS class for the channel icon.

Specified by:

getIcon in interface Channel

Returns:

the Font Awesome CSS class for the channel icon

See Also:

Font Awesome documentation

getName

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

Description copied from interface: Channel

Returns the channel's localized name.

Specified by:

getName in interface Channel

Parameters:

locale - the language locale

Returns:

the channel's localized name

getShortDescription

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

Description copied from interface: Channel

Returns the channel's localized short description.

Specified by:

getShortDescription in interface Channel

Parameters:

locale - the language locale

Returns:

the channel's localized short description

importData

public void importData(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext,
                       Tactic tactic,
                       ChannelInstance channelInstance)
                throws java.lang.Exception

Description copied from interface: Channel

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

Specified by:

importData in interface Channel

Parameters:

portletDataContext - the context of the data import

tactic - the tactic containing the channel instance

channelInstance - the channel instance with stored configuration

Throws:

java.lang.Exception - if an exception occurred

isInstantiable

public boolean isInstantiable()

Description copied from interface: Channel

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

Specified by:

isInstantiable in interface Channel

Returns:

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

isVisible

public boolean isVisible()

Description copied from interface: Channel

Returns true if the channel is visible.

Specified by:

isVisible in interface Channel

Returns:

true if the channel is visible; false otherwise

processChannel

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

Description copied from interface: Channel

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

Specified by:

processChannel in interface Channel

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 channel instances of the same type of an instantiable channel

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

Returns:

the result of evaluating the channel form fields in the context of the request and response

Throws:

InvalidChannelException - if an invalid channel exception occurred

updateChannel

public void updateChannel(java.lang.String typeSettings,
                          long channelInstanceId)

Description copied from interface: Channel

Associates the current channel with the channel instance matching the ID.

Specified by:

updateChannel in interface Channel

Parameters:

typeSettings - the processed settings for the channel

channelInstanceId - the ID of the channel instance to associate

getExportImportErrorMessage

protected java.lang.String getExportImportErrorMessage(Tactic tactic,
                                                       ChannelInstance channelInstance,
                                                       java.lang.String missingReferenceClassName,
                                                       java.lang.String missingReferenceId,
                                                       java.lang.String action)