com.ibm.commerce.pagelayout.facade.server.helpers.activity

Class AbstractPageLayoutActivityHelper

java.lang.Object

com.ibm.commerce.pagelayout.facade.server.helpers.activity.AbstractPageLayoutActivityHelper

Direct Known Subclasses:

PageLocationActivityHelper

public abstract class AbstractPageLayoutActivityHelper
extends java.lang.Object

This class is the base class for the Page Layout Activity framework. The Page layout Activity Framework encapsulates the low level Marketing Activity details and exposes simpler and friendly interfaces for the Page Layout Component. The Page Layout Activity framework deals with a special type of Activities which are used only for Page Layouts. These Activities are not visible in the Marketing Tool of Management Center (CMC).

This class provides the support for the following:

• Get a new Page Layout Activity Template Instance for creating a new Page Layout Activity. Refer to getPageLayoutActivityTemplate(String, String) for more details.
• Fetch Page Layout Activities for a given list of Activity Ids. Refer to getPageLayoutActivity(List) for more details.
• Fetch Page Layout Activities for a given ESpot. Refer to getPageLayoutActivity(AbstractPageLayoutActivityESpot, String, GetType, ShowType) for more details.
• Save ESpots for a given set of ESpot Identifiers. Refer to saveESpots(Set) for more details.
• Save(create/update) Page Layout Activities. Refer to savePageLayoutActivity(List) for more details.

See Also:

AbstractPageLayoutActivity, AbstractPageLayoutActivityESpot

Constructor Summary

Constructors

Constructor and Description
AbstractPageLayoutActivityHelper() Constructor for this class.

Method Summary

Modifier and Type	Method and Description
void	deActivateActivity(java.util.List<java.lang.String> activityIdList) De-activates Activities for the given list of Activity Id's.
void	deleteActivity(java.util.List<java.lang.String> activityIdList) Deletes Activities for the given list of Activity Id's.
java.util.Map<ESpotIdentifier,java.lang.String>	fetchESpotIds(java.util.Set<ESpotIdentifier> espotIdentifiers) This method fetches ESpot Ids for the set of ESpot identifier that are passed to this method.
java.util.List<java.lang.String>	fetchESpotIds(java.lang.String espotName) This method fetches ESpot Ids for given ESpot name.
java.util.Map<ESpotIdentifier,java.lang.String>	saveESpots(java.util.Set<ESpotIdentifier> espotIdentifiers) Saves ESpots for the given set of ESpot Identifiers.
void	setFetchActivityByCampaignElementAccessProfile(java.lang.String accessProfile) Sets the access profile for fetching Activity by a Campaign Element.
void	setFetchActivityByIdAccessProfile(java.lang.String accessProfile) Sets the access profile for fetching Activities by Activity Id's.
void	setFetchActivityElementsByIdAccessProfile(java.lang.String accessProfile) Sets the access profile for fetching the Campaign Elements of an Activity by Activity Id.
void	setFetchActivityTemplateByNameAccessProfile(java.lang.String accessProfile) Sets the access profile for fetching Activity Template by Name.
void	setFetchESpotAccessProfile(java.lang.String accessProfile) Sets the access profile for fetching an ESpot.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPageLayoutActivityHelper

public AbstractPageLayoutActivityHelper()

Constructor for this class.

It initializes the following:

• The access profile for fetching Activity by Activity Name.
• The access profile for fetching Activities by Activity Id's.
• The access profile for fetching Activity by a Campaign Element.
• The access profile for fetching the Campaign Elements of an Activity by Activity Id.
• The access profile for fetching an ESpot.
• The Marketing Facade Client instance used by this class.
• The Page Location Mediation Helper instance used by this class.

Method Detail

setFetchActivityTemplateByNameAccessProfile

public final void setFetchActivityTemplateByNameAccessProfile(java.lang.String accessProfile)

Sets the access profile for fetching Activity Template by Name.

Parameters:

accessProfile - the access profile to set.

setFetchActivityByIdAccessProfile

public final void setFetchActivityByIdAccessProfile(java.lang.String accessProfile)

