com.groupdocs.redaction

Class RedactionResult

java.lang.Object

com.groupdocs.redaction.RedactionResult

public class RedactionResult
extends Object

Represents a result of the redaction operation.

Learn more

• More details about redaction results: Redaction basics

Method Summary

Modifier and Type	Method and Description
static RedactionResult	failed(String description) Initializes a new instance of RedactionResult class with Failed status.
String	getErrorMessage() Gets the error message for diagnostics.
RedactionStatus	getStatus() Gets the execution status.
static RedactionResult	partial(String description) Initializes a new instance of RedactionResult class with PartiallyApplied status.
static RedactionResult	skipped(String description) Initializes a new instance of RedactionResult class with Skipped status.
static RedactionResult	successful() Initializes a new instance of RedactionResult class with Applied (successful) status.

Methods inherited from class java.lang.Object

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

Method Detail

failed

public static RedactionResult failed(String description)

Initializes a new instance of RedactionResult class with Failed status.

Parameters:

description - Failure or exception details

Returns:

Failed redaction result

getErrorMessage

public final String getErrorMessage()

Gets the error message for diagnostics.

Returns:

The error message for diagnostics.

getStatus

public final RedactionStatus getStatus()

Gets the execution status.

Returns:

The execution status.

partial

public static RedactionResult partial(String description)

Initializes a new instance of RedactionResult class with PartiallyApplied status.

Parameters:

description - Reason why the operation was not fully applied

Returns:

Partially applied redaction result

skipped

public static RedactionResult skipped(String description)

Initializes a new instance of RedactionResult class with Skipped status.

Parameters:

description - Reason why the operation was skipped

Returns:

Sskipped redaction result

successful

public static RedactionResult successful()

Initializes a new instance of RedactionResult class with Applied (successful) status.

Returns:

Successful redaction result