de.hybris.platform.subscriptionfacades

Interface SubscriptionFacade

All Known Subinterfaces:

SapRevenueCloudSubscriptionFacade

All Known Implementing Classes:

AbstractSubscriptionFacade, DefaultCisSubscriptionFacade, DefaultSapRevenueCloudSubscriptionFacade, DefaultSubscriptionFacade

public interface SubscriptionFacade

Facade which provides functionality to manage subscriptions.

Method Summary

Modifier and Type	Method and Description
CCPaymentInfoData	changePaymentMethod(CCPaymentInfoData paymentInfo, java.lang.String action, boolean propagate, java.util.Map<java.lang.String,java.lang.String> parameters) Changes an existing payment method.
SubscriptionData	changeSubscriptionState(java.lang.String subscriptionId, java.lang.String newStatus, java.util.Map<java.lang.String,java.lang.String> parameters) Updates the state of an existing subscription.
CCPaymentInfoData	createPaymentSubscription(java.util.Map<java.lang.String,java.lang.String> paymentParameters) Creates a payment subscription on the hybris side.
SubscriptionPaymentData	createSubscriptions(OrderData order, java.util.Map<java.lang.String,java.lang.String> parameters) Creates subscriptions for the given order and current user.
SubscriptionData	extendSubscriptionTermDuration(java.lang.String subscriptionId, java.lang.Integer contractDurationExtension, java.util.Map<java.lang.String,java.lang.String> parameters) Extends the subscription term duration of an existing subscription.
SubscriptionPaymentData	finalizeTransaction(java.lang.String authorizationRequestId, java.lang.String authorizationRequestToken, java.util.Map<java.lang.String,java.lang.String> parameters) Finalizes an established subscription with the subscription billing provider.
SubscriptionBillingDetailFileStream	getBillingActivityDetail(java.lang.String billingActivityId, java.util.Map<java.lang.String,java.lang.String> parameters) Returns a file stream containing detail information for the specified billing activity.
java.util.List<SubscriptionBillingData>	getBillingActivityList(java.lang.String subscriptionId, java.util.Map<java.lang.String,java.lang.String> parameters) Returns a list of billing activities for the given subscription.
AbstractOrderEntryModel	getOrderEntryForOrderCodeAndEntryNumber(java.lang.String orderCode, int entryNumber) Returns the AbstractOrderEntryModel for the given orderCode and entryNumber.
SubscriptionData	getSubscription(java.lang.String subscriptionId) Returns the subscription with the given ID.
java.util.Date	getSubscriptionEndDate(ProductData subscriptionProductData, java.util.Date startDate) Calculates an end date for a subscription product based on its subscription term details.
java.util.Collection<SubscriptionData>	getSubscriptions() Returns all subscriptions for the current user.
java.util.List<SubscriptionData>	getSubscriptionsForPaymentMethod(java.lang.String paymentMethodId) Returns a list of subscriptions for the given paymentMethodId of the current user.
java.util.List<SubscriptionBillingData>	getUpgradePreviewBillings(java.lang.String subscriptionId, java.lang.String upgradeId) Returns a list of the possible billing changes between the current subscription and an upgrade option.
java.util.List<ProductData>	getUpsellingOptionsForSubscription(java.lang.String productCode) Returns a list of possible upgrade options for the given subscription product.
java.lang.String	hpfUrl() Returns the HPF URL.
SubscriptionPaymentData	initializeTransaction(java.lang.String clientIpAddress, java.lang.String returnUrl, java.lang.String cancelReturnUrl, java.util.Map<java.lang.String,java.lang.String> parameters) Initializes a transaction with the subscription billing provider.
SubscriptionPaymentData	replacePaymentMethod(java.lang.String subscriptionId, java.lang.String paymentMethodId, java.util.Map<java.lang.String,java.lang.String> parameters) Replaces the payment method for the given subscription.
SubscriptionData	replacePaymentMethod(java.lang.String subscriptionId, java.lang.String paymentMethodId, java.lang.String effectiveFrom, java.util.Map<java.lang.String,java.lang.String> parameters)
CCPaymentInfoData	updateCreatedPaymentMethod(CCPaymentInfoData paymentType, java.util.Map<java.lang.String,java.lang.String> paramMap) Updates an newly-created Payment Type with the Subscription Service information.
SubscriptionPaymentData	updateProfile(java.util.Map<java.lang.String,java.lang.String> parameters) Creates or updates a subscription profile for the current user.
SubscriptionPaymentData	updateSubscription(java.lang.String subscriptionId, boolean force, SubscriptionUpdateActionEnum action, java.util.Map<java.lang.String,java.lang.String> parameters) Updates the given subscription (e.g.
SubscriptionData	updateSubscriptionAutorenewal(java.lang.String subscriptionId, boolean isAutorenewal, java.util.Map<java.lang.String,java.lang.String> parameters) Updates the auto-renewal status of an existing subscription.

Method Detail

updateCreatedPaymentMethod

CCPaymentInfoData updateCreatedPaymentMethod(CCPaymentInfoData paymentType,
                                             java.util.Map<java.lang.String,java.lang.String> paramMap)
                                      throws SubscriptionFacadeException

Updates an newly-created Payment Type with the Subscription Service information. This method differs from changePaymentMethod(CCPaymentInfoData, String, boolean, Map) because it must be used only during the creation of a new payment method (created by the PaymentFacade). changePaymentMethod(CCPaymentInfoData, String, boolean, Map) must be used changing details at a later time.

Parameters:

paymentType - the payment info data relating to the recently-created Payment Type

paramMap - the detail map containing new subscription information.

Returns:

an updated paymentInfo, or null if the update fails.

Throws:

SubscriptionFacadeException

updateProfile

SubscriptionPaymentData updateProfile(java.util.Map<java.lang.String,java.lang.String> parameters)
                               throws SubscriptionFacadeException

Creates or updates a subscription profile for the current user.

Parameters:

parameters - provider specific parameters

Returns:

SubscriptionPaymentData containing the results of the operation

Throws:

SubscriptionFacadeException

createSubscriptions

SubscriptionPaymentData createSubscriptions(OrderData order,
                                            java.util.Map<java.lang.String,java.lang.String> parameters)
                                     throws SubscriptionFacadeException

Creates subscriptions for the given order and current user.

Parameters:

order - the order to create the subscriptions for

parameters - provider specific parameters

Returns:

SubscriptionPaymentData containing the results of the operation

Throws:

SubscriptionFacadeException

initializeTransaction

SubscriptionPaymentData initializeTransaction(java.lang.String clientIpAddress,
                                              java.lang.String returnUrl,
                                              java.lang.String cancelReturnUrl,
                                              java.util.Map<java.lang.String,java.lang.String> parameters)
                                       throws SubscriptionFacadeException

Initializes a transaction with the subscription billing provider.

Parameters:

clientIpAddress - the IP address of the calling client. May be empty.

returnUrl - the URL to redirect to after the silent from post. May not be null or empty.

cancelReturnUrl - the URL to redirect to in case of errors after the silent from post. May not be null or empty.

parameters - provider specific parameters

Returns:

SubscriptionPaymentData containing the results of the operation (hpfUrl and session token). result.getParameters().get("sessionTransactionToken") returns not-null String value.

Throws:

SubscriptionFacadeException

finalizeTransaction

SubscriptionPaymentData finalizeTransaction(java.lang.String authorizationRequestId,
                                            java.lang.String authorizationRequestToken,
                                            java.util.Map<java.lang.String,java.lang.String> parameters)
                                     throws SubscriptionFacadeException

Finalizes an established subscription with the subscription billing provider.

Parameters:

authorizationRequestId - the request ID

authorizationRequestToken - the request token retrieved from the result of a initializeTransaction(java.lang.String, java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>) call.

parameters - provider specific parameters

Returns:

SubscriptionPaymentData containing the results of the operation

Throws:

SubscriptionFacadeException

changePaymentMethod

CCPaymentInfoData changePaymentMethod(CCPaymentInfoData paymentInfo,
                                      java.lang.String action,
                                      boolean propagate,
                                      java.util.Map<java.lang.String,java.lang.String> parameters)
                               throws SubscriptionFacadeException

Changes an existing payment method.

Parameters:

paymentInfo - CCPaymentInfoData the updated payment information

action - String the change action to perform (currently supported: "enable", "disable")

propagate - determines whether to propagate the change to all billing subscriptions using the given payment method

parameters - provider specific parameters

Returns:

CCPaymentInfoData containing the results of the operation

Throws:

SubscriptionFacadeException

replacePaymentMethod

SubscriptionPaymentData replacePaymentMethod(java.lang.String subscriptionId,
                                             java.lang.String paymentMethodId,
                                             java.util.Map<java.lang.String,java.lang.String> parameters)
                                      throws SubscriptionFacadeException

Replaces the payment method for the given subscription.

Parameters:

subscriptionId - the ID of the subscription to replace the payment method for

paymentMethodId - the ID of the new payment method which replaces the current one

parameters - provider specific parameters

Returns:

SubscriptionPaymentData containing the results of the operation

Throws:

SubscriptionFacadeException

replacePaymentMethod

SubscriptionData replacePaymentMethod(java.lang.String subscriptionId,
                                      java.lang.String paymentMethodId,
                                      java.lang.String effectiveFrom,
                                      java.util.Map<java.lang.String,java.lang.String> parameters)
                               throws SubscriptionFacadeException

Parameters:

subscriptionId - the ID of the subscription

paymentMethodId - the ID of the payment method to set

effectiveFrom - determines when the replacement will take effect

parameters - provider specific parameters

Returns:

SubscriptionData containing the results of the operation

Throws:

SubscriptionFacadeException

createPaymentSubscription

CCPaymentInfoData createPaymentSubscription(java.util.Map<java.lang.String,java.lang.String> paymentParameters)
                                     throws SubscriptionFacadeException

Creates a payment subscription on the hybris side.

Parameters:

paymentParameters - parameters retrieved from the result of a finalizeTransaction(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>) call.

Returns:

CCPaymentInfoData the payment information created based on the given parameters

Throws:

SubscriptionFacadeException

updateSubscription

SubscriptionPaymentData updateSubscription(java.lang.String subscriptionId,
                                           boolean force,
                                           SubscriptionUpdateActionEnum action,
                                           java.util.Map<java.lang.String,java.lang.String> parameters)
                                    throws SubscriptionFacadeException

Updates the given subscription (e.g. cancel)

Parameters:

subscriptionId - the subscription to update

force - determines whether to force the update or not

action - the update action to perform

parameters - provider specific parameters

Returns:

SubscriptionPaymentData containing the results of the operation

Throws:

SubscriptionFacadeException

getSubscriptions

java.util.Collection<SubscriptionData> getSubscriptions()
                                                 throws SubscriptionFacadeException

Returns all subscriptions for the current user.

Returns:

Collection<SubscriptionData> the current user's subscription

Throws:

SubscriptionFacadeException

getSubscription

SubscriptionData getSubscription(java.lang.String subscriptionId)
                          throws SubscriptionFacadeException

Returns the subscription with the given ID.

Parameters:

subscriptionId - the ID of the subscription

Returns:

SubscriptionData the subscription with the given ID

Throws:

SubscriptionFacadeException

hpfUrl

java.lang.String hpfUrl()
                 throws SubscriptionFacadeException

Returns the HPF URL.

Returns:

the HPF URL

Throws:

SubscriptionFacadeException

getSubscriptionEndDate

java.util.Date getSubscriptionEndDate(ProductData subscriptionProductData,
                                      java.util.Date startDate)

Calculates an end date for a subscription product based on its subscription term details.

Parameters:

subscriptionProductData -

startDate - start date of the subscription

Returns:

the calculated end date

getUpsellingOptionsForSubscription

java.util.List<ProductData> getUpsellingOptionsForSubscription(java.lang.String productCode)

Returns a list of possible upgrade options for the given subscription product.

Parameters:

productCode -

Returns:

List of ProductData

getUpgradePreviewBillings

java.util.List<SubscriptionBillingData> getUpgradePreviewBillings(java.lang.String subscriptionId,
                                                                  java.lang.String upgradeId)
                                                           throws SubscriptionFacadeException

Returns a list of the possible billing changes between the current subscription and an upgrade option.

Parameters:

subscriptionId - the current subscription

upgradeId - the upgrade option

Returns:

List of SubscriptionBillingData

Throws:

SubscriptionFacadeException

getOrderEntryForOrderCodeAndEntryNumber

AbstractOrderEntryModel getOrderEntryForOrderCodeAndEntryNumber(java.lang.String orderCode,
                                                                int entryNumber)

Returns the AbstractOrderEntryModel for the given orderCode and entryNumber.

Parameters:

orderCode -

entryNumber -

Returns:

AbstractOrderEntryModel or null if not found

updateSubscriptionAutorenewal

SubscriptionData updateSubscriptionAutorenewal(java.lang.String subscriptionId,
                                               boolean isAutorenewal,
                                               java.util.Map<java.lang.String,java.lang.String> parameters)
                                        throws SubscriptionFacadeException

Updates the auto-renewal status of an existing subscription.

Parameters:

subscriptionId - the ID of the subscription

isAutorenewal - the new auto-renewal status of the subscription

parameters - provider specific parameters

Returns:

SubscriptionData containing the results of the operation

Throws:

SubscriptionFacadeException

changeSubscriptionState

SubscriptionData changeSubscriptionState(java.lang.String subscriptionId,
                                         java.lang.String newStatus,
                                         java.util.Map<java.lang.String,java.lang.String> parameters)
                                  throws SubscriptionFacadeException

Updates the state of an existing subscription.

Parameters:

subscriptionId - the ID of the subscription

newStatus - new status of the subscription

parameters - provider specific parameters

Returns:

SubscriptionData containing the results of the operation

Throws:

SubscriptionFacadeException

extendSubscriptionTermDuration

SubscriptionData extendSubscriptionTermDuration(java.lang.String subscriptionId,
                                                java.lang.Integer contractDurationExtension,
                                                java.util.Map<java.lang.String,java.lang.String> parameters)
                                         throws SubscriptionFacadeException

Extends the subscription term duration of an existing subscription.

Parameters:

subscriptionId - the ID of the subscription

contractDurationExtension - extends the duration x times

parameters - provider specific parameters

Returns:

SubscriptionData containing the results of the operation

Throws:

SubscriptionFacadeException

getBillingActivityList

java.util.List<SubscriptionBillingData> getBillingActivityList(java.lang.String subscriptionId,
                                                               java.util.Map<java.lang.String,java.lang.String> parameters)
                                                        throws SubscriptionFacadeException

Returns a list of billing activities for the given subscription.

Parameters:

subscriptionId - the ID of the subscription

parameters - provider specific parameters

Returns:

List<SubscriptionBillingData>

Throws:

SubscriptionFacadeException

getBillingActivityDetail

SubscriptionBillingDetailFileStream getBillingActivityDetail(java.lang.String billingActivityId,
                                                             java.util.Map<java.lang.String,java.lang.String> parameters)
                                                      throws SubscriptionFacadeException

Returns a file stream containing detail information for the specified billing activity.

Parameters:

billingActivityId - the ID of the billing activity

parameters - provider specific parameters

Returns:

SubscriptionBillingDetailFileStream

Throws:

SubscriptionFacadeException

getSubscriptionsForPaymentMethod

java.util.List<SubscriptionData> getSubscriptionsForPaymentMethod(java.lang.String paymentMethodId)
                                                           throws SubscriptionFacadeException

Returns a list of subscriptions for the given paymentMethodId of the current user.

Parameters:

paymentMethodId - the ID of the payment method

Returns:

list of subscriptions

Throws:

SubscriptionFacadeException