Package omero.cmd

Interface _HandleOperations

    • Method Summary

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

      • addCallback

        void addCallback​(CmdCallbackPrx cb,
                         Ice.Current __current)
        Add a callback for notifications.
        Parameters:
        __current - The Current object for the invocation.
      • removeCallback

        void removeCallback​(CmdCallbackPrx cb,
                            Ice.Current __current)
        Remove callback for notifications.
        Parameters:
        __current - The Current object for the invocation.
      • getRequest

        Request getRequest​(Ice.Current __current)
        Returns the request object that was used to initialize this handle. Never null.
        Parameters:
        __current - The Current object for the invocation.
      • getResponse

        Response getResponse​(Ice.Current __current)
        Returns a response if this handle has finished execution, otherwise returns null.
        Parameters:
        __current - The Current object for the invocation.
      • getStatus

        Status getStatus​(Ice.Current __current)
        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.
        Parameters:
        __current - The Current object for the invocation.
      • cancel

        boolean cancel​(Ice.Current __current)
                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.
        Parameters:
        __current - The Current object for the invocation.
        Throws:
        LockTimeout
      • close

        void close​(Ice.Current __current)
        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.
        Parameters:
        __current - The Current object for the invocation.