com.groupdocs.search.results

Class PathDeleteResult

java.lang.Object

com.groupdocs.search.results.PathDeleteResult

public class PathDeleteResult
extends Object

Represents the result of the operation to delete an indexed file or folder from an index.

Learn more

• Delete indexed paths

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PathDeleteResult(boolean isSuccess, String error, String path) Initializes a new instance of the PathDeleteResult class.

Method Summary

Modifier and Type	Method and Description
protected static PathDeleteResult	create(boolean isSuccess, String error, String path)
String	getError() Returns a description of deletion error.
String	getPath() Returns the path to the file or folder to delete.
boolean	isSuccess() Returns the success indicator of the delete operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathDeleteResult

protected PathDeleteResult(boolean isSuccess,
                           String error,
                           String path)

Initializes a new instance of the PathDeleteResult class.

Parameters:

isSuccess - The success indicator of the delete operation.

error - The description of deletion error.

path - The path to the file or folder to delete.

Method Detail

create

protected static PathDeleteResult create(boolean isSuccess,
                                         String error,
                                         String path)

getError

public final String getError()

Returns a description of deletion error.

Returns:

A description of deletion error.

getPath

public final String getPath()

Returns the path to the file or folder to delete.

Returns:

The path to the file or folder to delete.

isSuccess

public final boolean isSuccess()

Returns the success indicator of the delete operation.

Returns:

true if the delete operation was successful; otherwise, returns false.