com.laserfiche.repository.api.clients

Interface TasksClient

All Known Implementing Classes:

TasksClientImpl

public interface TasksClient

The Laserfiche Repository Tasks API client.

Method Summary

Modifier and Type	Method and Description
boolean	cancelOperation(ParametersForCancelOperation parameters) - Cancels an operation. - Provide an operationToken to cancel the operation, if possible.
OperationProgress	getOperationStatusAndProgress(ParametersForGetOperationStatusAndProgress parameters) - Returns the status of an operation. - Provide an operationToken (returned in other asynchronous routes) to get the operation status, progress, and any errors that may have occurred.

Method Detail

getOperationStatusAndProgress

OperationProgress getOperationStatusAndProgress(ParametersForGetOperationStatusAndProgress parameters)

- Returns the status of an operation.
- Provide an operationToken (returned in other asynchronous routes) to get the operation status, progress, and any errors that may have occurred. When the operation is completed, the Location header can be inspected as a link to the modified resources (if relevant).
- OperationStatus can be one of the following values: NotStarted, InProgress, Completed, or Failed.

Parameters:

parameters - An object of type ParametersForGetOperationStatusAndProgress which encapsulates the parameters of getOperationStatusAndProgress method.

Returns:

OperationProgress The return value

cancelOperation

boolean cancelOperation(ParametersForCancelOperation parameters)

- Cancels an operation.
- Provide an operationToken to cancel the operation, if possible. Should be used if an operation was created in error, or is no longer necessary.
- Rollbacks must be done manually. For example, if a copy operation is started and is halfway complete when canceled, the client application is responsible for cleaning up the files that were successfully copied before the operation was canceled.

Parameters:

parameters - An object of type ParametersForCancelOperation which encapsulates the parameters of cancelOperation method.

Returns:

boolean The return value