Package de.hybris.platform.sap.saprevenuecloudorder.service

Interface SapRevenueCloudSubscriptionService

All Known Implementing Classes:

DefaultSapRevenueCloudSubscriptionService

public interface SapRevenueCloudSubscriptionService

Service API that provides methods for SAP RevenueCloud Subscription Orders

Method Summary

Modifier and Type	Method	Description
java.lang.String	cancelSubscription(java.lang.String code, CancelSubscription subscription)	cancel a subscription based on subscription code
java.lang.String	computeCancelaltionDate(java.lang.String subscriptionsId, java.lang.String reqCancellationDate)	get effective end date for subscription
java.lang.String	extendSubscription(java.lang.String subscriptionCode, ExtendSubscription subscription)	extend a subscription based on subscription code
BillingFrequencyModel	getBillingFrequency(ProductModel productModel)	get billingFrequency for specific product
java.util.List<Bills>	getBillsBySubscriptionsId(java.lang.String subscriptionsId, java.lang.String fromDate, java.lang.String todate)	fetch bills using subscriptionId and dates
Bills	getSubscriptionBillsById(java.lang.String billId)	fetch bill using billId
Subscription	getSubscriptionById(java.lang.String subscriptionsId)	fetch subscription details using subscriptionId
java.util.List<Bills>	getSubscriptionCurrentUsage(java.lang.String subscriptionId, java.lang.String currentDate)	fetch usage of subscription in current billing cycle
java.util.List<Subscription>	getSubscriptionsByClientId(java.lang.String clientId)	fetch subscription details using customerId

Method Detail

getSubscriptionsByClientId

java.util.List<Subscription> getSubscriptionsByClientId(java.lang.String clientId)

fetch subscription details using customerId

Parameters:

clientId - customerId

Returns:

List list of subscriptions

getSubscriptionById

Subscription getSubscriptionById(java.lang.String subscriptionsId)

fetch subscription details using subscriptionId

Parameters:

subscriptionsId - subscription code

Returns:

Subscription Subscription details

cancelSubscription

java.lang.String cancelSubscription(java.lang.String code,
                                    CancelSubscription subscription)

cancel a subscription based on subscription code

Parameters:

code - subscription code

subscription - subscription data required for cancellation

Returns:

String cancellation status

extendSubscription

java.lang.String extendSubscription(java.lang.String subscriptionCode,
                                    ExtendSubscription subscription)

extend a subscription based on subscription code

Parameters:

subscriptionCode - subscriptionId

subscription - subscription data required for extending subscription

Returns:

extension status

getBillingFrequency

BillingFrequencyModel getBillingFrequency(ProductModel productModel)

get billingFrequency for specific product

Parameters:

productModel - - product model

Returns:

BillingFrequencyModel

computeCancelaltionDate

java.lang.String computeCancelaltionDate(java.lang.String subscriptionsId,
                                         java.lang.String reqCancellationDate)

get effective end date for subscription

Parameters:

subscriptionsId - - subscription code

reqCancellationDate - - requested cancellation date

Returns:

effective end date for subscription

getBillsBySubscriptionsId

java.util.List<Bills> getBillsBySubscriptionsId(java.lang.String subscriptionsId,
                                                java.lang.String fromDate,
                                                java.lang.String todate)

fetch bills using subscriptionId and dates

Parameters:

subscriptionsId - subscriptionId

fromDate - the date from which bills should be displayed

todate - the date till which bills should be displayed

Returns:

List list of bills based on the filter applied

getSubscriptionBillsById

Bills getSubscriptionBillsById(java.lang.String billId)

fetch bill using billId

Parameters:

billId - subscription billId

Returns:

Bills bill for the given id

getSubscriptionCurrentUsage

java.util.List<Bills> getSubscriptionCurrentUsage(java.lang.String subscriptionId,
                                                  java.lang.String currentDate)

fetch usage of subscription in current billing cycle

Parameters:

subscriptionId - - id of subscription for which current usage is needed

currentDate - - current date to fetch usage till current date in present billing cycle

Returns:

List returns bills which contains current usage for given subscription