Class OrderForm
Contains the order information.
Implements
Inherited Members
Namespace: Mediachase.Commerce.Orders
Assembly: Mediachase.Commerce.dll
Version: 10.8.0Syntax
public class OrderForm : OrderStorageBase, IXmlSerializable, IStorageObject, ICloneable, ISerializable, IOrderForm, IExtendedPropertiesConstructors
OrderForm()
Initializes a new instance of the OrderForm class.
Declaration
public OrderForm()OrderForm(IDataReader)
Initializes a new instance of the OrderForm class.
Declaration
public OrderForm(IDataReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| System.Data.IDataReader | reader | The reader. |
OrderForm(SerializationInfo, StreamingContext)
Initializes a new instance of the OrderForm class.
Declaration
protected OrderForm(SerializationInfo info, StreamingContext context)Parameters
| Type | Name | Description |
|---|---|---|
| System.Runtime.Serialization.SerializationInfo | info | The info. |
| System.Runtime.Serialization.StreamingContext | context | The context. |
Properties
AuthorizedPaymentTotal
Gets or sets the authorized payment total.
Declaration
public decimal AuthorizedPaymentTotal { get; set; }Property Value
| Type | Description |
|---|---|
| System.Decimal | The authorized payment total. |
BillingAddressId
Gets or sets the billing address id. The id is the name of the address in OrderAddress collection.
Declaration
public string BillingAddressId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The billing address id. |
CapturedPaymentTotal
Gets or sets the captured payment total.
Declaration
public decimal CapturedPaymentTotal { get; set; }Property Value
| Type | Description |
|---|---|
| System.Decimal | The captured payment total. |
DefaultName
Gets the default name for the order form.
Declaration
public static string DefaultName { get; }Property Value
| Type | Description |
|---|---|
| System.String | default name for the order form. |
DiscountAmount
Gets or sets the discount amount. This amount includes shipping discounts as well.
Declaration
public decimal DiscountAmount { get; set; }Property Value
| Type | Description |
|---|---|
| System.Decimal | The discount amount. |
Discounts
Gets the discounts.
Declaration
public OrderFormDiscountCollection Discounts { get; }Property Value
| Type | Description |
|---|---|
| OrderFormDiscountCollection | The discounts. |
ExchangeOrderGroupId
Gets or sets the related this RMA request Exchange order identity
Declaration
public int? ExchangeOrderGroupId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> | The exchange order group id. |
HandlingTotal
Gets or sets the handling total.
Declaration
public decimal HandlingTotal { get; set; }Property Value
| Type | Description |
|---|---|
| System.Decimal | The handling total. |
LineItems
Gets the line items.
Declaration
public LineItemCollection LineItems { get; }Property Value
| Type | Description |
|---|---|
| LineItemCollection | The line items. |
Name
Gets or sets the name.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The name. |
OrderFormId
Gets the order form id.
Declaration
public int OrderFormId { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The order form id. |
OrderGroupId
Gets the order group id.
Declaration
public int OrderGroupId { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The order group id. |
OrigOrderFormId
Gets or sets the Parent OrderForm identity for RMA request
Declaration
public int? OrigOrderFormId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> | The orig order form id. |
Parent
Gets the parent Order Group.
Declaration
public OrderGroup Parent { get; }Property Value
| Type | Description |
|---|---|
| OrderGroup | The parent. |
Payments
Gets the payments.
Declaration
public PaymentCollection Payments { get; }Property Value
| Type | Description |
|---|---|
| PaymentCollection | The payments. |
ProviderId
Gets or sets the provider id.
Declaration
public string ProviderId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The provider id. |
ReturnAuthCode
Gets or sets the RMA auth code. Using for procedure RMA authentifications.
Declaration
public string ReturnAuthCode { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The rma auth code. |
ReturnComment
Gets or sets the rma comment.
Declaration
public string ReturnComment { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The rma comment. |
ReturnFormNumberMethod
Declaration
public Func<OrderForm, string> ReturnFormNumberMethod { get; set; }Property Value
| Type | Description |
|---|---|
| System.Func<OrderForm, System.String> |
ReturnName
Gets the name of the return.
Declaration
public static string ReturnName { get; }Property Value
| Type | Description |
|---|---|
| System.String | The name of the return. |
ReturnType
Gets or sets the Return Type. For example can be "Refund", "Exchange" etc.
Declaration
public string ReturnType { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The type of the Rma request. |
RMANumber
Gets or sets the RMA number.
Declaration
public string RMANumber { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The RMA number. |
Shipments
Gets the shipments.
Declaration
public ShipmentCollection Shipments { get; }Property Value
| Type | Description |
|---|---|
| ShipmentCollection | The shipments. |
ShippingTotal
Gets or sets the shipping total, does not includes discounts that have been applied to each shipment.
Declaration
public decimal ShippingTotal { get; set; }Property Value
| Type | Description |
|---|---|
| System.Decimal | The shipping total. |
Status
Gets or sets the status.
Declaration
public string Status { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The status. |
SubTotal
Gets or sets the sub total.
Declaration
public decimal SubTotal { get; set; }Property Value
| Type | Description |
|---|---|
| System.Decimal | The sub total. |
TaxTotal
Gets or sets the tax total.
Declaration
public decimal TaxTotal { get; set; }Property Value
| Type | Description |
|---|---|
| System.Decimal | The tax total. |
Total
Gets or sets the total.
Declaration
public decimal Total { get; set; }Property Value
| Type | Description |
|---|---|
| System.Decimal | The total. |
Methods
AcceptChanges()
Accepts the changes.
Declaration
public override void AcceptChanges()Overrides
DeepCloneImplementation()
Extends base implementation with deep cloning of CouponCodes, LineItems, Payments, Promotions and Shipments.
Declaration
protected override object DeepCloneImplementation()Returns
| Type | Description |
|---|---|
| System.Object | A new object that is a deep copy of the current instance. |
Overrides
Delete()
Deletes this instance.
Declaration
public override void Delete()Overrides
GetObjectData(SerializationInfo, StreamingContext)
Gets the object data.
Declaration
public override void GetObjectData(SerializationInfo info, StreamingContext context)Parameters
| Type | Name | Description |
|---|---|---|
| System.Runtime.Serialization.SerializationInfo | info | The info. |
| System.Runtime.Serialization.StreamingContext | context | The context. |
Overrides
Initialize()
Initializes this instance.
Declaration
protected virtual void Initialize()IsReturnOrderForm(OrderForm)
Determines whether OrderForm is Return order form
Declaration
public static bool IsReturnOrderForm(OrderForm orderForm)Parameters
| Type | Name | Description |
|---|---|---|
| OrderForm | orderForm |
Returns
| Type | Description |
|---|---|
| System.Boolean |
LoadLineItems(DataTableCollection, String)
Fill line items collection.
Declaration
protected void LoadLineItems(DataTableCollection tables, string filter)Parameters
| Type | Name | Description |
|---|---|---|
| System.Data.DataTableCollection | tables | |
| System.String | filter |
LoadPayment(DataRow[])
Loads the payment from the reader object and adds it to the payments collection.
Declaration
protected void LoadPayment(DataRow[] rows)Parameters
| Type | Name | Description |
|---|---|---|
| System.Data.DataRow[] | rows | The rows. |
LoadPayment(DataView)
Loads the payment from the reader object and adds it to the payments collection.
Declaration
protected void LoadPayment(DataView view)Parameters
| Type | Name | Description |
|---|---|---|
| System.Data.DataView | view | The view. |
LoadPayments(DataTableCollection, String)
Loads the payments from the returned dataset and adds them to the payments collection.
Declaration
protected void LoadPayments(DataTableCollection tables, string filter)Parameters
| Type | Name | Description |
|---|---|---|
| System.Data.DataTableCollection | tables | The tables. |
| System.String | filter | The filter. |
PopulateCollections(DataTableCollection, String)
Populates collections within table. The tables used will be removed from the table collection. Override this method to populate your custom collection objects.
Declaration
protected override void PopulateCollections(DataTableCollection tables, string filter)Parameters
| Type | Name | Description |
|---|---|---|
| System.Data.DataTableCollection | tables | The tables. |
| System.String | filter | The filter. |
Overrides
ReadXml(XmlReader)
Generates an object from its XML representation.
Declaration
public override void ReadXml(XmlReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| System.Xml.XmlReader | reader | The System.Xml.XmlReader stream from which the object is deserialized. |
Overrides
RemoveLineItemFromShipments(LineItem)
Declaration
public void RemoveLineItemFromShipments(LineItem lineItem)Parameters
| Type | Name | Description |
|---|---|---|
| LineItem | lineItem |
SetParent(Object)
Sets the parent order group.
Declaration
public override void SetParent(object parentGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | parentGroup | The parent group. |
Overrides
WriteXml(XmlWriter)
Converts an object into its XML representation.
Declaration
public override void WriteXml(XmlWriter writer)Parameters
| Type | Name | Description |
|---|---|---|
| System.Xml.XmlWriter | writer | The System.Xml.XmlWriter stream to which the object is serialized |
Overrides
Explicit Interface Implementations
IOrderForm.CouponCodes
Gets the supplied coupon codes.
Declaration
ICollection<string> IOrderForm.CouponCodes { get; }Returns
| Type | Description |
|---|---|
| System.Collections.Generic.ICollection<System.String> |
IOrderForm.Payments
Declaration
ICollection<IPayment> IOrderForm.Payments { get; }Returns
| Type | Description |
|---|---|
| System.Collections.Generic.ICollection<IPayment> |
IOrderForm.Promotions
Gets the promotions that have been applied this order form.
Declaration
IList<PromotionInformation> IOrderForm.Promotions { get; }Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IList<PromotionInformation> |
IOrderForm.Shipments
Gets the shipments on the order form.
Declaration
ICollection<IShipment> IOrderForm.Shipments { get; }Returns
| Type | Description |
|---|---|
| System.Collections.Generic.ICollection<IShipment> |
IExtendedProperties.Properties
Gets the property bag for dealing with custom meta fields.
Declaration
Hashtable IExtendedProperties.Properties { get; }Returns
| Type | Description |
|---|---|
| System.Collections.Hashtable |
