com.broadleafcommerce.inventory.advanced.notification.domain

Class InventoryNotificationImpl

java.lang.Object

com.broadleafcommerce.inventory.advanced.notification.domain.InventoryNotificationImpl

All Implemented Interfaces:

InventoryNotification

@Entity
public class InventoryNotificationImpl
extends Object
implements InventoryNotification

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	date
protected String	emailAddress
protected Long	id
protected FulfillmentLocation	location
protected Boolean	processed
protected org.broadleafcommerce.core.catalog.domain.Sku	sku

Constructor Summary

Constructors

Constructor and Description
InventoryNotificationImpl()

Method Summary

Modifier and Type	Method and Description
Date	getDate() The date in which this notification was created
String	getEmailAddress() The email address to be used for notifying the user that there is now inventory available for the given Sku.
Long	getId() Gets the primary key for this entity
FulfillmentLocation	getLocation() Optional, could return null if this was not set on the original notification request
org.broadleafcommerce.core.catalog.domain.Sku	getSku() Gets the Sku that a user has subscribed to receive notifications for
boolean	isProcessed() Whether or not this notification has been sent out to the user.
void	setDate(Date date) When the user actually subscribed to this notification.
void	setEmailAddress(String emailAddress) The email address used to notify the user that there is inventory available for the given Sku.
void	setId(Long id) Sets the primary key for this entity
void	setLocation(FulfillmentLocation location) Optional, allows the user to further narrow down the criteria for when they want to receive inventory in stock notifications.
void	setProcessed(boolean processed) Whether or not this notification was actually sent to the subscribing user.
void	setSku(org.broadleafcommerce.core.catalog.domain.Sku sku) Required, sets the Sku from the Broadleaf catalog that the user has requested to listen for inventory notifications for.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

sku

protected org.broadleafcommerce.core.catalog.domain.Sku sku

location

protected FulfillmentLocation location

emailAddress

protected String emailAddress

date

protected Date date

processed

protected Boolean processed

Constructor Detail

InventoryNotificationImpl

public InventoryNotificationImpl()

Method Detail

setId

public void setId(Long id)

Description copied from interface: InventoryNotification

Sets the primary key for this entity

Specified by:

setId in interface InventoryNotification

getId

public Long getId()

Description copied from interface: InventoryNotification

Gets the primary key for this entity

Specified by:

getId in interface InventoryNotification

Returns:

setSku

public void setSku(org.broadleafcommerce.core.catalog.domain.Sku sku)

Description copied from interface: InventoryNotification

Required, sets the Sku from the Broadleaf catalog that the user has requested to listen for inventory notifications for. This Sku can be used in the email to distinguish to the user which Sku now has available inventory

Specified by:

setSku in interface InventoryNotification

Parameters:

sku - the Sku from the Broadleaf catalog that the user is subscribing to

getSku

public org.broadleafcommerce.core.catalog.domain.Sku getSku()

Description copied from interface: InventoryNotification

Gets the Sku that a user has subscribed to receive notifications for

Specified by:

getSku in interface InventoryNotification

Returns:

the Sku that the user has requested to receive notifications for

getLocation

public FulfillmentLocation getLocation()

Description copied from interface: InventoryNotification

Optional, could return null if this was not set on the original notification request

Specified by:

getLocation in interface InventoryNotification

Returns:

null if the user has not specified a location for the notification

setLocation

public void setLocation(FulfillmentLocation location)

Description copied from interface: InventoryNotification

Optional, allows the user to further narrow down the criteria for when they want to receive inventory in stock notifications. For instance, a user might want to know when inventory has become available at their local pickup location. If this is unset, the assumption is that there will be a notification sent to the user when there is inventory detected at any FulfillmentLocation

Specified by:

setLocation in interface InventoryNotification

Parameters:

location - the FulfillmentLocation that the user has specified to receive inventory notifications for

getEmailAddress

public String getEmailAddress()

Description copied from interface: InventoryNotification

The email address to be used for notifying the user that there is now inventory available for the given Sku. If this is a non-anonymous customer, this will have usually been set to Customer.getEmailAddress()

Specified by:

getEmailAddress in interface InventoryNotification

Returns:

the email address to send this notification to

setEmailAddress

public void setEmailAddress(String emailAddress)

Description copied from interface: InventoryNotification

The email address used to notify the user that there is inventory available for the given Sku. This is usually Customer.getEmailAddress()

Specified by:

setEmailAddress in interface InventoryNotification

Parameters:

emailAddress - the address that should be notified that there is new inventory

setDate

public void setDate(Date date)

Description copied from interface: InventoryNotification

When the user actually subscribed to this notification. This should be set at instantiation to new Date();

Specified by:

setDate in interface InventoryNotification

getDate

public Date getDate()

Description copied from interface: InventoryNotification

The date in which this notification was created

Specified by:

getDate in interface InventoryNotification

Returns:

the date that the notification was created

setProcessed

public void setProcessed(boolean processed)

Description copied from interface: InventoryNotification

Whether or not this notification was actually sent to the subscribing user. This should be set to true and saved immediately after processing the notification. At time of instantiation this defaults to false.

Once a notification has been sent (and InventoryNotification.isProcessed() is true) then this notification should be to be deleted

Specified by:

setProcessed in interface InventoryNotification

Parameters:

processed - if the notification has been processed by the system (which usually means that an email has been sent out)

isProcessed

public boolean isProcessed()

Description copied from interface: InventoryNotification

Whether or not this notification has been sent out to the user. This defaults to false

Specified by:

isProcessed in interface InventoryNotification

Returns:

whether or not the given Customer or {InventoryNotification.getEmailAddress() has been processed as a result of processing this notification. If this returns true then this notification should be deleted so as to not cause notifications to be sent multiple times