omero.cmd

Interface _HandleOperationsNC

All Known Subinterfaces:

Handle

All Known Implementing Classes:

_HandleDisp, _HandleTie

public interface _HandleOperationsNC

Method Summary

Modifier and Type	Method and Description
void	addCallback(CmdCallbackPrx cb) Add a callback for notifications.
boolean	cancel() Attempts to cancel execution of this Request.
void	close() Closes this handle.
Request	getRequest() Returns the request object that was used to initialize this handle.
Response	getResponse() Returns a response if this handle has finished execution, otherwise returns null.
Status	getStatus() Returns a status object for the current execution.
void	removeCallback(CmdCallbackPrx cb) Remove callback for notifications.

Method Detail

addCallback

void addCallback(CmdCallbackPrx cb)

Add a callback for notifications.

removeCallback

void removeCallback(CmdCallbackPrx cb)

Remove callback for notifications.

getRequest

Request getRequest()

Returns the request object that was used to initialize this handle. Never null.

getResponse

Response getResponse()

Returns a response if this handle has finished execution, otherwise returns null.

getStatus

Status getStatus()

Returns a status object for the current execution. This will likely be the same object that would be returned as a component of the Response value. Never null.

cancel

boolean cancel()
        throws LockTimeout

Attempts to cancel execution of this Request. Returns true if cancellation was successful. Returns false if not, in which case likely this request will run to completion.

Throws:

LockTimeout

close

void close()

Closes this handle. If the request is running, then a cancellation will be attempted first. All uses of a handle should be surrounded by a try/finally close block.