public class XPFAgreement extends XPFEntity
| Modifier and Type | Class and Description |
|---|---|
static class |
XPFAgreement.XPFAgreementBuilder<C extends XPFAgreement,B extends XPFAgreement.XPFAgreementBuilder<C,B>> |
XPFEntity.XPFEntityBuilder<C extends XPFEntity,B extends XPFEntity.XPFEntityBuilder<C,B>>| 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) |
| 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() |
getCustomData, getCustomDataValueprotected XPFAgreement(XPFAgreement.XPFAgreementBuilder<?,?> b)
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)
@LazyLoaded public Map<Locale,String> getDisplayNames()
public Optional<String> getDisplayName(Locale locale)
locale - The locale to get a display name for.public static XPFAgreement.XPFAgreementBuilder<?,?> builder()
@NonNull public @NonNull String getCode()
@NonNull public @NonNull String getName()
@NonNull public @NonNull String getDescription()
@NonNull public @NonNull XPFAgreementIntervalTypeEnum getIntervalType()
public int getBillingFrequency()
public int getAgreementLength()
@NonNull public @NonNull XPFAgreementEndBehaviorEnum getEndBehavior()
public boolean isPauseAllowed()
public boolean isCancelAllowed()
Copyright © 2026. All rights reserved.