Version: Beta-4.1.1-r5927-b91

OmeroBlitz Api
Home Previous Up Next Index

omero::api::IScript

Overview

[ "ami", "amd" ] interface IScript extends ServiceInterface

Utility service around the Processor API. See OmeroScripts for more information.

Operation Index

getScripts
This method returns the scripts on the server as by id and name.
getScriptID
Get the id of the script with name, scriptName, the script service ensures that all script names are unique.
uploadScript
Upload the script to the server and get the id.
getScript
Get the script from the server with id.
getScriptWithDetails
Get the script from the server with details from OriginalFile @param id see above @return see above @throws ApiUsageException
getParams
Get the parameters that the script takes.
runScript
Run the script on the server with id, and using the parameters, paramMap.
deleteScript
Delete the script on the server with id.

Operations

ScriptIDNameMap getScripts() throws ServerError

This method returns the scripts on the server as by id and name.

Return Value

see above.

Exceptions

long getScriptID(string name) throws ServerError

Get the id of the script with name, scriptName, the script service ensures that all script names are unique.

Parameters

scriptName
The name of the script.

Return Value

see above.

Exceptions

long uploadScript(string script) throws ServerError

Upload the script to the server and get the id. This method checks that a script with that names does not exist and that the script has parameters.

Parameters

script
see above.

Return Value

The new id of the script.

Exceptions

string getScript(long id) throws ServerError

Get the script from the server with id.

Parameters

id
see above.

Return Value

see above.

Exceptions

RTypeDict getScriptWithDetails(long id) throws ServerError

Get the script from the server with details from OriginalFile

Parameters

id
see above

Return Value

see above

Exceptions

RTypeDict getParams(long id) throws ServerError

Get the parameters that the script takes. This is a key-value pair map, the key being the variable name, and the value the type of the variable.

Parameters

id
see above.

Return Value

see above.

Exceptions

RTypeDict runScript(long id, RTypeDict map) throws ServerError

Run the script on the server with id, and using the parameters, paramMap. The server checks that all the parameters expected by the script are supplied in the paramMap and that their types match. Once executed the script then returns a resultMap which is a key-value pair map, the key being the result variable name and the value being the value of the variable.

Parameters

id
see above.
paramMap
see above.

Return Value

see above.

Exceptions

void deleteScript(long id) throws ServerError

Delete the script on the server with id.

Parameters

id
Id of the script to delete.

Exceptions


Home Previous Up Next Index