Package com.microsoft.store.partnercenter.customerusers

Class CustomerUsersCollectionOperations

java.lang.Object

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

com.microsoft.store.partnercenter.customerusers.CustomerUsersCollectionOperations

All Implemented Interfaces:

ICustomerUserCollection, IEntireEntityCollectionRetrievalOperations<CustomerUser,SeekBasedResourceCollection<CustomerUser>>, IEntityCreateOperations<CustomerUser,CustomerUser>, IPartnerComponent<String>, IPartnerComponentString

public class CustomerUsersCollectionOperations
extends BasePartnerComponent<String>
implements ICustomerUserCollection

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ICustomerUser	byId(String userId)	Retrieves the customer user operations for the specified user.
CustomerUser	create(CustomerUser newCustomerUser)	Creates a new user.
SeekBasedResourceCollection<CustomerUser>	get()	Retrieves all the customer users.
SeekBasedResourceCollection<CustomerUser>	query(IQuery customerUsersQuery)	Queries customer users associated to the partner's customers.

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

CustomerUsersCollectionOperations

public CustomerUsersCollectionOperations(IPartner rootPartnerOperations, String customerId)

Initializes a new instance of the CustomerUsersCollectionOperations class.

Parameters:

rootPartnerOperations - The root partner operations instance.

customerId - The customer identifier.

Method Details

create

public CustomerUser create(CustomerUser newCustomerUser)

Creates a new user.

Specified by:

create in interface ICustomerUserCollection

Specified by:

create in interface IEntityCreateOperations<CustomerUser,CustomerUser>

Parameters:

newCustomerUser - The user to be created.

Returns:

The newly created user.

get

public SeekBasedResourceCollection<CustomerUser> get()

Retrieves all the customer users.

Specified by:

get in interface ICustomerUserCollection

Specified by:

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

Returns:

All the customer users.

byId

public ICustomerUser byId(String userId)

Retrieves the customer user operations for the specified user.

Specified by:

byId in interface ICustomerUserCollection

Parameters:

userId - The user identifier.

Returns:

The customer user operations for the specified user.

query

public SeekBasedResourceCollection<CustomerUser> query(IQuery customerUsersQuery)

Queries customer users associated to the partner's customers.

Specified by:

query in interface ICustomerUserCollection

Parameters:

customerUsersQuery - A query to apply onto customer users. Check QueryFactory to see how to build queries.

Returns:

Customer user collection.