omero.grid

Class _InteractiveProcessorTie

java.lang.Object

Ice.ObjectImpl

omero.grid._InteractiveProcessorDisp

omero.grid._InteractiveProcessorTie

All Implemented Interfaces:

Ice.Object, Ice.TieBase, java.io.Serializable, java.lang.Cloneable, _InteractiveProcessorOperations, _InteractiveProcessorOperationsNC, InteractiveProcessor

public class _InteractiveProcessorTie
extends _InteractiveProcessorDisp
implements Ice.TieBase

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class omero.grid._InteractiveProcessorDisp

__ids

Fields inherited from interface omero.grid.InteractiveProcessor

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_InteractiveProcessorTie(_InteractiveProcessorOperations delegate)
_InteractiveProcessorTie()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object rhs)
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.
int	hashCode()
java.lang.Object	ice_delegate()
void	ice_delegate(java.lang.Object delegate)
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.

Methods inherited from class omero.grid._InteractiveProcessorDisp

___execute, ___expires, ___getJob, ___getResults, ___params, ___setDetach, ___stop, __dispatch, __readImpl, __writeImpl, execute, expires, getJob, getResults, ice_copyStateFrom, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, params, setDetach, stop

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_InteractiveProcessorTie

public _InteractiveProcessorTie()

_InteractiveProcessorTie

public _InteractiveProcessorTie(_InteractiveProcessorOperations delegate)

Method Detail

ice_delegate

public java.lang.Object ice_delegate()

Specified by:

ice_delegate in interface Ice.TieBase

ice_delegate

public void ice_delegate(java.lang.Object delegate)

Specified by:

ice_delegate in interface Ice.TieBase

equals

public boolean equals(java.lang.Object rhs)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

execute

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

Description copied from interface: _InteractiveProcessorOperations

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

Specified by:

execute in interface _InteractiveProcessorOperations

__current - The Current object for the invocation.

Throws:

ServerError

expires

public long expires(Ice.Current __current)

Description copied from interface: _InteractiveProcessorOperations

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

Specified by:

expires in interface _InteractiveProcessorOperations

Parameters:

__current - The Current object for the invocation.

getJob

public Job getJob(Ice.Current __current)

Description copied from interface: _InteractiveProcessorOperations

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

Specified by:

getJob in interface _InteractiveProcessorOperations

Parameters:

__current - The Current object for the invocation.

getResults

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

Description copied from interface: _InteractiveProcessorOperations

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.

Specified by:

getResults in interface _InteractiveProcessorOperations

__current - The Current object for the invocation.

Throws:

ServerError

params

public JobParams params(Ice.Current __current)
                 throws ServerError

Description copied from interface: _InteractiveProcessorOperations

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.

Specified by:

params in interface _InteractiveProcessorOperations

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

setDetach

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

Description copied from interface: _InteractiveProcessorOperations

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

Specified by:

setDetach in interface _InteractiveProcessorOperations

__current - The Current object for the invocation.

Throws:

ServerError

stop

public void stop(Ice.Current __current)
          throws ServerError

Description copied from interface: _InteractiveProcessorOperations

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.

Specified by:

stop in interface _InteractiveProcessorOperations

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError