com.elasticpath.xpf.connectivity.context

Class XPFNotificationDeliveryContext

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.context.XPFNotificationDeliveryContext

public class XPFNotificationDeliveryContext
extends XPFEntity

Context for Notification Delivery.

Constructor Summary

Constructors

Constructor and Description
XPFNotificationDeliveryContext(@NonNull String customTypeName, @NonNull Set<XPFNotificationRecipient> recipients, @NonNull Map<String,Object> placeholderValues, @NonNull Locale locale, XPFStore store) Constructor for custom notification types.
XPFNotificationDeliveryContext(@NonNull XPFNotificationType type, @NonNull Set<XPFNotificationRecipient> recipients, @NonNull Map<String,Object> placeholderValues, @NonNull Locale locale, XPFStore store) Constructor for standard/OOTB notification types.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getCustomTypeName() The custom notification type.
@NonNull Locale	getLocale() The locale.
@NonNull Map<String,Object>	getPlaceholderValues() The placeholder values.
@NonNull Set<XPFNotificationRecipient>	getRecipients() The notification recipients.
XPFStore	getStore() The store.
@NonNull XPFNotificationType	getType() The notification type.
int	hashCode()
String	toString()

Methods inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

getCustomData

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XPFNotificationDeliveryContext

public XPFNotificationDeliveryContext(@NonNull
                                      @NonNull XPFNotificationType type,
                                      @NonNull
                                      @NonNull Set<XPFNotificationRecipient> recipients,
                                      @NonNull
                                      @NonNull Map<String,Object> placeholderValues,
                                      @NonNull
                                      @NonNull Locale locale,
                                      XPFStore store)

Constructor for standard/OOTB notification types.

Parameters:

type - the notification type

recipients - the notification recipients

placeholderValues - the placeholder values

locale - the locale

store - the store

XPFNotificationDeliveryContext

public XPFNotificationDeliveryContext(@NonNull
                                      @NonNull String customTypeName,
                                      @NonNull
                                      @NonNull Set<XPFNotificationRecipient> recipients,
                                      @NonNull
                                      @NonNull Map<String,Object> placeholderValues,
                                      @NonNull
                                      @NonNull Locale locale,
                                      XPFStore store)

Constructor for custom notification types.

Parameters:

customTypeName - the custom notification type name

recipients - the notification recipients

placeholderValues - the placeholder values

locale - the locale

store - the store

Method Detail

getType

@NonNull
public @NonNull XPFNotificationType getType()

The notification type.

getCustomTypeName

public String getCustomTypeName()

The custom notification type. This is for project teams to create their own notification types. Should only be set if type is CUSTOM.

getRecipients

@NonNull
public @NonNull Set<XPFNotificationRecipient> getRecipients()

The notification recipients.

getPlaceholderValues

@NonNull
public @NonNull Map<String,Object> getPlaceholderValues()

The placeholder values.

getLocale

@NonNull
public @NonNull Locale getLocale()

The locale.

getStore

public XPFStore getStore()

The store.

equals

public boolean equals(Object o)

Overrides:

equals in class XPFEntity

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class XPFEntity

hashCode

public int hashCode()

Overrides:

hashCode in class XPFEntity

toString

public String toString()

Overrides:

toString in class XPFEntity