Package de.hybris.platform.b2ctelcoservices.services

Interface TmaSubscriptionAccessService

All Known Implementing Classes:

DefaultTmaSubscriptionAccessService

public interface TmaSubscriptionAccessService

Service for operations related to the TmaSubscriptionAccessModel.

Since:

6.6

Method Summary

Modifier and Type	Method	Description
TmaSubscriptionAccessModel	createSubscriptionAccessModel(java.lang.String principalUid, java.lang.String billingSystemId, TmaSubscriptionBaseModel subscriptionBase, TmaAccessType accessType)	Create a TmaSubscriptionAccessModel for a given TmaSubscriptionBaseModel.
TmaSubscriptionAccessModel	createSubscriptionAccessModel(java.lang.String principalUid, java.lang.String billingSystemId, java.lang.String subscriberIdentity, TmaAccessType accessType)	Deprecated, for removal: This API element is subject to removal in a future version. since 1810 Please use TmaCustomerInventoryService.createNewSubscriptionHierarchy(String, TmaAccessType)
void	deleteSubscriptionAccess(java.lang.String principalUid, java.lang.String billingSystemId, java.lang.String subscriberIdentity)	Delete the TmaSubscriptionAccessModel with the id given.
TmaSubscriptionAccessModel	getSubscriptionAccessByPrincipalAndSubscriptionBase(java.lang.String principalUid, java.lang.String billingSystemId, java.lang.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.
java.util.List<TmaSubscriptionAccessModel>	getSubscriptionAccessesByPrincipalUid(java.lang.String principalUid)	Search for all TmaSubscriptionAccessModels belonging to the principal with the given uid
java.util.List<TmaSubscriptionAccessModel>	getSubscriptionAccessesBySubscriberIdentity(java.lang.String billingSystemId, java.lang.String subscriberIdentity)	Search for all TmaSubscriptionAccessModels belonging to the subscriber with the id given from the given billing system.
java.util.List<TmaSubscriptionAccessModel>	getSubscriptionAccessesByType(java.lang.String principalUid, TmaAccessType accessType)	Search for all TmaSubscriptionAccessModels belonging to the principal with the uid given, filtered by given access type.
TmaSubscriptionAccessModel	updateSubscriptionAccess(java.lang.String principalUid, java.lang.String billingSystemId, java.lang.String subscriberIdentity, TmaAccessType accessType)	Update the TmaAccessType of the TmaSubscriptionAccessModel with the id given.

Method Detail

createSubscriptionAccessModel

@Deprecated(since="1810",
            forRemoval=true)
TmaSubscriptionAccessModel createSubscriptionAccessModel(java.lang.String principalUid,
                                                         java.lang.String billingSystemId,
                                                         java.lang.String subscriberIdentity,
                                                         TmaAccessType accessType)

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

since 1810 Please use TmaCustomerInventoryService.createNewSubscriptionHierarchy(String, TmaAccessType)

Create a TmaSubscriptionAccessModel.

Parameters:

principalUid - unique identifier of the PrincipalModel

billingSystemId - unique identifier of the billing system

subscriberIdentity - unique identifier of the TmaSubscriptionBaseModel

accessType - TmaAccessType the PrincipalModel has on the TmaSubscriptionBaseModel

Returns:

the newly created TmaSubscriptionAccessModel

createSubscriptionAccessModel

TmaSubscriptionAccessModel createSubscriptionAccessModel(java.lang.String principalUid,
                                                         java.lang.String billingSystemId,
                                                         TmaSubscriptionBaseModel subscriptionBase,
                                                         TmaAccessType accessType)

Create a TmaSubscriptionAccessModel for a given TmaSubscriptionBaseModel.

Parameters:

principalUid - unique identifier of the PrincipalModel

billingSystemId - unique identifier of the billing system

subscriptionBase - subscription base for which the access type is created

accessType - TmaAccessType the PrincipalModel has on the TmaSubscriptionBaseModel

Returns:

the newly created TmaSubscriptionAccessModel

getSubscriptionAccessesByPrincipalUid

java.util.List<TmaSubscriptionAccessModel> getSubscriptionAccessesByPrincipalUid(java.lang.String principalUid)

Search for all TmaSubscriptionAccessModels belonging to the principal with the given uid

Parameters:

principalUid - uid of the principal

Returns:

a List of TmaSubscriptionAccessModel belonging to the identified principal

getSubscriptionAccessByPrincipalAndSubscriptionBase

TmaSubscriptionAccessModel getSubscriptionAccessByPrincipalAndSubscriptionBase(java.lang.String principalUid,
                                                                               java.lang.String billingSystemId,
                                                                               java.lang.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 entity

billingSystemId - unique identifier of the billing system

subscriberIdentity - unique identifier of the subscriber from the billing system

Returns:

TmaSubscriptionAccessModel identified by the above parameters

getSubscriptionAccessesBySubscriberIdentity

java.util.List<TmaSubscriptionAccessModel> getSubscriptionAccessesBySubscriberIdentity(java.lang.String billingSystemId,
                                                                                       java.lang.String subscriberIdentity)

Search for all TmaSubscriptionAccessModels belonging to the subscriber with the id given from the given billing system.

Parameters:

billingSystemId - unique identifier of the billing system

subscriberIdentity - id of the subscriber for which the TmaSubscriptionAccessModel should be retrieved

Returns:

a List of TmaSubscriptionAccessModels belonging to the same subscriber

getSubscriptionAccessesByType

java.util.List<TmaSubscriptionAccessModel> getSubscriptionAccessesByType(java.lang.String principalUid,
                                                                         TmaAccessType accessType)

Search for all TmaSubscriptionAccessModels belonging to the principal with the uid given, filtered by given access type.

Parameters:

principalUid - uid of the principal

accessType - access type level for subscription access

Returns:

a List of TmaSubscriptionAccessModel belonging to the identified principal, having the given access type

updateSubscriptionAccess

TmaSubscriptionAccessModel updateSubscriptionAccess(java.lang.String principalUid,
                                                    java.lang.String billingSystemId,
                                                    java.lang.String subscriberIdentity,
                                                    TmaAccessType accessType)

Update the TmaAccessType of the TmaSubscriptionAccessModel with the id given.

Parameters:

principalUid - unique identifier of the TmaSubscriptionAccessModel to be updated

billingSystemId - unique identifier of the billing system

subscriberIdentity - unique identifier of the subscriber from the billing system

accessType - the new value of the TmaAccessType

Returns:

the newly updated TmaSubscriptionAccessModel

deleteSubscriptionAccess

void deleteSubscriptionAccess(java.lang.String principalUid,
                              java.lang.String billingSystemId,
                              java.lang.String subscriberIdentity)

Delete the TmaSubscriptionAccessModel with the id given.

Parameters:

principalUid - the unique identifier of the TmaSubscriptionAccessModel to be deleted

billingSystemId - unique identifier of the billing system

subscriberIdentity - unique identifier of the subscriber from the billing system