Package com.microsoft.store.partnercenter.customers

Interface ICustomerCollection

All Superinterfaces:

IEntireEntityCollectionRetrievalOperations<Customer,SeekBasedResourceCollection<Customer>>, IEntityCreateOperations<Customer,Customer>, IPartnerComponent<String>, IPartnerComponentString

All Known Implementing Classes:

CustomerCollectionOperations

public interface ICustomerCollection
extends IPartnerComponentString, IEntityCreateOperations<Customer,Customer>, IEntireEntityCollectionRetrievalOperations<Customer,SeekBasedResourceCollection<Customer>>

Represents the behavior of the partner customers.

Method Summary

Modifier and Type	Method	Description
ICustomer	byId(String customerId)	Gets a single customer operations.
SeekBasedResourceCollection<Customer>	get()	Retrieves all the partner's customers.
ICustomerRelationshipRequest	getRelationshipRequests()	Gets the customer relationship request operations.
ICustomerUsageRecordCollection	getUsageRecords()	Gets the customer usage record operations.
SeekBasedResourceCollection<Customer>	query(IQuery customersQuery)	Queries customers associated to the partner.

Methods inherited from interface com.microsoft.store.partnercenter.genericoperations.IEntityCreateOperations

create

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

getContext, getPartner

Method Details

getUsageRecords

ICustomerUsageRecordCollection getUsageRecords()

Gets the customer usage record operations.

Returns:

The customer usage record operations.

getRelationshipRequests

ICustomerRelationshipRequest getRelationshipRequests()

Gets the customer relationship request operations.

Returns:

The customer relationship request operations.

byId

ICustomer byId(String customerId)

Gets a single customer operations.

Parameters:

customerId - The customer identifier.

Returns:

The customer operations.

get

SeekBasedResourceCollection<Customer> get()

Retrieves all the partner's customers.

Specified by:

get in interface IEntireEntityCollectionRetrievalOperations<Customer,SeekBasedResourceCollection<Customer>>

Returns:

The partner's customers.

query

SeekBasedResourceCollection<Customer> query(IQuery customersQuery)

Queries customers associated to the partner. - Count queries are not supported by this operation. - You can set the page size or filter or do both at the same time. - Sort is not supported. - You can navigate to other pages by specifying a seek query with the seek operation and the continuation token sent by the previous operation.

Parameters:

customersQuery - A query to apply onto customers. Check QueryFactory to see how to build queries.

Returns:

The requested customers.