public class PageLocationActivityHelper extends AbstractPageLayoutActivityHelper
PageLocationActivity
which are simplified for use with Page Location Activity operations.
Each Page Location details are saved in a Marketing Activity. These Activities have a specific structure which are generally not used from the Marketing Tool of WebSphere Commerce Management Center (CMC). For example, each Page Location Activity has a specific Action called "Show Page Layout" which is not shown in the Marketing Tool in CMC.
This helper class provides methods to do the following:
AbstractPageLayoutActivityHelper
Constructor and Description |
---|
PageLocationActivityHelper()
Constructor for this class.
|
Modifier and Type | Method and Description |
---|---|
void |
deletePageLocationESpotIfNotUsed(java.util.List<PageLocationActivityESpot> pageLocationESpotList)
This method deletes the specified Page Location ESpots, if they are not used in a web activity.
|
PageLocationActivity |
getNewPageLocationActivityTemplate(java.lang.String pageLocationGroup,
java.lang.String storeId)
This method returns a new Page Location Activity template instance for a given Page Location Group.
|
java.util.List<PageLocationActivity> |
getPageLocationActivity(java.util.List<PageLocationActivityESpot> espot,
java.lang.String storeId,
GetType getVerb,
ShowType showVerb)
This method returns all the Page Location Activities that are defined for a set of Page Location Activity ESpot's.
|
java.util.Map<java.lang.String,PageLocationActivity> |
getPageLocationActivity(java.util.List<java.lang.String> activityIdList)
This method returns the Page Location Activities for a given list of Activity Id's.
|
java.util.List<PageLocationActivity> |
getPageLocationActivity(PageLocationActivityESpot espot,
java.lang.String storeId,
GetType getVerb,
ShowType showVerb)
This method returns all the Page Location Activities that are defined for a given Page Location Activity ESpot.
|
PageLocationMediationHelper |
getPageLocationMediationHelper()
Returns the Page Location Mediation Helper instance used by this class.
|
void |
savePageLocationActivity(java.util.List<PageLocationActivity> pageLocationActivityList)
This method saves a given list of Page Location Activities to the database.
|
deActivateActivity, deleteActivity, fetchESpotIds, fetchESpotIds, saveESpots, setFetchActivityByCampaignElementAccessProfile, setFetchActivityByIdAccessProfile, setFetchActivityElementsByIdAccessProfile, setFetchActivityTemplateByNameAccessProfile, setFetchESpotAccessProfile
public PageLocationActivityHelper()
It first calls the super class constructor super()
and then sets the Page Location Mediation Helper instance used by this class.
public final PageLocationMediationHelper getPageLocationMediationHelper()
public final PageLocationActivity getNewPageLocationActivityTemplate(java.lang.String pageLocationGroup, java.lang.String storeId) throws PageLayoutApplicationException
This method calls the super class method AbstractPageLayoutActivityHelper.getPageLayoutActivityTemplate(String, String)
to
get a new Page Location Activity Template.
pageLocationGroup
- The given Page Location Group.storeId
- The Store Id.PageLayoutApplicationException
- If any exception occurs.public final java.util.Map<java.lang.String,PageLocationActivity> getPageLocationActivity(java.util.List<java.lang.String> activityIdList) throws PageLayoutApplicationException
This method first invokes the super class method AbstractPageLayoutActivityHelper.getPageLayoutActivity(List)
to get a list of Page Location Activities. Then it calls setESpotObjectNames(List)
to set the Object
names of the Pages that correspond to the ESpots in these Page Location Activities. Finally, it calls
filterActivities(Map)
to filter out the activities containing ESpots corresponding to Pages that may
not exist any more.
activityIdList
- The given list of Activity Id's.PageLayoutApplicationException
- If any exception occurs.public final java.util.List<PageLocationActivity> getPageLocationActivity(PageLocationActivityESpot espot, java.lang.String storeId, GetType getVerb, ShowType showVerb) throws PageLayoutApplicationException
This method first invokes the super class method getPageLayoutActivity
to get a list of Page Location Activities. Then it calls setESpotObjectNames(List)
to set the Object
names of the Pages that correspond to the ESpots in these Page Location Activities.
Note: Unlike getPageLocationActivity(List)
, this method does not filter the resultant list of Page
Location Activities. This method assumes that the Page indicated by the given Page Location Activity ESpot exists.
espot
- The given Page Location Activity ESpot.storeId
- The Store Id of the Page Location Activity ESpot. Can be null.
If the Store Id is null, then this method will return Page Location Activities for the store path.getVerb
- (Optional) The Get verb from the requesting service. This method delegates the pagination parameters from
this Get verb to the Get verb in the request to the Marketing Component.showVerb
- (Optional) The Show verb for the requesting service. This method sets response of the pagination parameters
from the Show verb received back from the Marketing Component to the Show verb of the requesting service.PageLayoutApplicationException
- If any exception occurs.public final java.util.List<PageLocationActivity> getPageLocationActivity(java.util.List<PageLocationActivityESpot> espot, java.lang.String storeId, GetType getVerb, ShowType showVerb) throws PageLayoutApplicationException
This method first invokes the super class method getPageLayoutActivity
to get a list of Page Location Activities. Then it calls setESpotObjectNames(List)
to set the Object
names of the Pages that correspond to the ESpots in these Page Location Activities.
Note: Unlike getPageLocationActivity(List)
, this method does not filter the resultant list of Page
Location Activities. This method assumes that the Page indicated by the given Page Location Activity ESpot exists.
espot
- A list of Page Location Activity ESpot's.storeId
- The Store Id of the Page Location Activity ESpot. Can be null.
If the Store Id is null, then this method will return Page Location Activities for the store path.getVerb
- (Optional) The Get verb from the requesting service. This method delegates the pagination parameters from
this Get verb to the Get verb in the request to the Marketing Component.showVerb
- (Optional) The Show verb for the requesting service. This method sets response of the pagination parameters
from the Show verb received back from the Marketing Component to the Show verb of the requesting service.PageLayoutApplicationException
- If any exception occurs.public final void savePageLocationActivity(java.util.List<PageLocationActivity> pageLocationActivityList) throws PageLayoutApplicationException
This method delegates to the super class method savePageLayoutActivity(List)
.
pageLocationActivityList
- The list of Page Location Activities to be saved.PageLayoutApplicationException
- If any exception occurs.public void deletePageLocationESpotIfNotUsed(java.util.List<PageLocationActivityESpot> pageLocationESpotList)
This method checks if the ESpots have no associated activities before deleting them.
pageLocationESpotList
- A list of Page Location ESpot Names to be deleted.