Package com.broadleafcommerce.subscriptionoperation.service

Class DefaultUserSubscriptionSummaryService<U extends UserSubscriptionSummary,SWI extends SubscriptionWithItems>

java.lang.Object

com.broadleafcommerce.subscriptionoperation.service.DefaultUserSubscriptionSummaryService<U,SWI>

Type Parameters:

U - extension of UserSubscriptionSummary

SWI - extension of SubscriptionWithItems

All Implemented Interfaces:

UserSubscriptionSummaryService<U,SWI>

public class DefaultUserSubscriptionSummaryService<U extends UserSubscriptionSummary,SWI extends SubscriptionWithItems>
extends Object
implements UserSubscriptionSummaryService<U,SWI>

Default implementation of UserSubscriptionSummaryService

Author:

karanjariwala

Constructor Summary

Constructors

Constructor	Description
DefaultUserSubscriptionSummaryService(com.broadleafcommerce.common.extension.TypeFactory typeFactory, SubscriptionProvider<SWI,Subscription,SubscriptionOwnerInfo> subscriptionProvider, SubscriptionOperationServiceProperties subOpsServiceProperties, SubscriptionModificationUtils subscriptionModificationUtils)

Method Summary

Modifier and Type	Method	Description
U	buildUserSubscriptionSummary(@NonNull String userRefType, @NonNull String userRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Reads a UserSubscriptionSummary for a user with a particular userRef, and userRefType.
protected int	getDefaultSWIPageSize()	Returns the default page size for gathering SubscriptionWithItems
protected List<String>	getStatusesToReadForSubscriptionSummary()	Creates a list consisting of the active and former subscription statuses for reading the UserSubscriptionSummary
protected SubscriptionOperationServiceProperties	getSubOpsServiceProperties()
protected SubscriptionModificationUtils	getSubscriptionModificationUtils()
protected SubscriptionProvider<SWI,Subscription,SubscriptionOwnerInfo>	getSubscriptionProvider()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultUserSubscriptionSummaryService

public DefaultUserSubscriptionSummaryService(com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 SubscriptionProvider<SWI,Subscription,SubscriptionOwnerInfo> subscriptionProvider,
 SubscriptionOperationServiceProperties subOpsServiceProperties,
 SubscriptionModificationUtils subscriptionModificationUtils)

Method Details

buildUserSubscriptionSummary

public U buildUserSubscriptionSummary(@NonNull
 @NonNull String userRefType,
 @NonNull
 @NonNull String userRef,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: UserSubscriptionSummaryService

Reads a UserSubscriptionSummary for a user with a particular userRef, and userRefType.

This is primarily used for identifying a user's active and former subscriptions.

Specified by:

buildUserSubscriptionSummary in interface UserSubscriptionSummaryService<U extends UserSubscriptionSummary,SWI extends SubscriptionWithItems>

Parameters:

userRefType - the type of userRef

userRef - the reference to the user

contextInfo - context information around multi-tenant state

Returns:

UserSubscriptionSummary containing details about the user's active and former subscriptions.

getStatusesToReadForSubscriptionSummary

protected List<String> getStatusesToReadForSubscriptionSummary()

Creates a list consisting of the active and former subscription statuses for reading the UserSubscriptionSummary

Returns:

a List of the active and former statuses

See Also:

• SubscriptionStatuses
• SubscriptionOperationServiceProperties

getDefaultSWIPageSize

protected int getDefaultSWIPageSize()

Returns the default page size for gathering SubscriptionWithItems

Returns:

the default page size for gathering SubscriptionWithItems

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

getSubscriptionProvider

protected SubscriptionProvider<SWI,Subscription,SubscriptionOwnerInfo> getSubscriptionProvider()

getSubOpsServiceProperties

protected SubscriptionOperationServiceProperties getSubOpsServiceProperties()

getSubscriptionModificationUtils

protected SubscriptionModificationUtils getSubscriptionModificationUtils()