_ScriptProcessOperationsNC (omero-blitz 5.8.0 API)

All Superinterfaces:

_ProcessOperationsNC

All Known Subinterfaces:

ScriptProcess

All Known Implementing Classes:

_ScriptProcessDisp, _ScriptProcessTie
```
public interface _ScriptProcessOperationsNC
extends _ProcessOperationsNC
```
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) method for more information.

Method Summary

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

Methods inherited from interface omero.grid._ProcessOperationsNC
_wait, cancel, kill, poll, registerCallback, shutdown, unregisterCallback

- Method Detail
  - getJob
```
ScriptJob getJob()
          throws ServerError
```
    Returns the job which started this process. Several scheduling fields (submitted, scheduledFor, started, finished) may be of interest.
    
    Throws:
    
    ServerError
  - getResults
```
java.util.Map<java.lang.String,RType> getResults(int waitSecs)
                                                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.
    
    Throws:
    
    ServerError
  - setMessage
```
java.lang.String setMessage(java.lang.String message)
                     throws ServerError
```
    Sets the message on the ScriptJob object. This value MAY be overwritten by the server if the script fails.
    
    Throws:
    
    ServerError
  - close
```
void close(boolean detach)
    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.
    
    Throws:
    
    ServerError