Package org.apache.juneau.console.views

Class BulkResult

java.lang.Object

org.apache.juneau.console.views.BulkResult

@BeanType(properties="contractVersion,succeeded,notFound,failed")
public final class BulkResult
extends Object

The response shape of an aggregate-mode bulk action (RowAction.BulkMode.AGGREGATE) — one outcome per id submitted in the matching BulkRequest.

Own, independently-versioned contract

CONTRACT_VERSION is this type's own wire contract, never aliased to VIEW, ACTION_RESULT, or BulkMutateDef.CONTRACT_VERSION — each of those versions what it defines (a view's shape, a single-row action's outcome, a bulk-mutate action list) and this one versions only this response shape.

Example:

@RestPost(path="/changes/abort") public BulkResult abortChanges(@Content BulkRequest request) { BulkResult.Builder result = BulkResult.create(); for (String id : request.ids) { Change change = changeStore.find(id); if (change == null) { result.notFound(id); } else if (!"PENDING".equals(change.state)) { result.failed(new BulkResult.Failure(id, "Change is already merged.")); } else { changeStore.abort(id); result.succeeded(id); } } return result.build(); }

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BulkResult.Builder	A mutable builder for BulkResult.
static final record	BulkResult.Failure	One failed-outcome entry: the id that was submitted, and why it failed.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTRACT_VERSION	This type's own wire contract version.
final String	contractVersion	The frozen contract-version discriminator (always "1").
final List<BulkResult.Failure>	failed	The ids that failed, with a reason each.
final List<String>	notFound	The ids that were submitted but no longer exist.
final List<String>	succeeded	The ids that succeeded.

Method Summary

Modifier and Type	Method	Description
String	contractVersion()	This result's contract version.
static BulkResult.Builder	create()	Starts a new BulkResult.Builder.
List<BulkResult.Failure>	failed()	The ids that failed, with a reason each.
List<String>	notFound()	The ids that were submitted but no longer exist (e.g. deleted between selection and submit).
List<String>	succeeded()	The ids that succeeded.

Methods inherited from class java.lang.Object

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

Field Details

CONTRACT_VERSION

public static final String CONTRACT_VERSION

This type's own wire contract version.

See Also:

• Constant Field Values

contractVersion

public final String contractVersion

The frozen contract-version discriminator (always "1").

succeeded

public final List<String> succeeded

The ids that succeeded.

notFound

public final List<String> notFound

The ids that were submitted but no longer exist.

failed

public final List<BulkResult.Failure> failed

The ids that failed, with a reason each.

Method Details

create

public static BulkResult.Builder create()

Starts a new BulkResult.Builder.

Returns:

A new, empty builder.

contractVersion

public String contractVersion()

This result's contract version.

Returns:

CONTRACT_VERSION.

succeeded

public List<String> succeeded()

The ids that succeeded.

Returns:

An immutable list. Never null.

notFound

public List<String> notFound()

The ids that were submitted but no longer exist (e.g. deleted between selection and submit).

Returns:

An immutable list. Never null.

failed

public List<BulkResult.Failure> failed()

The ids that failed, with a reason each.

Returns:

An immutable list. Never null.