omero.grid

Interface _ScriptProcessOperations

All Superinterfaces:

_ProcessOperations

All Known Subinterfaces:

ScriptProcess

All Known Implementing Classes:

_ScriptProcessDisp, _ScriptProcessTie, ScriptProcessI

public interface _ScriptProcessOperations
extends _ProcessOperations

Extension of the Process interface which is returned by IScript when an ScriptJob is launched. It is critical that instances of (@code ScriptProcess} are closed on completion. See the close(boolean, Ice.Current) method for more information.

Method Summary

Modifier and Type	Method and Description
void	close(boolean detach, Ice.Current __current) Closes this process and frees server resources attached to it.
ScriptJob	getJob(Ice.Current __current) Returns the job which started this process.
java.util.Map<java.lang.String,RType>	getResults(int waitSecs, Ice.Current __current) Returns the results immediately if present.
java.lang.String	setMessage(java.lang.String message, Ice.Current __current) Sets the message on the ScriptJob object.

Methods inherited from interface omero.grid._ProcessOperations

_wait, cancel, kill, poll, registerCallback, shutdown, unregisterCallback

Method Detail

getJob

ScriptJob getJob(Ice.Current __current)
          throws ServerError

Returns the job which started this process. Several scheduling fields (submitted, scheduledFor, started, finished) may be of interest.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

getResults

java.util.Map<java.lang.String,RType> getResults(int waitSecs,
                                                 Ice.Current __current)
                                          throws ServerError

Returns the results immediately if present. If the process is not yet finished, waits "waitSecs" before throwing an ApiUsageException. If poll has returned a non-null value, then this method will always return a non-null value.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

setMessage

java.lang.String setMessage(java.lang.String message,
                            Ice.Current __current)
                     throws ServerError

Sets the message on the ScriptJob object. This value MAY be overwritten by the server if the script fails.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

close

void close(boolean detach,
           Ice.Current __current)
    throws ServerError

Closes this process and frees server resources attached to it. If the detach argument is True, then the background process will continue executing. The user can reconnect to the process via the IScript service. If the detach argument is False, then the background process will be shutdown immediately, and all intermediate results (stdout, stderr, ...) will be uploaded.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError