Class OrderStatus
Represents possible statuses of an order.
Inheritance
System.Object
OrderStatus
Implements
System.IEquatable<OrderStatus>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Mediachase.Commerce.Orders
Assembly: Mediachase.Commerce.dll
Version: 13.30.0Syntax
public class OrderStatus : IEquatable<OrderStatus>Constructors
OrderStatus(Int32, String)
Initializes a new instance of OrderStatus.
Declaration
public OrderStatus(int value, string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | value | |
| System.String | name |
Properties
AwaitingExchange
Declaration
public static OrderStatus AwaitingExchange { get; }Property Value
| Type | Description |
|---|---|
| OrderStatus |
Cancelled
Declaration
public static OrderStatus Cancelled { get; }Property Value
| Type | Description |
|---|---|
| OrderStatus |
Completed
Declaration
public static OrderStatus Completed { get; }Property Value
| Type | Description |
|---|---|
| OrderStatus |
Id
Gets the value of the status.
Declaration
public int Id { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
InProgress
Declaration
public static OrderStatus InProgress { get; }Property Value
| Type | Description |
|---|---|
| OrderStatus |
Name
Gets the name of the status.
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
OnHold
Declaration
public static OrderStatus OnHold { get; }Property Value
| Type | Description |
|---|---|
| OrderStatus |
PartiallyShipped
Declaration
public static OrderStatus PartiallyShipped { get; }Property Value
| Type | Description |
|---|---|
| OrderStatus |
RegisteredStatuses
Registered statuses.
Declaration
public static IEnumerable<OrderStatus> RegisteredStatuses { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<OrderStatus> |
Methods
Equals(OrderStatus)
Declaration
public bool Equals(OrderStatus other)Parameters
| Type | Name | Description |
|---|---|---|
| OrderStatus | other |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Equals(Object)
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
System.Object.Equals(System.Object)
GetHashCode()
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 |
Overrides
System.Object.GetHashCode()
RegisterStatus(OrderStatus)
Registers a new order status.
Declaration
public static void RegisterStatus(OrderStatus status)Parameters
| Type | Name | Description |
|---|---|---|
| OrderStatus | status |
ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String |
Overrides
System.Object.ToString()
TryParse(Int32, out OrderStatus)
Tries to parse a name to a known OrderShipmentStatus
Declaration
public static bool TryParse(int status, out OrderStatus orderStatus)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | status | The name to parse. |
| OrderStatus | orderStatus | The known status. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if parsed successfully, false otherwise. |
TryParse(String, out OrderStatus)
Tries to parse a name to a known OrderStatus
Declaration
public static bool TryParse(string status, out OrderStatus orderStatus)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | status | The name to parse. |
| OrderStatus | orderStatus | The known status. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if parsed successfully, false otherwise. |
Implements
System.IEquatable<T>
