org.broadleafcommerce.core.promotionMessage.util

Class BLCPromotionMessageUtils

java.lang.Object

org.broadleafcommerce.core.promotionMessage.util.BLCPromotionMessageUtils

public class BLCPromotionMessageUtils
extends Object

Convenience methods for interacting with PromotionMessages

Author:

Chris Kittrell (ckittrell)

Constructor Summary

Constructors

Constructor and Description
BLCPromotionMessageUtils()

Method Summary

Modifier and Type	Method and Description
static List<PromotionMessageDTO>	filterPromotionMessageDTOsByTypes(Map<String,List<PromotionMessageDTO>> promotionMessages, List<String> placementTypes) Given a map of PromotionMessagePlacementTypes to PromotionMessageDTOs and a list of PromotionMessagePlacementTypes, filter the map into a list.
static List<String>	gatherMessages(List<PromotionMessage> promotionMessages) Given a list of PromotionMessages, gather their message properties.
static List<String>	gatherMessagesByPlacementType(Map<String,List<PromotionMessageDTO>> promotionMessageMap, PromotionMessagePlacementType type) Given a map of PromotionMessagePlacementTypes to PromotionMessageDTOs, gather the message properties.
static List<String>	gatherMessagesFromDTOs(List<PromotionMessageDTO> promotionMessages) Given a list of PromotionMessageDTOs, gather their message properties.
static void	sortMessagesByPriority(List<PromotionMessageDTO> promotionMessages) Given a list of PromotionMessageDTOs, sort based on priority
static void	sortMessagesByPriority(Map<String,List<PromotionMessageDTO>> promotionMessages) Given a map of PromotionMessagePlacementTypes to PromotionMessageDTOs, sort based on priority

Methods inherited from class java.lang.Object

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

Constructor Detail

BLCPromotionMessageUtils

public BLCPromotionMessageUtils()

Method Detail

gatherMessages

public static List<String> gatherMessages(List<PromotionMessage> promotionMessages)

Given a list of PromotionMessages, gather their message properties.

Parameters:

promotionMessages -

Returns:

messages

gatherMessagesFromDTOs

public static List<String> gatherMessagesFromDTOs(List<PromotionMessageDTO> promotionMessages)

Given a list of PromotionMessageDTOs, gather their message properties.

Parameters:

promotionMessages -

Returns:

messages

sortMessagesByPriority

public static void sortMessagesByPriority(Map<String,List<PromotionMessageDTO>> promotionMessages)

Given a map of PromotionMessagePlacementTypes to PromotionMessageDTOs, sort based on priority

Parameters:

promotionMessages -

sortMessagesByPriority

public static void sortMessagesByPriority(List<PromotionMessageDTO> promotionMessages)

Given a list of PromotionMessageDTOs, sort based on priority

Parameters:

promotionMessages -

gatherMessagesByPlacementType

public static List<String> gatherMessagesByPlacementType(Map<String,List<PromotionMessageDTO>> promotionMessageMap,
                                                         PromotionMessagePlacementType type)

Given a map of PromotionMessagePlacementTypes to PromotionMessageDTOs, gather the message properties.

Parameters:

promotionMessageMap -

type -

Returns:

messages

filterPromotionMessageDTOsByTypes

public static List<PromotionMessageDTO> filterPromotionMessageDTOsByTypes(Map<String,List<PromotionMessageDTO>> promotionMessages,
                                                                          List<String> placementTypes)

Given a map of PromotionMessagePlacementTypes to PromotionMessageDTOs and a list of PromotionMessagePlacementTypes, filter the map into a list.

Parameters:

promotionMessages -

placementTypes -

Returns:

a list of filtered message DTOs