omero::api::delete::DeleteHandle

Overview

[ "deprecated: use omero::cmd::Handle instead" ] interface DeleteHandle

Returned by IDelete to allow managing of queued delete operations.

This interface is deprecated.

Operation Index

commands: Returns the DeleteCommand instances which were used to create this handle.
report: Returns a report of what happened.
finished: Returns whether processing of all commands has completed, whether successfully or not.
errors: Returns the number of errors that were encountered.
cancel: Prevents further DeleteCommands from being processed and rolls back any changes already made by the transaction.
close: Removes the proxy from the server's adapter.

Operations

DeleteCommands commands() throws ServerError

Returns the DeleteCommand instances which were used to create this handle.

This operation is deprecated.

DeleteReports report() throws ServerError

Returns a report of what happened. Any errors will produce output as well as any warnings, such as "Tag was orphaned" when using the "SOFT" option. An error can be detected by a non-empty string for the DeleteReport::error field.

This operation is deprecated.

bool finished() throws ServerError

Returns whether processing of all commands has completed, whether successfully or not.

This operation is deprecated.

int errors() throws ServerError

Returns the number of errors that were encountered. If greater than zero, then the transaction was rolled back.

This operation is deprecated.

bool cancel() throws ServerError

Prevents further DeleteCommands from being processed and rolls back any changes already made by the transaction. If all commands were already processed, this method returns false to signal that the rollback was not possible.

This operation is deprecated.

void close() throws ServerError

Removes the proxy from the server's adapter. Any calls on this proxy after close will receive an Ice::ObjectNotExistException.

This operation is deprecated.

Home

Index