Package com.microsoft.store.partnercenter.customers

Class CustomerCollectionOperations

java.lang.Object

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

com.microsoft.store.partnercenter.BasePartnerComponentString

com.microsoft.store.partnercenter.customers.CustomerCollectionOperations

All Implemented Interfaces:

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

public class CustomerCollectionOperations
extends BasePartnerComponentString
implements ICustomerCollection

The partner customers implementation.

Constructor Summary

Constructors

Constructor	Description
CustomerCollectionOperations(IPartner rootPartnerOperations)	Initializes a new instance of the CustomerCollectionOperations class.

Method Summary

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

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

CustomerCollectionOperations

public CustomerCollectionOperations(IPartner rootPartnerOperations)

Initializes a new instance of the CustomerCollectionOperations class.

Parameters:

rootPartnerOperations - The root partner operations instance.

Method Details

getUsageRecords

public ICustomerUsageRecordCollection getUsageRecords()

Obtains the customer usage record operations.

Specified by:

getUsageRecords in interface ICustomerCollection

Returns:

The customer usage record operations.

getRelationshipRequests

public ICustomerRelationshipRequest getRelationshipRequests()

Obtains the customer relationship request operations.

Specified by:

getRelationshipRequests in interface ICustomerCollection

Returns:

The customer relationship request operations.

byId

public ICustomer byId(String customerId)

Gets a single customer operations.

Specified by:

byId in interface ICustomerCollection

Parameters:

customerId - The customer identifier.

Returns:

The customer operations.

create

public Customer create(Customer newCustomer)

Creates a new customer.

Specified by:

create in interface IEntityCreateOperations<Customer,Customer>

Parameters:

newCustomer - The new customer information.

Returns:

The customer information that was just created.

get

public SeekBasedResourceCollection<Customer> get()

Retrieves all customers associated to the partner.

Specified by:

get in interface ICustomerCollection

Specified by:

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

Returns:

All customers.

query

public 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.

Specified by:

query in interface ICustomerCollection

Parameters:

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

Returns:

The requested customers.