| com.flexive.shared.interfaces.ScriptingEngine
All known Subclasses: com.flexive.ejb.beans.ScriptingEngineBean,
| ScriptingEngine | | public interface ScriptingEngine (Code) | | Scripting engine
author:
Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at) |
| Method Summary | |
| FxScriptMappingEntry | createAssignmentScriptMapping(long scriptId, long assignmentId, boolean active, boolean derivedUsage)
| | FxScriptMappingEntry | createAssignmentScriptMapping(FxScriptEvent scriptEvent, long scriptId, long assignmentId, boolean active, boolean derivedUsage)
| | FxScriptInfo | createScript(FxScriptEvent event, String name, String description, String code)
Create a new script
(newly created scripts are set to active per default). | | FxScriptInfo | createScriptFromDropLibrary(String dropName, FxScriptEvent event, String libraryname, String name, String description)
Create a new script based on a script from the library
(newly created scripts are set to active per default). | | FxScriptInfo | createScriptFromLibrary(FxScriptEvent event, String libraryname, String name, String description)
Create a new script based on a script from the library
(newly created scripts are set to active per default). | | FxScriptMappingEntry | createTypeScriptMapping(long scriptId, long typeId, boolean active, boolean derivedUsage)
| | FxScriptMappingEntry | createTypeScriptMapping(FxScriptEvent scriptEvent, long scriptId, long typeId, boolean active, boolean derivedUsage)
| | void | executeDropRunOnceScripts(Parameter<Boolean> param, String dropName)
Execute run-once scripts for drops. | | void | executeDropStartupScripts(String dropName)
Execute start up scripts for a specific drop. | | void | executeRunOnceScripts()
Execute run-once scripts. | | void | executeStartupScripts()
Execute start up scripts. | | public List<String[]> | getAvailableScriptEngines()
| | List<Long> | getByScriptType(FxScriptEvent scriptEvent)
| | public FxScriptInfo | getScriptInfo(long scriptId)
| | public FxScriptInfo[] | getScriptInfos()
| | String | loadScriptCode(long scriptId)
| | FxScriptMapping | loadScriptMapping(Connection _con, long scriptId)
| | void | removeAssignmentScriptMapping(long scriptId, long assignmentId)
| | void | removeAssignmentScriptMappingForEvent(long scriptId, long assignmentId, FxScriptEvent event)
| | void | removeScript(long scriptId)
| | void | removeTypeScriptMapping(long scriptId, long typeId)
| | void | removeTypeScriptMappingForEvent(long scriptId, long typeId, FxScriptEvent event)
| | FxScriptResult | runScript(long scriptId, FxScriptBinding binding)
| | public FxScriptResult | runScript(String name, FxScriptBinding binding, String code)
| | FxScriptResult | runScript(long scriptId)
| | FxScriptMappingEntry | updateAssignmentScriptMappingForEvent(long scriptId, long assignmentId, FxScriptEvent event, boolean active, boolean derivedUsage)
| | void | updateScriptCode(long scriptId, String code)
| | void | updateScriptInfo(long scriptId, FxScriptEvent event, String name, String description, String code, boolean active)
| | void | updateScriptInfo(FxScriptInfoEdit scriptInfo)
| | FxScriptMappingEntry | updateTypeScriptMappingForEvent(long scriptId, long typeId, FxScriptEvent event, boolean active, boolean derivedUsage)
|
| createAssignmentScriptMapping | | FxScriptMappingEntry createAssignmentScriptMapping(long scriptId, long assignmentId, boolean active, boolean derivedUsage) throws FxApplicationException(Code) | | Create a new mapping for assignments with the default FxScriptEvent the script was created with
Parameters:
scriptId - id of the script
Parameters:
assignmentId - id of the assignment
Parameters:
active - mapping is active?
Parameters:
derivedUsage - mapping used in derived assignments? the created entry
throws:
FxApplicationException - on errors |
| createAssignmentScriptMapping | | FxScriptMappingEntry createAssignmentScriptMapping(FxScriptEvent scriptEvent, long scriptId, long assignmentId, boolean active, boolean derivedUsage) throws FxApplicationException(Code) | | Create a new mapping for assignments with with a given FxScriptEvent
Parameters:
scriptEvent - FxScriptEvent for this mapping (on create, save, remove, etc.)
Parameters:
scriptId - id of the script
Parameters:
assignmentId - id of the assignment
Parameters:
active - mapping is active?
Parameters:
derivedUsage - mapping used in derived assignments? the created entry
throws:
FxApplicationException - on errors |
| createTypeScriptMapping | | FxScriptMappingEntry createTypeScriptMapping(long scriptId, long typeId, boolean active, boolean derivedUsage) throws FxApplicationException(Code) | | Create a new mapping for types with the default FxScriptEvent the script was created with
Parameters:
scriptId - id of the script
Parameters:
typeId - id of the type
Parameters:
active - mapping is active?
Parameters:
derivedUsage - mapping used in derived types? the created entry
throws:
FxApplicationException - on errors |
| createTypeScriptMapping | | FxScriptMappingEntry createTypeScriptMapping(FxScriptEvent scriptEvent, long scriptId, long typeId, boolean active, boolean derivedUsage) throws FxApplicationException(Code) | | Create a new mapping for types with a given FxScriptEvent
Parameters:
scriptEvent - FxScriptEvent for this mapping (on create, save, remove, etc.)
Parameters:
scriptId - id of the script
Parameters:
typeId - id of the type
Parameters:
active - mapping is active?
Parameters:
derivedUsage - mapping used in derived types? the created entry
throws:
FxApplicationException - on errors |
| executeDropRunOnceScripts | | void executeDropRunOnceScripts(Parameter<Boolean> param, String dropName) throws FxApplicationException(Code) | | Execute run-once scripts for drops.
run-once scripts are only executed once in the lifetime of a division!
consecutive calls have no effect and nothing will be executed!
param will be set to "true" once the scripts are run and will be checked to be "false" prior to run
Parameters:
param - boolean parameter to mark scripts as being run
Parameters:
dropName - name of the drop (WAR archive name without extension)
throws:
FxApplicationException - if the requested drop is unknown or invalid |
| executeDropStartupScripts | | void executeDropStartupScripts(String dropName) throws FxApplicationException(Code) | | Execute start up scripts for a specific drop. To be called from a filter or the like.
No exceptions are throws since there is no means of user feedback.
If errors occur, they are written to the logfile.
start up scripts are only executed once each time the application server is started.
consecutive calls *will* execute start up scripts again!
Parameters:
dropName - name of the drop (WAR archive name without extension)
throws:
FxApplicationException - if the requested drop is unknown or invalid |
| executeRunOnceScripts | | void executeRunOnceScripts()(Code) | | Execute run-once scripts.
No exceptions are throws since there is no means of user feedback.
If errors occur, they are written to the logfile.
run-once scripts are only executed once in the lifetime of a division!
consecutive calls have no effect and nothing will be executed!
|
| executeStartupScripts | | void executeStartupScripts()(Code) | | Execute start up scripts.
No exceptions are throws since there is no means of user feedback.
If errors occur, they are written to the logfile.
start up scripts are only executed once each time the application server is started.
consecutive calls *will* execute start up scripts again!
|
| getAvailableScriptEngines | | public List<String[]> getAvailableScriptEngines() throws FxApplicationException(Code) | | Get a list containing script extension and script engine info as 2-dimensional String array
list containing script extension and script engine info as 2-dimensional String array
throws:
FxApplicationException - on errors |
| getByScriptType | | List<Long> getByScriptType(FxScriptEvent scriptEvent)(Code) | | Get scripts by their type
Parameters:
scriptEvent - requested script event array of id's by type |
| removeAssignmentScriptMapping | | void removeAssignmentScriptMapping(long scriptId, long assignmentId) throws FxApplicationException(Code) | | Remove a mapping from a script to an assignment (directly mapped, not via inheritance!)
Parameters:
scriptId - id of the script
Parameters:
assignmentId - id of the assignment
throws:
FxApplicationException - on errors |
| removeAssignmentScriptMappingForEvent | | void removeAssignmentScriptMappingForEvent(long scriptId, long assignmentId, FxScriptEvent event) throws FxApplicationException(Code) | | Remove a mapping from a script to an assignment for a specific event
(directly mapped, not via inheritance!)
Parameters:
scriptId - id of the script
Parameters:
assignmentId - id of the assignment
Parameters:
event - the script event
throws:
FxApplicationException - on errors |
| removeScript | | void removeScript(long scriptId) throws FxApplicationException(Code) | | Remove a script (will remove all mappings for this script as well)
Parameters:
scriptId - id of the script and its mappings to remove
throws:
FxApplicationException - on errors |
| removeTypeScriptMapping | | void removeTypeScriptMapping(long scriptId, long typeId) throws FxApplicationException(Code) | | Remove a mapping from a script to a type (directly mapped, not via inheritance!)
Parameters:
scriptId - id of the script
Parameters:
typeId - id of the type
throws:
FxApplicationException - on errors |
| removeTypeScriptMappingForEvent | | void removeTypeScriptMappingForEvent(long scriptId, long typeId, FxScriptEvent event) throws FxApplicationException(Code) | | Remove a mapping from a script to a type (directly mapped, not via inheritance!) for a specific script event
Parameters:
scriptId - id of the script
Parameters:
typeId - id of the type
Parameters:
event - the script event
throws:
FxApplicationException - on errors |
| updateAssignmentScriptMappingForEvent | | FxScriptMappingEntry updateAssignmentScriptMappingForEvent(long scriptId, long assignmentId, FxScriptEvent event, boolean active, boolean derivedUsage) throws FxApplicationException(Code) | | Update a mapping for assignments
Parameters:
scriptId - id of the script
Parameters:
assignmentId - id of the assignment
Parameters:
event - the script event
Parameters:
active - mapping is active?
Parameters:
derivedUsage - mapping used in derived assignments? the updated entry
throws:
FxApplicationException - on errors |
| updateTypeScriptMappingForEvent | | FxScriptMappingEntry updateTypeScriptMappingForEvent(long scriptId, long typeId, FxScriptEvent event, boolean active, boolean derivedUsage) throws FxApplicationException(Code) | | Update a mapping for types
Parameters:
scriptId - id of the script
Parameters:
typeId - id of the type
Parameters:
event - the script event
Parameters:
active - mapping is active?
Parameters:
derivedUsage - mapping used in derived types? the updated entry
throws:
FxApplicationException - on errors |
|
|