CustomerCollectionOperations Class

Package:

com.microsoft.store.partnercenter.customers

Maven Artifact:

com.microsoft.store:partnercenter:1.15.3

• java.lang.Object
• • com.microsoft.store.partnercenter.BasePartnerComponent<TContext>
  • • com.microsoft.store.partnercenter.BasePartnerComponentString
    • • com.microsoft.store.partnercenter.customers.CustomerCollectionOperations

Implements

ICustomerCollection

public class CustomerCollectionOperations extends BasePartnerComponentString implements ICustomerCollection

The partner customers implementation.

Constructor Summary

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

Method Summary

Modifier and Type	Method and 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.

Inherited Members

BasePartnerComponent<TContext>.getContext() BasePartnerComponent<TContext>.getPartner() java.lang.Object.clone() java.lang.Object.equals(java.lang.Object) java.lang.Object.finalize() java.lang.Object.getClass() java.lang.Object.hashCode() java.lang.Object.notify() java.lang.Object.notifyAll() java.lang.Object.toString() java.lang.Object.wait() java.lang.Object.wait(long) java.lang.Object.wait(long,int)

Constructor Details

CustomerCollectionOperations

public CustomerCollectionOperations(IPartner rootPartnerOperations)

Initializes a new instance of the CustomerCollectionOperations class.

Parameters:

rootPartnerOperations - The root partner operations instance.

Method Details

byId

public ICustomer byId(String customerId)

Gets a single customer operations.

Parameters:

customerId - The customer identifier.

Returns:

The customer operations.

create

public Customer create(Customer newCustomer)

Creates a new customer.

Parameters:

newCustomer - The new customer information.

Returns:

The customer information that was just created.

get

public SeekBasedResourceCollection get()

Retrieves all customers associated to the partner.

Returns:

All customers.

getRelationshipRequests

public ICustomerRelationshipRequest getRelationshipRequests()

Obtains the customer relationship request operations.

Returns:

The customer relationship request operations.

getUsageRecords

public ICustomerUsageRecordCollection getUsageRecords()

Obtains the customer usage record operations.

Returns:

The customer usage record operations.

query

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