FlexiCaptureProject class

Reference for the FlexiCaptureProject class: list batch types, create and run a batch, and retrieve batch processing results from FlexiCapture 12.

The FlexiCaptureProject class is in the com.abbyy.connectors namespace. It inherits from the AutoCloseable class and provides methods for working with an ABBYY FlexiCapture 12 project.

Methods

getBatchTypeNames

public List<String> getBatchTypeNames()

Gets a list of the names of all the batch types in a project.

Return value

• A list of batch type names

Exceptions

• FlexiCaptureConnectorException – If an error occurs when getting a list of batch type names.

create

public int create(BatchCreationJob job)

Creates a new batch of files on the ABBYY FlexiCapture 12 server and starts processing the batch.

Parameters

• job – A job that creates a new batch on the ABBYY FlexiCapture 12 server.

Return value

• The ID of the batch

Exceptions

• FlexiCaptureConnectorException – If an error occurs when creating a batch.
• NullPointerException – If the input parameter is 0.
• IllegalArgumentException – If the input parameter contains invalid property values.

getResult

public Result getResult(int batchId)

Gets batch processing results from the ABBYY FlexiCapture 12 server.

Parameters

• batchId – The ID of the batch.

Return value

• An object holding the batch processing results

Exceptions

• FlexiCaptureConnectorException – If an error occurs when getting batch processing results.
• IllegalArgumentException – If the input parameter is less than or equal to 0.

close

public void close()

Closes the project.

Related topics

• BatchCreationJob class
• Result class