RedactionResult

Inheritance: java.lang.Object

public class RedactionResult

Represents a result of the redaction operation.


Learn more

Methods

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

getStatus()

public final RedactionStatus getStatus()

Gets the execution status.

Returns: RedactionStatus - The execution status.

getErrorMessage()

public final String getErrorMessage()

Gets the error message for diagnostics.

Returns: java.lang.String - The error message for diagnostics.

skipped(String description)

public static RedactionResult skipped(String description)

Initializes a new instance of RedactionResult class with Skipped status.

Parameters:

Parameter Type Description
description java.lang.String Reason why the operation was skipped

Returns: RedactionResult - Sskipped redaction result

partial(String description)

public static RedactionResult partial(String description)

Initializes a new instance of RedactionResult class with PartiallyApplied status.

Parameters:

Parameter Type Description
description java.lang.String Reason why the operation was not fully applied

Returns: RedactionResult - Partially applied redaction result

failed(String description)

public static RedactionResult failed(String description)

Initializes a new instance of RedactionResult class with Failed status.

Parameters:

Parameter Type Description
description java.lang.String Failure or exception details

Returns: RedactionResult - Failed redaction result

successful()

public static RedactionResult successful()

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

Returns: RedactionResult - Successful redaction result