com.elasticpath.xpf.connectivity.entity

Class XPFAgreement

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFAgreement

public class XPFAgreement
extends XPFEntity

Agreement Extension Point entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFAgreement.XPFAgreementBuilder<C extends XPFAgreement,B extends XPFAgreement.XPFAgreementBuilder<C,B>>

Nested classes/interfaces inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

XPFEntity.XPFEntityBuilder<C extends XPFEntity,B extends XPFEntity.XPFEntityBuilder<C,B>>

Constructor Summary

Constructors

Modifier	Constructor and Description
	XPFAgreement(@NonNull String code, @NonNull String name, @NonNull XPFEntitySupplier<Map<Locale,String>> displayNames, @NonNull String description, @NonNull XPFAgreementIntervalTypeEnum intervalType, int billingFrequency, int agreementLength, @NonNull XPFAgreementEndBehaviorEnum endBehavior, boolean pauseAllowed, boolean cancelAllowed)
protected	XPFAgreement(XPFAgreement.XPFAgreementBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static XPFAgreement.XPFAgreementBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	getAgreementLength() The agreement length, based on number of intervals.
int	getBillingFrequency() The agreement billing frequency, based on number of intervals.
@NonNull String	getCode() The agreement code.
@NonNull String	getDescription() The agreement description for internal use.
Optional<String>	getDisplayName(Locale locale) Get localized display name for a locale with fallback behavior.
Map<Locale,String>	getDisplayNames() Get the display names.
@NonNull XPFAgreementEndBehaviorEnum	getEndBehavior() The agreement end behavior.
@NonNull XPFAgreementIntervalTypeEnum	getIntervalType() The agreement interval type.
@NonNull String	getName() The agreement name.
int	hashCode()
boolean	isCancelAllowed() Indicates if the customer is allowed to cancel the agreement.
boolean	isPauseAllowed() Indicates if the customer is allowed to pause the agreement.
String	toString()

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

getCustomData, getCustomDataValue

Methods inherited from class java.lang.Object

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

Constructor Detail

XPFAgreement

protected XPFAgreement(XPFAgreement.XPFAgreementBuilder<?,?> b)

XPFAgreement

public XPFAgreement(@NonNull
                    @NonNull String code,
                    @NonNull
                    @NonNull String name,
                    @NonNull
                    @NonNull XPFEntitySupplier<Map<Locale,String>> displayNames,
                    @NonNull
                    @NonNull String description,
                    @NonNull
                    @NonNull XPFAgreementIntervalTypeEnum intervalType,
                    int billingFrequency,
                    int agreementLength,
                    @NonNull
                    @NonNull XPFAgreementEndBehaviorEnum endBehavior,
                    boolean pauseAllowed,
                    boolean cancelAllowed)

Method Detail

getDisplayNames

@LazyLoaded
public Map<Locale,String> getDisplayNames()

Get the display names.

Returns:

the display names

getDisplayName

public Optional<String> getDisplayName(Locale locale)

Get localized display name for a locale with fallback behavior.

Parameters:

locale - The locale to get a display name for.

Returns:

The display name as Optional.

builder

public static XPFAgreement.XPFAgreementBuilder<?,?> builder()

getCode

@NonNull
public @NonNull String getCode()

The agreement code.

getName

@NonNull
public @NonNull String getName()

The agreement name.

getDescription

@NonNull
public @NonNull String getDescription()

The agreement description for internal use.

getIntervalType

@NonNull
public @NonNull XPFAgreementIntervalTypeEnum getIntervalType()

The agreement interval type.

getBillingFrequency

public int getBillingFrequency()

The agreement billing frequency, based on number of intervals.

getAgreementLength

public int getAgreementLength()

The agreement length, based on number of intervals.

getEndBehavior

@NonNull
public @NonNull XPFAgreementEndBehaviorEnum getEndBehavior()

The agreement end behavior.

isPauseAllowed

public boolean isPauseAllowed()

Indicates if the customer is allowed to pause the agreement.

isCancelAllowed

public boolean isCancelAllowed()

Indicates if the customer is allowed to cancel the agreement.

toString

public String toString()

Overrides:

toString in class XPFEntity

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