Package com.broadleafcommerce.subscriptionoperation.service.status

Interface SubscriptionStatusHandler<SWI extends SubscriptionWithItems>

All Known Implementing Classes:

ActiveSubscriptionStatusHandler, CanceledSubscriptionStatusHandler, FulfillmentInProcessSubscriptionStatusHandler, PausedSubscriptionStatusHandler, PendingCancellationSubscriptionStatusHandler

public interface SubscriptionStatusHandler<SWI extends SubscriptionWithItems>

A handler that handles a Subscription's status change, e.g. validates if the UpdateSubscriptionStatusRequest.getRequestedStatus() can be applied to the Subscription with particular status.

Author:

Dima Myroniuk (dmyroniuk)

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(UpdateSubscriptionStatusRequest request, SWI swi, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines if this handler can handle the status change.
default Subscription	process(UpdateSubscriptionStatusRequest request, SWI swi, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Processes the Subscription status change if it is valid.
void	validateStatusChange(UpdateSubscriptionStatusRequest request, SWI swi, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates that the UpdateSubscriptionStatusRequest.getRequestedStatus() is a valid next status of the Subscription.

Method Details

canHandle

boolean canHandle(UpdateSubscriptionStatusRequest request,
 SWI swi,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Determines if this handler can handle the status change.

Parameters:

request - the request to modify a subscription's status

swi - the SubscriptionWithItems

contextInfo - context information surrounding sandboxing and multitenant state

Returns:

true if this handler can handle the status change, otherwise false

validateStatusChange

void validateStatusChange(UpdateSubscriptionStatusRequest request,
 SWI swi,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Validates that the UpdateSubscriptionStatusRequest.getRequestedStatus() is a valid next status of the Subscription.

Parameters:

request - the request to modify a subscription's status

swi - the SubscriptionWithItems to validate

contextInfo - context information surrounding sandboxing and multitenant state

Throws:

InvalidSubscriptionStatusChangeRequestException - if the status change is invalid

process

default Subscription process(UpdateSubscriptionStatusRequest request,
 SWI swi,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Processes the Subscription status change if it is valid.

Parameters:

request - the request to modify a subscription's status

swi - the SubscriptionWithItems to process the status change

contextInfo - context information surrounding sandboxing and multitenant state

Returns:

the Subscription with updated status