Package org.cyclos.services.system

Interface CustomScriptService

All Superinterfaces:

CRUDService<CustomScriptDTO,CustomScriptData,ScriptType>, Service

All Known Subinterfaces:

CustomScriptServiceLocal

All Known Implementing Classes:

CustomScriptServiceImpl, CustomScriptServiceSecurity

public interface CustomScriptService
extends CRUDService<CustomScriptDTO,CustomScriptData,ScriptType>

Service for managing custom scripts

Method Summary

Modifier and Type	Method	Description
SerializableInputStream	getCodeForDebug(CustomScriptVO script)	Returns a ZIP file containing the code for debugging the given script
RunScriptData	getRunData()	Returns data to run arbitrary scripts
ScriptResult	run(@NotNull RunScriptParams params)	Runs an arbitrary script, returning the result
Page<CustomScriptVO>	search(@NotNull CustomScriptQuery params)	Lists all available custom scripts

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

getCodeForDebug

SerializableInputStream getCodeForDebug(CustomScriptVO script)
                                 throws FrameworkException

Returns a ZIP file containing the code for debugging the given script

Throws:

FrameworkException

getRunData

RunScriptData getRunData()
                  throws FrameworkException

Returns data to run arbitrary scripts

Throws:

FrameworkException

run

ScriptResult run(@NotNull
                 @NotNull RunScriptParams params)
          throws FrameworkException

Runs an arbitrary script, returning the result

Throws:

FrameworkException

search

Page<CustomScriptVO> search(@NotNull
                            @NotNull CustomScriptQuery params)
                     throws FrameworkException

Lists all available custom scripts

Throws:

FrameworkException