omero.grid

Interface _InteractiveProcessorOperations

All Known Subinterfaces:

InteractiveProcessor

All Known Implementing Classes:

_InteractiveProcessorDisp, _InteractiveProcessorTie, InteractiveProcessorI

public interface _InteractiveProcessorOperations

Client facing interface to the background processing framework. If a user needs interactivity, one of these processors should be acquired from the ServiceFactory. Otherwise, a Job can be submitted via JobHandle.

Method Summary

Modifier and Type	Method and Description
ProcessPrx	execute(RMap inputs, Ice.Current __current) Executes an instance of the job returned by getJob() using the given map as inputs.
long	expires(Ice.Current __current) Returns the system clock time in milliseconds since the epoch at which this processor will be reaped.
Job	getJob(Ice.Current __current) Returns the job which defines this processor.
RMap	getResults(ProcessPrx proc, Ice.Current __current) Retrieve the results for the given process.
JobParams	params(Ice.Current __current) Retrieves the parameters needed to be passed in an execution and the results which will be passed back out.
boolean	setDetach(boolean detach, Ice.Current __current) Sets whether or not cancel will be called on the current Process on stop.
void	stop(Ice.Current __current) Clears the current execution of Job from the processor to prepare for another execution.

Method Detail

expires

long expires(Ice.Current __current)

Returns the system clock time in milliseconds since the epoch at which this processor will be reaped.

Parameters:

__current - The Current object for the invocation.

getJob

Job getJob(Ice.Current __current)

Returns the job which defines this processor. This may be only the last job associated with the processor if execute is called multiple times.

Parameters:

__current - The Current object for the invocation.

params

JobParams params(Ice.Current __current)
          throws ServerError

Retrieves the parameters needed to be passed in an execution and the results which will be passed back out. This method is guaranteed to return a non-null value or throw an exception.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

execute

ProcessPrx execute(RMap inputs,
                   Ice.Current __current)
            throws ServerError

Executes an instance of the job returned by getJob() using the given map as inputs.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

getResults

RMap getResults(ProcessPrx proc,
                Ice.Current __current)
         throws ServerError

Retrieve the results for the given process. This will throw an ApiUsageException if called before the process has returned. Use either process.poll() or process.wait() or a ProcessCallback to wait for completion before calling. If the user has not overridden or disabled the output values "stdout" and "stderr", these will be filled with the OriginalFile instances uploaded after completion under the key values of the same name.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

setDetach

boolean setDetach(boolean detach,
                  Ice.Current __current)
           throws ServerError

Sets whether or not cancel will be called on the current Process on stop. If detach is true, then the Process will continue running. Otherwise, _ProcessOperations.cancel(Ice.Current) will be called, before preparing for another run. false by default

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

stop

void stop(Ice.Current __current)
   throws ServerError

Clears the current execution of Job from the processor to prepare for another execution. cancel() will be called on the current Process if detach is set to false.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError