OrderCollectionOperations Class

Package:
com.microsoft.store.partnercenter.orders
Maven Artifact:
com.microsoft.store:partnercenter:1.15.3

Implements

IOrderCollection

public class OrderCollectionOperations extends BasePartnerComponentString implements IOrderCollection

Order collection operations implementation class.

Constructor Summary

Constructor Description
OrderCollectionOperations(IPartner rootPartnerOperations, String customerId)

Initializes a new instance of the OrderCollectionOperations class.

Method Summary

Modifier and Type Method and Description
IOrderCollectionByBillingCycleType byBillingCycleType(BillingCycleType billingCycleType)

Gets the order collection behavior given a billing cycle type.
IOrder byId(String orderId)

Get the order operations for the specified order.
Order create(Order newOrder)

Places a new order for the customer.
ResourceCollection<Order> get()

Retrieves all the orders the customer made.
ResourceCollection<Order> get(Boolean includePrice)

Gets a collection of orders.

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

OrderCollectionOperations

public OrderCollectionOperations(IPartner rootPartnerOperations, String customerId)

Initializes a new instance of the OrderCollectionOperations class.

Parameters:

rootPartnerOperations - The root partner operations instance.
customerId - The customer tenant identifier.

Method Details

byBillingCycleType

public IOrderCollectionByBillingCycleType byBillingCycleType(BillingCycleType billingCycleType)

Gets the order collection behavior given a billing cycle type.

Parameters:

billingCycleType - The billing cycle type.

Returns:

The order collection by billing cycle type.

byId

public IOrder byId(String orderId)

Get the order operations for the specified order.

Parameters:

orderId - The order identifier.

Returns:

The order operations.

create

public Order create(Order newOrder)

Places a new order for the customer.

Parameters:

newOrder - The new order.

Returns:

The newly created order.

get

public ResourceCollection get()

Retrieves all the orders the customer made.

Returns:

All the customer orders.

get

public ResourceCollection get(Boolean includePrice)

Gets a collection of orders.

Parameters:

includePrice - A flag indicating whether to include pricing details in the order information or not.

Returns:

The collection of orders including pricing details (based on access permissions) when requested.

Applies to