Octobox API  4.1.0
Octobox Scripting API
Public Member Functions
BatchSplittingScriptBaseabstract

Base class for batch splitting scripts. More...

Inheritance diagram for BatchSplittingScriptBase:
ScriptBase

Public Member Functions

abstract List< List< SCDocument > > SplitBatch (SCProcess batch)
 Split the document collection into multiple lists to generate sub batches More...
 

Additional Inherited Members

- Data Fields inherited from ScriptBase
Action< string > LogInfo
 Write text to the Octobox logging at information level. More...
 
Action< string > LogMsg
 Write text to the Octobox logging at normal level. More...
 
- Properties inherited from ScriptBase
SCProcess Batch [get, set]
 Batch object containing global values available to all scripts. More...
 
CancellationToken CancellationToken [get, set]
 Cancellation token that can be checked for process cancellation on long running script actions. More...
 
SourceApplications SourceApplication [get, set]
 Application that called this function. More...
 

Detailed Description

Base class for batch splitting scripts.

Member Function Documentation

◆ SplitBatch()

abstract List<List<SCDocument> > SplitBatch ( SCProcess  batch)
pure virtual

Split the document collection into multiple lists to generate sub batches

Parameters
batch
Returns
A list of document lists that each will be split into a new sub batch. Returning null will result in no split.