Package de.xima.fc.workflow.itemlist

Class ItemData

java.lang.Object

de.xima.fc.workflow.itemlist.ItemData

public final class ItemData
extends Object

Used internally by the EWorkflowNodeType.FC_FOR_EACH_LOOP to represent the items over which to iterate, depending on the selected EForEachLoopItemListSource.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ItemData.Builder	A builder for a single item of an iteration.

Method Summary

Modifier and Type	Method	Description
static ItemData.Builder	builder(int key)	Creates a builder for a single item of an iteration.
static ItemData.Builder	builder(String key)	Creates a builder for a single item of an iteration.
IWorkflowAttachmentValue	getAttachments()	Attachments to make available while the loop body is executed with the current value.
IWorkflowFileValue	getFiles()	Files to make available while the loop body is executed with the current value.
String	getKey()
INodeExecutionData	getNodeExecutionData()
Object	getValue()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAttachments

public IWorkflowAttachmentValue getAttachments()

Attachments to make available while the loop body is executed with the current value.

Returns:

Attachments to make available.

getFiles

public IWorkflowFileValue getFiles()

Files to make available while the loop body is executed with the current value.

Returns:

Files to make available.

getKey

public String getKey()

Returns:

The key for the item from a loop iteration. This may be either just the loop index itself, e.g. when iterating over a list-like data structure; or the mapping key when iterating over a map-like data structure.

getNodeExecutionData

public INodeExecutionData getNodeExecutionData()

Returns:

Additional data to make available while the loop body is executed with the current value.

getValue

public Object getValue()

Returns:

The item from a loop iteration. For map-like data structures, this is the Map.Entry.getValue().

builder

public static ItemData.Builder builder(String key)

Creates a builder for a single item of an iteration.

Parameters:

key - The key for the item from a loop iteration. This may be either just the loop index itself, e.g. when iterating over a list-like data structure; or the mapping key when iterating over a map-like data structure.

Returns:

A builder for a single item of an iteration.

builder

public static ItemData.Builder builder(int key)

Creates a builder for a single item of an iteration.

Parameters:

key - The key for the item from a loop iteration. This may be either just the loop index itself, e.g. when iterating over a list-like data structure; or the mapping key when iterating over a map-like data structure.

Returns:

A builder for a single item of an iteration.