Package com.microsoft.store.partnercenter.subscriptions

Class SubscriptionCollectionOperations

java.lang.Object

com.microsoft.store.partnercenter.BasePartnerComponent<String>

com.microsoft.store.partnercenter.BasePartnerComponentString

com.microsoft.store.partnercenter.subscriptions.SubscriptionCollectionOperations

All Implemented Interfaces:

IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>>, IPartnerComponent<String>, IPartnerComponentString, ISubscriptionCollection

public class SubscriptionCollectionOperations
extends BasePartnerComponentString
implements ISubscriptionCollection

The customer subscriptions implementation.

Constructor Summary

Constructors

Constructor	Description
SubscriptionCollectionOperations(IPartner rootPartnerOperations, String customerId)	Initializes a new instance of the SubscriptionCollectionOperations class.

Method Summary

Modifier and Type	Method	Description
ISubscription	byId(String subscriptionId)	Retrieves a specific customer subscription behavior.
IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>>	byOrder(String orderId)	Groups customer subscriptions by an order.
IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>>	byPartner(String partnerId)	Groups customer subscriptions by a partner.
ResourceCollection<Subscription>	get()	Retrieves all subscriptions.
ISubscriptionMonthlyUsageRecordCollection	getUsageRecords()	Obtains the subscription usage records behavior for the customer.

Methods inherited from class com.microsoft.store.partnercenter.BasePartnerComponent

getContext, getPartner

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microsoft.store.partnercenter.IPartnerComponent

getContext, getPartner

Constructor Details

SubscriptionCollectionOperations

public SubscriptionCollectionOperations(IPartner rootPartnerOperations, String customerId)

Initializes a new instance of the SubscriptionCollectionOperations class.

Parameters:

rootPartnerOperations - The root partner operations instance.

customerId - The customer Id to whom the subscriptions belong.

Method Details

getUsageRecords

public ISubscriptionMonthlyUsageRecordCollection getUsageRecords()

Obtains the subscription usage records behavior for the customer.

Specified by:

getUsageRecords in interface ISubscriptionCollection

Returns:

The customer subscription usage records.

byOrder

public IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>> byOrder(String orderId)

Groups customer subscriptions by an order.

Specified by:

byOrder in interface ISubscriptionCollection

Parameters:

orderId - The order id.

Returns:

The order subscriptions operations.

byPartner

public IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>> byPartner(String partnerId)

Groups customer subscriptions by a partner.

Specified by:

byPartner in interface ISubscriptionCollection

Parameters:

partnerId - The partner id.

Returns:

The partner subscriptions operations.

byId

public ISubscription byId(String subscriptionId)

Retrieves a specific customer subscription behavior.

Specified by:

byId in interface ISubscriptionCollection

Parameters:

subscriptionId - The subscription identifier

Returns:

The customer subscription.

get

public ResourceCollection<Subscription> get()

Retrieves all subscriptions.

Specified by:

get in interface IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>>

Specified by:

get in interface ISubscriptionCollection

Returns:

The subscriptions.