Sets the access profile for fetching Activities by Activity Id's.

Parameters:

accessProfile - the access profile to set.

setFetchActivityByCampaignElementAccessProfile

public final void setFetchActivityByCampaignElementAccessProfile(java.lang.String accessProfile)

Sets the access profile for fetching Activity by a Campaign Element.

Parameters:

accessProfile - the access profile to set.

setFetchActivityElementsByIdAccessProfile

public final void setFetchActivityElementsByIdAccessProfile(java.lang.String accessProfile)

Sets the access profile for fetching the Campaign Elements of an Activity by Activity Id.

Parameters:

accessProfile - the access profile to set.

setFetchESpotAccessProfile

public final void setFetchESpotAccessProfile(java.lang.String accessProfile)

Sets the access profile for fetching an ESpot.

Parameters:

accessProfile - the access profile to set.

fetchESpotIds

public java.util.Map<ESpotIdentifier,java.lang.String> fetchESpotIds(java.util.Set<ESpotIdentifier> espotIdentifiers)
                                                              throws MarketingSpotException

This method fetches ESpot Ids for the set of ESpot identifier that are passed to this method. This method delegates the operation to the Marketing Component through Web Service call using the Marketing Facade Client instance. This method returns a Map of fetched ESpot Ids using the ESpot identifier as the key. If an ESpot for a given espotIdentifier does not exist, then the espotIdentifier is discarded and is not returned in the map.

Parameters:

espotIdentifiers - the given set of ESpot identifiers for which the ESpots need to be fetched.

Returns:

a Map of fetched ESpot Ids using the ESpot identifier as the key.

Throws:

MarketingSpotException - if any exception occurs while fetching the ESpot Ids.

fetchESpotIds

public java.util.List<java.lang.String> fetchESpotIds(java.lang.String espotName)
                                               throws MarketingSpotException

This method fetches ESpot Ids for given ESpot name. This method delegates the operation to the Marketing Component through Web Service call using the Marketing Facade Client instance. This method returns the List of ESpot Ids. If the ESpot for the given ESpot name does not exist, null is returned.

Parameters:

espotName - the given ESpot name.

Returns:

the List of ESpot Ids. If the ESpot for the given ESpot name does not exist, null is returned.

Throws:

MarketingSpotException - if any exception occurs while fetching the ESpot Id.

deActivateActivity

public final void deActivateActivity(java.util.List<java.lang.String> activityIdList)
                              throws PageLayoutApplicationException

De-activates Activities for the given list of Activity Id's. This method delegates the operation to the Marketing Component through Web Service call using the Marketing Facade Client instance.

Parameters:

activityIdList - the given list of Activity Id's.

Throws:

PageLayoutApplicationException - if any exception occurs while de-activating the Activities.

deleteActivity

public final void deleteActivity(java.util.List<java.lang.String> activityIdList)
                          throws PageLayoutApplicationException

Deletes Activities for the given list of Activity Id's. This method delegates the operation to the Marketing Component through Web Service call using the Marketing Facade Client instance.

Parameters:

activityIdList - the given list of Activity Id's.

Throws:

PageLayoutApplicationException - if any exception occurs while deleting the Activities.

saveESpots

public final java.util.Map<ESpotIdentifier,java.lang.String> saveESpots(java.util.Set<ESpotIdentifier> espotIdentifiers)
                                                                 throws PageLayoutApplicationException

Saves ESpots for the given set of ESpot Identifiers.

This method creates ESpots for non-existing ESpots. It returns the ESpot Ids for all the ESpots specified in the given set of ESpot Identifiers.

Note: ESpots set in Page Layout Activities are automatically saved and hence this method is not required to be invoked explicitly. You can use this method in scenarios where you are not using Page Layout Activities but want to directly save ESpots or retrieve the ESpot Ids.

Parameters:

espotIdentifiers - The given set of ESpot Identifiers.

Returns:

A Map of ESpots Ids with the given ESpot Identifier as the key.

Throws:

PageLayoutApplicationException - If any exception occurs while fetching or creating the ESpots.