Class OrderShipmentStatus
Represents possible statuses of a shipment.
Inheritance
System.Object
OrderShipmentStatus
Implements
System.IEquatable<OrderShipmentStatus>
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 OrderShipmentStatus : IEquatable<OrderShipmentStatus>Constructors
OrderShipmentStatus(Int32, String)
Initializes a new instance of OrderStatus.
Declaration
public OrderShipmentStatus(int value, string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | value | |
| System.String | name |
Properties
AwaitingInventory
Declaration
public static OrderShipmentStatus AwaitingInventory { get; }Property Value
| Type | Description |
|---|---|
| OrderShipmentStatus |
Cancelled
Declaration
public static OrderShipmentStatus Cancelled { get; }Property Value
| Type | Description |
|---|---|
| OrderShipmentStatus |
Id
Gets id of the status
Declaration
public int Id { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
InventoryAssigned
Declaration
public static OrderShipmentStatus InventoryAssigned { get; }Property Value
| Type | Description |
|---|---|
| OrderShipmentStatus |
Name
Gets name of the status.
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
OnHold
Declaration
public static OrderShipmentStatus OnHold { get; }Property Value
| Type | Description |
|---|---|
| OrderShipmentStatus |
Packing
Declaration
public static OrderShipmentStatus Packing { get; }Property Value
| Type | Description |
|---|---|
| OrderShipmentStatus |
RegisteredStatuses
Registered order shipment statuses.
Declaration
public static IEnumerable<OrderShipmentStatus> RegisteredStatuses { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<OrderShipmentStatus> |
Released
Declaration
public static OrderShipmentStatus Released { get; }Property Value
| Type | Description |
|---|---|
| OrderShipmentStatus |
Shipped
Declaration
public static OrderShipmentStatus Shipped { get; }Property Value
| Type | Description |
|---|---|
| OrderShipmentStatus |
Methods
Equals(OrderShipmentStatus)
Declaration
public bool Equals(OrderShipmentStatus other)Parameters
| Type | Name | Description |
|---|---|---|
| OrderShipmentStatus | 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(OrderShipmentStatus)
Registers a new order status.
Declaration
public static void RegisterStatus(OrderShipmentStatus status)Parameters
| Type | Name | Description |
|---|---|---|
| OrderShipmentStatus | status |
ToString()
Converts this status to a string.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String |
Overrides
System.Object.ToString()
TryParse(Int32, out OrderShipmentStatus)
Tries to parse a value to a known OrderShipmentStatus
Declaration
public static bool TryParse(int status, out OrderShipmentStatus orderStatus)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | status | The value to parse. |
| OrderShipmentStatus | orderStatus | The known status. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if parsed successfully, false otherwise. |
TryParse(String, out OrderShipmentStatus)
Tries to parse a name to a known OrderShipmentStatus
Declaration
public static bool TryParse(string status, out OrderShipmentStatus orderStatus)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | status | The name to parse. |
| OrderShipmentStatus | orderStatus | The known status. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if parsed successfully, false otherwise. |
Implements
System.IEquatable<T>
