Package de.hybris.platform.sap.saprevenuecloudorder.facade

Interface SapRevenueCloudSubscriptionFacade

All Superinterfaces:

de.hybris.platform.subscriptionfacades.SubscriptionFacade

All Known Implementing Classes:

DefaultSapRevenueCloudSubscriptionFacade

public interface SapRevenueCloudSubscriptionFacade
extends de.hybris.platform.subscriptionfacades.SubscriptionFacade

Facade which provides functionality to manage subscriptions.

Method Summary

Modifier and Type	Method	Description
void	cancelSubscription(SubscriptionData subscriptionData)	cancel the subscription
void	changePaymentDetailsAsCard(SubscriptionData subscriptionData, String paymentCardToken)	Changes payment details of subscription in Revenue Cloud using token received from digital payment (in case of payment card) and external system (in case of external card)
void	changePaymentDetailsAsInvoice(SubscriptionData subscriptionData)	Changes payment details of subscription to invoice in revenue cloud
SubscriptionData	computeCancellationDate(String subscriptionId)	gets the effective end date upon cancellation
SubscriptionData	computeExtensionDate(SubscriptionData subscriptionData)	Deprecated, for removal: This API element is subject to removal in a future version. extendSubscription(String , SubscriptionExtensionFormData , boolean ) with simulate=true
void	extendSubscription(SubscriptionData subscriptionData)	Deprecated, for removal: This API element is subject to removal in a future version. extendSubscription(String , SubscriptionExtensionFormData , boolean ) with simulate=false
SubscriptionExtensionData	extendSubscription(String subscriptionCode, SubscriptionExtensionFormData formData, boolean simulation)	Extends the subscription
List<SubscriptionBillingData>	getBillDetails(String billId)	get subscription bill using billId
List<CCPaymentInfoData>	getCCPaymentDetails(boolean saved)	Deprecated, for removal: This API element is subject to removal in a future version. use payment details facade method instead
List<SubscriptionBillingData>	getSubscriptionBills(String fromDate, String toDate)	gets subscription bills based on customerId and dates
List<SubscriptionBillingData>	getSubscriptionBillsByBillId(String billId)	Deprecated, for removal: This API element is subject to removal in a future version. instead use getBillDetails(String)
List<SubscriptionBillingData>	getSubscriptionBillsById(String billId)	Deprecated, for removal: This API element is subject to removal in a future version. instead use getBillDetails(String)
SearchPageData<SubscriptionBillingData>	getSubscriptionBillsHistory(String fromDate, String toDate, int currentPage, int pageSize, String sort)	gets subscription bills based on customerId , dates , currentPage , pageSize and sort
SearchPageData<SubscriptionData>	getSubscriptions(int currentPage, int pageSize, String sort)	Returns all subscriptions for the current user.
void	populateCardTypeName(CCPaymentInfoData ccPaymentInfoData)	Formats digital payments specific values for UI
void	populateCardTypeName(List<CCPaymentInfoData> ccPaymentInfoDataList)	Formats digital payments specific values for UI
void	reverseCancellation(SubscriptionData subscriptionData)	Reverses the Cancellation of subscription
void	updateSubscription(SubscriptionData subscriptionData)	Updates a Subscription
void	withdrawSubscription(SubscriptionData subscriptionData)	withdraw the subscription

Methods inherited from interface de.hybris.platform.subscriptionfacades.SubscriptionFacade

changePaymentMethod, changeSubscriptionState, createPaymentSubscription, createSubscriptions, extendSubscriptionTermDuration, finalizeTransaction, getBillingActivityDetail, getBillingActivityList, getOrderEntryForOrderCodeAndEntryNumber, getSubscription, getSubscriptionEndDate, getSubscriptions, getSubscriptionsForPaymentMethod, getUpgradePreviewBillings, getUpsellingOptionsForSubscription, hpfUrl, initializeTransaction, replacePaymentMethod, replacePaymentMethod, updateCreatedPaymentMethod, updateProfile, updateSubscription, updateSubscriptionAutorenewal

Method Details

getSubscriptions

SearchPageData<SubscriptionData> getSubscriptions(int currentPage,
 int pageSize,
 String sort)
                                           throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Returns all subscriptions for the current user.

Parameters:

currentPage - current page

pageSize - size of page

sort - sorting order

Returns:

the current user's subscription

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

cancelSubscription

void cancelSubscription(SubscriptionData subscriptionData)
                 throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

cancel the subscription

Parameters:

subscriptionData - Subscription Data

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

withdrawSubscription

void withdrawSubscription(SubscriptionData subscriptionData)
                   throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

withdraw the subscription

Parameters:

subscriptionData - Subscription Data

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

extendSubscription

@Deprecated(since="1905.09",
            forRemoval=true)
void extendSubscription(SubscriptionData subscriptionData)
                 throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Deprecated, for removal: This API element is subject to removal in a future version.

