org.codice.ddf.admin.configurator

Interface Result<T>

All Known Implementing Classes:

ResultImpl

public interface Result<T>

Provides result information for a specific Configurator operation.

This code is experimental. While this class is functional and tested, it may change or be removed in a future version of the library.

Method Summary

Modifier and Type	Method and Description
Optional<ConfiguratorException>	getError() If an exception occurred during processing, this Optional will contain the exception thrown.
Optional<T>	getOperationData() Gets any operation-specific output data.
Status	getStatus() The final disposition of the operation.
boolean	isOperationSucceeded() Returns the success or failure of a particular operation.

Method Detail

isOperationSucceeded

boolean isOperationSucceeded()

Returns the success or failure of a particular operation.

Returns:

true if the operation committed successfully; else, false.

getStatus

Status getStatus()

The final disposition of the operation.

Returns:

status indicating if the operation committed, rolled back, was skipped, or failed to process correctly

getError

Optional<ConfiguratorException> getError()

If an exception occurred during processing, this Optional will contain the exception thrown.

Returns:

Optional failure exception

getOperationData

Optional<T> getOperationData()

Gets any operation-specific output data.

Returns:

the Optional output data of the associated operation; may be empty