com.broadleafcommerce.inventory.advanced.notification.service

Class InventoryNotificationServiceImpl

java.lang.Object

com.broadleafcommerce.inventory.advanced.notification.service.InventoryNotificationServiceImpl

All Implemented Interfaces:

InventoryNotificationService

@Service(value="blInventoryNotificationService")
public class InventoryNotificationServiceImpl
extends Object
implements InventoryNotificationService

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.common.email.service.EmailService	emailService
protected InventoryNotificationDao	inventoryNotificationDao
protected AdvancedInventoryService	inventoryService

Constructor Summary

Constructors

Constructor and Description
InventoryNotificationServiceImpl()

Method Summary

Modifier and Type	Method and Description
InventoryNotification	create() Creates a brand new InventoryNotification
void	delete(InventoryNotification request) Deletes the given notification
void	deleteAllProcessed() Deletes all InventoryNotifications that have already been processed.
List<InventoryNotification>	findAll(int start, int pageSize, boolean processed) Finds all notifications in the system regardless of Sku or Customer
List<InventoryNotification>	findAllForEmail(String email, boolean processed) Finds all the notifications that a given email address has subscribed to, usually for anonymous users.
List<InventoryNotification>	findAllForSku(org.broadleafcommerce.core.catalog.domain.Sku sku, int start, int pageSize, boolean processed) Finds all notifications in the system for the given Sku
InventoryNotification	findById(Long id)
boolean	findOpenRequestForEmail(String email, org.broadleafcommerce.core.catalog.domain.Sku sku) Returns whether an email address has requested an availability notification which has not yet been processed for a specific Sku.
protected org.broadleafcommerce.common.email.service.info.EmailInfo	getInStockNotificationEmailInfo()
boolean	processNotification(InventoryNotification notification) Processes the given notification by usually sending an email to the configured InventoryNotification#getCustomer() or InventoryNotification.getEmailAddress().
InventoryNotification	save(InventoryNotification request) Persists the given notification

Methods inherited from class java.lang.Object

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

Field Detail

inventoryNotificationDao

protected InventoryNotificationDao inventoryNotificationDao

inventoryService

protected AdvancedInventoryService inventoryService

emailService

protected org.broadleafcommerce.common.email.service.EmailService emailService

Constructor Detail

InventoryNotificationServiceImpl

public InventoryNotificationServiceImpl()

Method Detail

findById

public InventoryNotification findById(Long id)

Specified by:

findById in interface InventoryNotificationService

save

@Transactional(value="blTransactionManager")
public InventoryNotification save(InventoryNotification request)

Description copied from interface: InventoryNotificationService

Persists the given notification

Specified by:

save in interface InventoryNotificationService

Parameters:

request - the notification to save

Returns:

the merged and up-to-date instance

delete

@Transactional(value="blTransactionManager")
public void delete(InventoryNotification request)

Description copied from interface: InventoryNotificationService

Deletes the given notification

Specified by:

delete in interface InventoryNotificationService

Parameters:

request - the notification to delete

create

public InventoryNotification create()

Description copied from interface: InventoryNotificationService

Creates a brand new InventoryNotification

Specified by:

create in interface InventoryNotificationService

Returns:

a new InventoryNotification

findAll

public List<InventoryNotification> findAll(int start,
                                           int pageSize,
                                           boolean processed)

Description copied from interface: InventoryNotificationService

Finds all notifications in the system regardless of Sku or Customer

Specified by:

findAll in interface InventoryNotificationService

Parameters:

start - which record to start at. Use 0 to start at the beginning

pageSize - the size of each page of records to retrive. If you want to retrieve all of the records, pass in a very large number like Integer.MAX_VALUE.

processed - whether or not the returned InventoryNotifications should be processed or not

Returns:

a list of all InventoryNotifications that are filterd by processed

findAllForSku

public List<InventoryNotification> findAllForSku(org.broadleafcommerce.core.catalog.domain.Sku sku,
                                                 int start,
                                                 int pageSize,
                                                 boolean processed)

Description copied from interface: InventoryNotificationService

Finds all notifications in the system for the given Sku

Specified by:

findAllForSku in interface InventoryNotificationService

Parameters:

sku - the Sku that the notifications are

start - which record to start at. Use 0 to start at the beginning

pageSize - the size of each page of records to retrive. If you want to retrieve all of the records, pass in a very large number like Integer.MAX_VALUE.

processed - whether or not the returned InventoryNotifications should be processed or not

Returns:

a list of InventoryNotifications that are filterd by processed and the given sku

See Also:

InventoryNotification#getSku()}

findAllForEmail

public List<InventoryNotification> findAllForEmail(String email,
                                                   boolean processed)

Description copied from interface: InventoryNotificationService

Finds all the notifications that a given email address has subscribed to, usually for anonymous users. This list is usually not very large as it is per-customer, so there is no paging capability

Specified by:

findAllForEmail in interface InventoryNotificationService

Parameters:

email - the email address that wanted to be notified

processed - whether or not the returned InventoryNotifications should be processed or not

Returns:

a list of InventoryNotifications that are filterd by processed and the given email

deleteAllProcessed

@Transactional(value="blTransactionManager")
public void deleteAllProcessed()

Description copied from interface: InventoryNotificationService

Deletes all InventoryNotifications that have already been processed.

Specified by:

deleteAllProcessed in interface InventoryNotificationService

findOpenRequestForEmail

public boolean findOpenRequestForEmail(String email,
                                       org.broadleafcommerce.core.catalog.domain.Sku sku)

Description copied from interface: InventoryNotificationService

Returns whether an email address has requested an availability notification which has not yet been processed for a specific Sku.

Specified by:

findOpenRequestForEmail in interface InventoryNotificationService

Parameters:

email - the email address to look up notifications for

sku - the Sku to lookup notifications for

Returns:

true if the given email has at least 1 unprocessed notification, false otherwise.

processNotification

public boolean processNotification(InventoryNotification notification)

Description copied from interface: InventoryNotificationService

Processes the given notification by usually sending an email to the configured InventoryNotification#getCustomer() or InventoryNotification.getEmailAddress(). Once the notification has been successfully processed, this will also invoke InventoryNotification.setProcessed(boolean) with true or false indicating that the notification was successfully processed.

After invoking this method (like from a batch process) then you should save the notification with InventoryNotificationService.save(InventoryNotification) since the process result could have changed.

If the given notification has already been processed then this method will do nothing and return false

Specified by:

processNotification in interface InventoryNotificationService

Parameters:

notification - the notification to process

Returns:

true if the notification processing succeeded, false otherwise (like if it was already processed)

getInStockNotificationEmailInfo

protected org.broadleafcommerce.common.email.service.info.EmailInfo getInStockNotificationEmailInfo()