com.broadleafcommerce.inventory.advanced.notification.service

Interface InventoryNotificationService

All Known Implementing Classes:

InventoryNotificationServiceImpl

public interface InventoryNotificationService

CRUD Operations for InventoryNotifications

Author:

Phillip Verheyden (phillipuniverse)

Method Summary

Modifier and Type	Method and Description
InventoryNotification	create() Creates a brand new InventoryNotification
void	delete(InventoryNotification notification) 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.
boolean	processNotification(InventoryNotification notification) Processes the given notification by usually sending an email to the configured InventoryNotification#getCustomer() or InventoryNotification.getEmailAddress().
InventoryNotification	save(InventoryNotification notification) Persists the given notification

Method Detail

findById

InventoryNotification findById(Long id)

save

InventoryNotification save(InventoryNotification notification)

Persists the given notification

Parameters:

notification - the notification to save

Returns:

the merged and up-to-date instance

delete

void delete(InventoryNotification notification)

Deletes the given notification

Parameters:

notification - the notification to delete

findAll

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

Finds all notifications in the system regardless of Sku or Customer

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

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

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

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

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

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

findOpenRequestForEmail

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.

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

boolean processNotification(InventoryNotification notification)

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

Parameters:

notification - the notification to process

Returns:

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

create

InventoryNotification create()

Creates a brand new InventoryNotification

Returns:

a new InventoryNotification

deleteAllProcessed

void deleteAllProcessed()

Deletes all InventoryNotifications that have already been processed.