Package com.microsoft.store.partnercenter.entitlements

Class EntitlementCollectionOperations

java.lang.Object

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

com.microsoft.store.partnercenter.BasePartnerComponentString

com.microsoft.store.partnercenter.entitlements.EntitlementCollectionOperations

All Implemented Interfaces:

IEntitlementCollection, IEntireEntityCollectionRetrievalOperations<Entitlement,ResourceCollection<Entitlement>>, IPartnerComponent<String>, IPartnerComponentString

public class EntitlementCollectionOperations
extends BasePartnerComponentString
implements IEntitlementCollection

Entitlement collection operations implementation class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
IEntireEntityCollectionRetrievalOperations<Entitlement,ResourceCollection<Entitlement>>	byEntitlementType(String entitlementType)	Retrieves the operations that can be applied on entitlements with a given entitlement type.
ResourceCollection<Entitlement>	get()	Gets the entitlements for a customer.
ResourceCollection<Entitlement>	get(Boolean showExpiry)	Gets the entitlements for a 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

EntitlementCollectionOperations

public EntitlementCollectionOperations(IPartner rootPartnerOperations, String customerId)

Initializes a new instance of the EntitlementCollectionOperations class.

Parameters:

rootPartnerOperations - The root partner operations instance.

customerId - Identifier for the customer.

Method Details

byEntitlementType

public IEntireEntityCollectionRetrievalOperations<Entitlement,ResourceCollection<Entitlement>> byEntitlementType(String entitlementType)

Retrieves the operations that can be applied on entitlements with a given entitlement type.

Specified by:

byEntitlementType in interface IEntitlementCollection

Parameters:

entitlementType - The type of entitlement.

Returns:

The entitlement collection operations by entitlement type.

get

public ResourceCollection<Entitlement> get()

Gets the entitlements for a customer.

Specified by:

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

Returns:

The collection of entitlements for the customer.

get

public ResourceCollection<Entitlement> get(Boolean showExpiry)

Gets the entitlements for a customer.

Specified by:

get in interface IEntitlementCollection

Parameters:

showExpiry - A flag to indicate if the expiry date is required to be returned along with the entitlement (if applicable).

Returns:

The collection of entitlements for the customer.