Try our conversational search powered by Generative AI!

AI OnAI Off

Interface IShipmentInventory

Represents inventory operation keys handler for shipment.

Namespace: EPiServer.Commerce.Order
Assembly: Mediachase.Commerce.dll
Version: 12.17.2
Syntax
public interface IShipmentInventory

Properties

OperationKeys

Gets the inventory operation keys map.

Declaration
IDictionary<int, IEnumerable<string>> OperationKeys { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.Int32, System.Collections.Generic.IEnumerable<System.String>>

Methods

AddOperationKeys(ILineItem, IEnumerable<String>)

Adds the inventory operation keys map.

Declaration
void AddOperationKeys(ILineItem lineItem, IEnumerable<string> operationKeys)
Parameters
Type Name Description
ILineItem lineItem

The line item.
System.Collections.Generic.IEnumerable<System.String> operationKeys

The collection of operation keys.

ClearOperationKeys()

Clears all inventory operation keys map.

Declaration
void ClearOperationKeys()

ContainsOperationKeyFor(ILineItem)

Verifies inventory operation keys map with a line item.

Declaration
bool ContainsOperationKeyFor(ILineItem lineItem)
Parameters
Type Name Description
ILineItem lineItem
Returns
Type Description
System.Boolean

GetOperationKeys(ILineItem)

Gets inventory operation keys by line item.

Declaration
IEnumerable<string> GetOperationKeys(ILineItem lineItem)
Parameters
Type Name Description
ILineItem lineItem

The line item.
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>

A collection of operation keys corresponded with the line item, empty list if no key found.

InsertOperationKeys(ILineItem, IEnumerable<String>)

Inserts inventory operation keys map with a line item.

Declaration
bool InsertOperationKeys(ILineItem lineItem, IEnumerable<string> operationKeys)
Parameters
Type Name Description
ILineItem lineItem

The line item.
System.Collections.Generic.IEnumerable<System.String> operationKeys

The collection of operation keys.
Returns
Type Description
System.Boolean

RemoveOperationKey(ILineItem, String)

Removes an inventory operation key map with a line item.

Declaration
bool RemoveOperationKey(ILineItem lineItem, string operationKey)
Parameters
Type Name Description
ILineItem lineItem

The line item.
System.String operationKey

The operation key.
Returns
Type Description
System.Boolean