omero.api

Interface IScript

All Superinterfaces:

_IScriptOperations, _IScriptOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, Ice.Object, ServiceInterface

All Known Implementing Classes:

_IScriptDisp, _IScriptTie

public interface IScript
extends Ice.Object, _IScriptOperations, _IScriptOperationsNC, ServiceInterface

Utility service for managing and launching scripts for execution by the Processor API. Typical usage might include (PYTHON):

 
 sf = client.createSession()
 svc = sf.getScriptService()
 scripts = svc.getScripts()

 if len(scripts) >= 1:
 script_id = svc.keys()\[-1]
 else:
 script_id = svc.uploadScript('/test/my_script.py', SCRIPT_TEXT)

 params = svc.getParams(script_id)

 # You will need to parse the params to create the proper input
 inputs = {}

 # The last parameter is how long to wait as an RInt
 proc = svc.runScript(script_id, inputs, None)
 try:
 cb = omero.scripts.ProcessCallbackI(client, proc)
 while not cb.block(1000): # ms.
 pass
 cb.close()
 rv = proc.getResults(0)
 finally:
 proc.close(False)
 
 

See OMERO.scripts for more information.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ice_staticId
static long	serialVersionUID

Method Summary

Methods inherited from interface omero.api._IScriptOperations

canRunScript_async, deleteScript_async, editScript_async, getParams_async, getScriptID_async, getScripts_async, getScriptsByMimetype_async, getScriptText_async, getScriptWithDetails_async, getUserScripts_async, runScript_async, uploadOfficialScript_async, uploadScript_async, validateScript_async

Methods inherited from interface omero.api._IScriptOperationsNC

canRunScript_async, deleteScript_async, editScript_async, getParams_async, getScriptID_async, getScripts_async, getScriptsByMimetype_async, getScriptText_async, getScriptWithDetails_async, getUserScripts_async, runScript_async, uploadOfficialScript_async, uploadScript_async, validateScript_async

Methods inherited from interface Ice.Object

__dispatch, __read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

ice_staticId

static final java.lang.String ice_staticId

See Also:

Constant Field Values

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values