Package com.microsoft.store.partnercenter.orders

Class OrderCollectionOperations

java.lang.Object

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

com.microsoft.store.partnercenter.BasePartnerComponentString

com.microsoft.store.partnercenter.orders.OrderCollectionOperations

All Implemented Interfaces:

IEntireEntityCollectionRetrievalOperations<Order,ResourceCollection<Order>>, IEntityCreateOperations<Order,Order>, IEntitySelector<String,IOrder>, IPartnerComponent<String>, IPartnerComponentString, IOrderCollection

public class OrderCollectionOperations
extends BasePartnerComponentString
implements IOrderCollection

Order collection operations implementation class.

Constructor Summary

Constructors

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

Method Summary

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

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

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.

Specified by:

byBillingCycleType in interface IOrderCollection

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.

Specified by:

byId in interface IEntitySelector<String,IOrder>

Parameters:

orderId - The order identifier.

Returns:

The order operations.

create

public Order create(Order newOrder)

Places a new order for the customer.

Specified by:

create in interface IEntityCreateOperations<Order,Order>

Parameters:

newOrder - The new order.

Returns:

The newly created order.

get

public ResourceCollection<Order> get()

Retrieves all the orders the customer made.

Specified by:

get in interface IEntireEntityCollectionRetrievalOperations<Order,ResourceCollection<Order>>

Returns:

All the customer orders.

get

public ResourceCollection<Order> get(Boolean includePrice)

Gets a collection of orders.

Specified by:

get in interface IOrderCollection

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.