Interface TmaSubscriptionAccessService
- All Known Implementing Classes:
DefaultTmaSubscriptionAccessService
public interface TmaSubscriptionAccessService
Service for operations related to the
TmaSubscriptionAccessModel.- Since:
- 6.6
-
Method Summary
Modifier and TypeMethodDescriptioncreateSubscriptionAccessModel(String principalUid, String billingSystemId, TmaSubscriptionBaseModel subscriptionBase, TmaAccessType accessType) Create aTmaSubscriptionAccessModelfor a givenTmaSubscriptionBaseModel.voiddeleteSubscriptionAccess(String principalUid, String billingSystemId, String subscriberIdentity) Delete theTmaSubscriptionAccessModelwith the id given.getSubscriptionAccessByPrincipalAndSubscriptionBase(String principalUid, String billingSystemId, String subscriberIdentity) Search for the subscription access object uniquely identified by the principal unique identifier, and the billing system id and subscriber identity unique combination.getSubscriptionAccessesByPrincipalUid(String principalUid) Search for allTmaSubscriptionAccessModels belonging to the principal with the given uidgetSubscriptionAccessesBySubscriberIdentity(String billingSystemId, String subscriberIdentity) Search for allTmaSubscriptionAccessModels belonging to the subscriber with the id given from the given billing system.getSubscriptionAccessesByType(String principalUid, TmaAccessType accessType) Search for allTmaSubscriptionAccessModels belonging to the principal with the uid given, filtered by given access type.updateSubscriptionAccess(String principalUid, String billingSystemId, String subscriberIdentity, TmaAccessType accessType) Update theTmaAccessTypeof theTmaSubscriptionAccessModelwith the id given.
-
Method Details
-
createSubscriptionAccessModel
TmaSubscriptionAccessModel createSubscriptionAccessModel(String principalUid, String billingSystemId, TmaSubscriptionBaseModel subscriptionBase, TmaAccessType accessType) Create aTmaSubscriptionAccessModelfor a givenTmaSubscriptionBaseModel.- Parameters:
principalUid- unique identifier of thePrincipalModelbillingSystemId- unique identifier of the billing systemsubscriptionBase- subscription base for which the access type is createdaccessType-TmaAccessTypethePrincipalModelhas on theTmaSubscriptionBaseModel- Returns:
- the newly created
TmaSubscriptionAccessModel
-
getSubscriptionAccessesByPrincipalUid
Search for allTmaSubscriptionAccessModels belonging to the principal with the given uid- Parameters:
principalUid- uid of the principal- Returns:
- a
ListofTmaSubscriptionAccessModelbelonging to the identified principal
-
getSubscriptionAccessByPrincipalAndSubscriptionBase
TmaSubscriptionAccessModel getSubscriptionAccessByPrincipalAndSubscriptionBase(String principalUid, String billingSystemId, String subscriberIdentity) Search for the subscription access object uniquely identified by the principal unique identifier, and the billing system id and subscriber identity unique combination.- Parameters:
principalUid- unique identifier of the Principal entitybillingSystemId- unique identifier of the billing systemsubscriberIdentity- unique identifier of the subscriber from the billing system- Returns:
TmaSubscriptionAccessModelidentified by the above parameters
-
getSubscriptionAccessesBySubscriberIdentity
List<TmaSubscriptionAccessModel> getSubscriptionAccessesBySubscriberIdentity(String billingSystemId, String subscriberIdentity) Search for allTmaSubscriptionAccessModels belonging to the subscriber with the id given from the given billing system.- Parameters:
billingSystemId- unique identifier of the billing systemsubscriberIdentity- id of the subscriber for which theTmaSubscriptionAccessModelshould be retrieved- Returns:
- a
ListofTmaSubscriptionAccessModels belonging to the same subscriber
-
getSubscriptionAccessesByType
List<TmaSubscriptionAccessModel> getSubscriptionAccessesByType(String principalUid, TmaAccessType accessType) Search for allTmaSubscriptionAccessModels belonging to the principal with the uid given, filtered by given access type.- Parameters:
principalUid- uid of the principalaccessType- access type level for subscription access- Returns:
- a
ListofTmaSubscriptionAccessModelbelonging to the identified principal, having the given access type
-
updateSubscriptionAccess
TmaSubscriptionAccessModel updateSubscriptionAccess(String principalUid, String billingSystemId, String subscriberIdentity, TmaAccessType accessType) Update theTmaAccessTypeof theTmaSubscriptionAccessModelwith the id given.- Parameters:
principalUid- unique identifier of theTmaSubscriptionAccessModelto be updatedbillingSystemId- unique identifier of the billing systemsubscriberIdentity- unique identifier of the subscriber from the billing systemaccessType- the new value of theTmaAccessType- Returns:
- the newly updated
TmaSubscriptionAccessModel
-
deleteSubscriptionAccess
void deleteSubscriptionAccess(String principalUid, String billingSystemId, String subscriberIdentity) Delete theTmaSubscriptionAccessModelwith the id given.- Parameters:
principalUid- the unique identifier of theTmaSubscriptionAccessModelto be deletedbillingSystemId- unique identifier of the billing systemsubscriberIdentity- unique identifier of the subscriber from the billing system
-