Table of Contents

Table of Contents

FlexScript Class - List.BackOrder

List.BackOrder

Description

A class that represents a list back order.

List back orders represent pull requests that are waiting to be fulfilled.

Properties

flags The flags used by this back order.
labelProperties Use your own named properties to get/set label values.
labels Accesses a node's labels as nodes.
numRequested The number of things this back order is requesting.
numRequired The number of things this back order is requiring.
puller Gets the variant value of the thing pulling from the list.
query Gets the sql query this back order is using to define the pull requirements.

Methods

remove Removes the back order from the partition.

Details

Do no remove, this fixes the anchor on doc.flexsim.com

List.BackOrder.flags

readonly int flags

Description

The flags used by this back order.

int requireNum = List("ItemList").backOrders()[1].flags;
Do no remove, this fixes the anchor on doc.flexsim.com

List.BackOrder.labelProperties

Variant labelProperties

Description

Use your own named properties to get/set label values.

Works just like labelProperties on treenodes.

Do no remove, this fixes the anchor on doc.flexsim.com

List.BackOrder.labels

readonly labels

Description

Accesses a node's labels as nodes.

Works just like labels on treenodes.

Do no remove, this fixes the anchor on doc.flexsim.com

List.BackOrder.numRequested

readonly double numRequested

Description

The number of things this back order is requesting.

double requestNum = List("ItemList").backOrders()[1].numRequested;
Do no remove, this fixes the anchor on doc.flexsim.com

List.BackOrder.numRequired

readonly double numRequired

Description

The number of things this back order is requiring.

double requireNum = List("ItemList").backOrders()[1].numRequired;
Do no remove, this fixes the anchor on doc.flexsim.com

List.BackOrder.puller

readonly Variant puller

Description

Gets the variant value of the thing pulling from the list.

List("ItemList").backOrders()[1].puller == current;
Do no remove, this fixes the anchor on doc.flexsim.com

List.BackOrder.query

readonly string query

Description

Gets the sql query this back order is using to define the pull requirements.

List("ItemList").backOrders()[1].query.startsWith("WHERE");
Do no remove, this fixes the anchor on doc.flexsim.com

List.BackOrder.remove()

void remove( )

Description

Removes the back order from the partition.

List("ItemList").backOrders()[1].remove();

Use this instead of destroyobject() so the list can keep track of its statistics.