org.nuxeo.ecm.core.bulk

Interface BulkService

All Superinterfaces:

AsyncService<String,BulkStatus,Map<String,Serializable>>

All Known Implementing Classes:

BulkServiceImpl

public interface BulkService
extends AsyncService<String,BulkStatus,Map<String,Serializable>>

API to manage Bulk Computation.

At this level, there is no verification of the user calling the method against command's user.

This kind of verification has to be done by caller if needed.

Since:

10.2

Method Summary

Modifier and Type	Method and Description
boolean	await(Duration duration) Waits for completion of all bulk commands.
boolean	await(String commandId, Duration duration) Waits for completion of given bulk command.
BulkCommand	getCommand(String commandId) Returns the command or null if the command is not found or aborted.
List<BulkStatus>	getStatuses(String username) Gets the list of action statuses triggered by the given user.
String	submit(BulkCommand command) Submits a BulkCommand that will be processed asynchronously.

Methods inherited from interface org.nuxeo.ecm.core.api.AsyncService

abort, getResult, getStatus

Method Detail

submit

String submit(BulkCommand command)

Submits a BulkCommand that will be processed asynchronously.

Parameters:

command - the command to submit

Returns:

a unique bulk command identifier

getCommand

BulkCommand getCommand(String commandId)

Returns the command or null if the command is not found or aborted.

await

boolean await(String commandId,
              Duration duration)
       throws InterruptedException

Waits for completion of given bulk command.

Parameters:

commandId - the command to wait

duration - the duration to wait

Returns:

true if bulk command completed or false if computation has not finished after the timeout

Throws:

InterruptedException

await

boolean await(Duration duration)
       throws InterruptedException

Waits for completion of all bulk commands.

Parameters:

duration - the duration to wait

Returns:

true if all bulk commands completed or false if one or more has not finished after the timeout

Throws:

InterruptedException

Since:

10.3

getStatuses

List<BulkStatus> getStatuses(String username)

Gets the list of action statuses triggered by the given user.

Parameters:

username - the user name

Returns:

the list of statuses

Since:

10.3