Package com.microsoft.store.partnercenter.orders

Class OrderOperations

java.lang.Object

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

com.microsoft.store.partnercenter.orders.OrderOperations

All Implemented Interfaces:

IEntityGetOperations<Order>, IEntityPatchOperations<Order>, IPartnerComponent<Tuple<String,String>>, IOrder

public class OrderOperations
extends BasePartnerComponent<Tuple<String,String>>
implements IOrder

Order operations implementation class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Order	get()	Gets the order information.
Order	get(Boolean includePrice)	Gets the order information.
IOrderLineItemCollection	getOrderLineItems()	Gets line item collection operations.
IOrderProvisioningStatus	getProvisioningStatus()	Gets the order provisioning status operations.
Order	patch(Order order)	Updates a customer order.

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

OrderOperations

public OrderOperations(IPartner rootPartnerOperations, String customerId, String orderId)

Initializes a new instance of the OrderOperations class.

Parameters:

rootPartnerOperations - The root partner operations instance.

customerId - The customer identifier.

orderId - The order identifier.

Method Details

get

public Order get()

Gets the order information.

Specified by:

get in interface IEntityGetOperations<Order>

Returns:

The customer order.

get

public Order get(Boolean includePrice)

Gets the order information.

Specified by:

get in interface IOrder

Parameters:

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

Returns:

The order information including pricing details (based on access permissions) when requested.

getOrderLineItems

public IOrderLineItemCollection getOrderLineItems()

Gets line item collection operations.

Specified by:

getOrderLineItems in interface IOrder

Returns:

The line item collection operations.

getProvisioningStatus

public IOrderProvisioningStatus getProvisioningStatus()

Gets the order provisioning status operations.

Specified by:

getProvisioningStatus in interface IOrder

Returns:

The order provisioning status operations.

patch

public Order patch(Order order)

Updates a customer order.

Specified by:

patch in interface IEntityPatchOperations<Order>

Parameters:

order - The order to update.

Returns:

The updated order.