Interface TmaSubscriptionBaseFacade
- All Known Implementing Classes:
DefaultTmaSubscriptionBaseFacade
public interface TmaSubscriptionBaseFacade
Facade gathering
TmaSubscriptionBaseData related operations.- Since:
- 6.6
-
Method Summary
Modifier and TypeMethodDescriptioncreateSubscriptionBase(String subscriberIdentity, String billingSystemId, String billingAccountId) Create newTmaSubscriptionBaseDatawith the given details.voiddeleteSubscriptionBase(String subscriberIdentity, String billingSystemId) Deletes theTmaSubscriptionBaseModelassociated to a given subscriber identity and a billing system id.booleandoesSubscriptionBaseExist(String subscriptionBaseId) Check if subscription base existsfindSubscriptionBasesByPrincipal(String principalUid) Get an existing subscription base object for usergenerateSubscriptionBase(String billingAccountId) Create newTmaSubscriptionBaseDatawith the given details.Retrieves a set containing allTmaSubscriptionBaseDatas present in the system.getMainTariffSubscribedProductIdsForSubscriptionBases(List<TmaSubscriptionBaseData> subscriptionBaseList) Determines the Subscribed Product Id of the main tariffs corresponding to the each of the subscription bases given.getSubscriptionBaseBySubscriberIdentity(String subscriberIdentity) RetrieveTmaSubscriptionBaseDatafor given subscriberIdentity.getSubscriptionBaseForSubscriberIdentity(String subscriberIdentity, String billingSystemID) Determines Subscription BaseData for given subscriberIdentity and billingSystemIDbooleanisIdenticalBillAgremment(List<TmaSubscriptionBaseData> subscriptionBases) Checks if subscriptionBases belongs to sameTmaBillingAgreementModelbooleanisSubscriptionBaseAccessibleToUser(String subscriptionBaseId, String userId) Checks if user has access to subscription base
-
Method Details
-
createSubscriptionBase
TmaSubscriptionBaseData createSubscriptionBase(String subscriberIdentity, String billingSystemId, String billingAccountId) Create newTmaSubscriptionBaseDatawith the given details.- Parameters:
subscriberIdentity- unique identifier of the subscriber from the given billing system.billingSystemId- unique identifier of the billing systembillingAccountId- unique identifier of the billing account- Returns:
- newly created SubscriptionBase
-
deleteSubscriptionBase
Deletes theTmaSubscriptionBaseModelassociated to a given subscriber identity and a billing system id.- Parameters:
subscriberIdentity- unique identifier for subscriber from the billing systembillingSystemId- unique identifier of the billing system
-
generateSubscriptionBase
Create newTmaSubscriptionBaseDatawith the given details.- Parameters:
billingAccountId- unique identifier of the billing account- Returns:
- newly created SubscriptionBase
-
getMainTariffSubscribedProductIdsForSubscriptionBases
Set<String> getMainTariffSubscribedProductIdsForSubscriptionBases(List<TmaSubscriptionBaseData> subscriptionBaseList) Determines the Subscribed Product Id of the main tariffs corresponding to the each of the subscription bases given.- Parameters:
subscriptionBaseList- the list of subscription bases- Returns:
- the set of Subscribed Product Id's or empty list if the input data is empty
-
getSubscriptionBaseForSubscriberIdentity
TmaSubscriptionBaseData getSubscriptionBaseForSubscriberIdentity(String subscriberIdentity, String billingSystemID) Determines Subscription BaseData for given subscriberIdentity and billingSystemID- Parameters:
subscriberIdentity- String instance is Unique identifier for subscriberbillingSystemID- String instance is Unique identifier for billing system- Returns:
TmaSubscriptionBaseDatainstance for given subscriberIdentity and billingSystemID
-
getAllSubscriptionBases
Set<TmaSubscriptionBaseData> getAllSubscriptionBases()Retrieves a set containing allTmaSubscriptionBaseDatas present in the system.- Returns:
SetofTmaSubscriptionBaseDatas
-
getSubscriptionBaseBySubscriberIdentity
RetrieveTmaSubscriptionBaseDatafor given subscriberIdentity.- Parameters:
subscriberIdentity- unique identifier ofTmaSubscriptionBaseData- Returns:
TmaSubscriptionBaseDatafor given parameters.
-
findSubscriptionBasesByPrincipal
Get an existing subscription base object for user- Parameters:
principalUid- the unique identifier of the object which is intended to be updated- Returns:
- A
ListofTmaSubscriptionBaseDatabelonging to the identified principal
-
isIdenticalBillAgremment
Checks if subscriptionBases belongs to sameTmaBillingAgreementModel- Parameters:
subscriptionBases- list ofTmaSubscriptionBaseData- Returns:
booleanreturns true if subscriptionBases belongs to same billingAgreement else false
-
doesSubscriptionBaseExist
Check if subscription base exists- Parameters:
subscriptionBaseId- unique identifier of subscription base- Returns:
booleanreturns true if subscriptionBase exists otherwise false
-
isSubscriptionBaseAccessibleToUser
Checks if user has access to subscription base- Parameters:
subscriptionBaseId- unique identifier of subscription baseuserId- identifier of user- Returns:
booleantrue if user has either owner or beneficiary access to subscription base, otherwise false
-