extendSubscription(String , SubscriptionExtensionFormData , boolean ) with simulate=false

extends the subscription

Parameters:

subscriptionData - Subscription Data

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

extendSubscription

SubscriptionExtensionData extendSubscription(String subscriptionCode,
 SubscriptionExtensionFormData formData,
 boolean simulation)
                                      throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Extends the subscription

Parameters:

subscriptionCode - subscription code

formData - subscription extension form

simulation - simulation flag

Returns:

subscription extension response

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

computeCancellationDate

SubscriptionData computeCancellationDate(String subscriptionId)
                                  throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

gets the effective end date upon cancellation

Parameters:

subscriptionId - subscriptionId

Returns:

subscriptionData

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

computeExtensionDate

@Deprecated(since="1905.09",
            forRemoval=true)
SubscriptionData computeExtensionDate(SubscriptionData subscriptionData)
                               throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Deprecated, for removal: This API element is subject to removal in a future version.

extendSubscription(String , SubscriptionExtensionFormData , boolean ) with simulate=true

gets the effective end date upon extension

Parameters:

subscriptionData - subscription data

Returns:

subscriptionData

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

getSubscriptionBills

List<SubscriptionBillingData> getSubscriptionBills(String fromDate,
 String toDate)
                                            throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

gets subscription bills based on customerId and dates

Parameters:

fromDate - starting Date for filtering bills

toDate - end Date for filtering bills

Returns:

List<SubscriptionBillingData> of the current user

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

getSubscriptionBillsHistory

SearchPageData<SubscriptionBillingData> getSubscriptionBillsHistory(String fromDate,
 String toDate,
 int currentPage,
 int pageSize,
 String sort)
                                                             throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

gets subscription bills based on customerId , dates , currentPage , pageSize and sort

Parameters:

fromDate - starting Date for filtering bills

toDate - end Date for filtering bills

currentPage - currentPage

pageSize - pageSize

sort - sort

Returns:

bills of the current user's subscription

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

getSubscriptionBillsById

@Deprecated(forRemoval=true,
            since="1905.12")
List<SubscriptionBillingData> getSubscriptionBillsById(String billId)
                                                throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Deprecated, for removal: This API element is subject to removal in a future version.

instead use getBillDetails(String)

gets subscription bill using billId

Parameters:

billId - billId

Returns:

bill for the billId

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

getBillDetails

List<SubscriptionBillingData> getBillDetails(String billId)
                                      throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

get subscription bill using billId

Parameters:

billId - billId

Returns:

bill for the billId

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

getSubscriptionBillsByBillId

@Deprecated(since="1905.12",
            forRemoval=true)
List<SubscriptionBillingData> getSubscriptionBillsByBillId(String billId)
                                                    throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Deprecated, for removal: This API element is subject to removal in a future version.

instead use getBillDetails(String)

gets subscription bill using billId

Parameters:

billId - billId

Returns:

bill for the billId

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

changePaymentDetailsAsCard

void changePaymentDetailsAsCard(SubscriptionData subscriptionData,
 String paymentCardToken)
                         throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Changes payment details of subscription in Revenue Cloud using token received from digital payment (in case of payment card) and external system (in case of external card)

Parameters:

subscriptionData - subscription data

paymentCardToken - payment card token

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

changePaymentDetailsAsInvoice

void changePaymentDetailsAsInvoice(SubscriptionData subscriptionData)
                            throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Changes payment details of subscription to invoice in revenue cloud

Parameters:

subscriptionData - subscription data

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

getCCPaymentDetails

@Deprecated(since="1905.09",
            forRemoval=true)
List<CCPaymentInfoData> getCCPaymentDetails(boolean saved)
                                     throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Deprecated, for removal: This API element is subject to removal in a future version.

use payment details facade method instead

Fetches current payment card details of subscription

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

populateCardTypeName

void populateCardTypeName(CCPaymentInfoData ccPaymentInfoData)
                   throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Formats digital payments specific values for UI

Parameters:

ccPaymentInfoData - payment card details

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

populateCardTypeName

void populateCardTypeName(List<CCPaymentInfoData> ccPaymentInfoDataList)
                   throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Formats digital payments specific values for UI

Parameters:

ccPaymentInfoDataList - list of payment card details

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

reverseCancellation

void reverseCancellation(SubscriptionData subscriptionData)
                  throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Reverses the Cancellation of subscription

Parameters:

subscriptionData - subscription details

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer enters wrong inputs

updateSubscription

void updateSubscription(SubscriptionData subscriptionData)
                 throws de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException

Updates a Subscription

Parameters:

subscriptionData - subscription data

Throws:

de.hybris.platform.subscriptionfacades.exceptions.SubscriptionFacadeException - if customer passes wrong inputs