Class ConsolidatedPaymentService

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

An abstract class for managing relationships between a consolidated payment order and the orders paid by it.

public abstract class ConsolidatedPaymentService

Inheritance

object

ConsolidatedPaymentService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ConsolidatedPaymentServiceExtensions.Save(ConsolidatedPaymentService, Order, Order)

ConsolidatedPaymentServiceExtensions.Save(ConsolidatedPaymentService, string, IEnumerable<string>)

ConsolidatedPaymentServiceExtensions.Save(ConsolidatedPaymentService, string, IEnumerable<string>, string?)

Remarks

Implementations are responsible for persisting and retrieving the association between a payment order and one or more paid orders.

Methods

DeletePayment(int)

Deletes the specified payment order and any related paid-order associations.

public abstract void DeletePayment(int paymentId)

Parameters

paymentId int

The numeric identifier of the payment order.

GetPaymentsByPaidOrderId(string)

Gets the consolidated payments associated with a paid order.

public abstract IEnumerable<ConsolidatedPayment> GetPaymentsByPaidOrderId(string paidOrderId)

Parameters

paidOrderId string

The ID of the paid order.

Returns

IEnumerable<ConsolidatedPayment>

A collection of ConsolidatedPayment instances.

GetPaymentsByPaymentOrderId(string)

Gets the consolidated payments associated with a payment order.

public abstract IEnumerable<ConsolidatedPayment> GetPaymentsByPaymentOrderId(string paymentOrderId)

Parameters

paymentOrderId string

The ID of the payment order.

Returns

IEnumerable<ConsolidatedPayment>

A collection of ConsolidatedPayment instances.

Save(ConsolidatedPayment)

Saves a ConsolidatedPayment instance.

public abstract void Save(ConsolidatedPayment payment)

Parameters

payment ConsolidatedPayment