Package de.espirit.firstspirit.access
Interface ScriptContext
- All Superinterfaces:
BaseContext,SpecialistsBroker
- All Known Subinterfaces:
ClientScriptContext,Content2ScriptContext,GenerationContext,GenerationScriptContext,GuiScriptContext,PermissionServiceScriptContext,ProjectScriptContext,ScheduleContext,WorkflowScriptContext
Common properties:------------------
isWebClient (java.lang.Boolean) - since 4.2.404 - indicates whether this script context is executed in webclient or not.
(Note: This property has been deprecated with 5.0.12, use#isEnv(Env.WEBEDIT)instead)
- Since:
- 2.3.10
-
Nested Class Summary
Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.BaseContext
BaseContext.Env -
Method Summary
Modifier and TypeMethodDescriptionReturn theConnectionfor the script contextString[]Returns an array of property names existing in this context.@Nullable ObjectgetProperty(String name) Returns the property specified by the given name ornullif no property exists with the given namevoidLog a message with DEBUG levelvoidLog a message with ERROR levelvoidLog a message with ERROR level and theerrorthat caused it.voidLog a message with INFO levelvoidlogWarning(String message) Log a message with WARNING levelvoidremoveProperty(String name) Removes the property with the given name.voidsetProperty(String name, Object value) Creates a property entry for the given value identified by the given name.Methods inherited from interface de.espirit.firstspirit.access.BaseContext
isMethods inherited from interface de.espirit.firstspirit.agency.SpecialistsBroker
requestSpecialist, requireSpecialist
-
Method Details
-
getConnection
Connection getConnection()Return theConnectionfor the script context- Returns:
- The
Connectionfor the script context - Since:
- 3.1.170
-
getProperty
Returns the property specified by the given name ornullif no property exists with the given name- Returns:
- the property with the given name or
null - Since:
- 2.3.10
-
setProperty
Creates a property entry for the given value identified by the given name. The created property will be available viagetProperty(String)during the lifetime of this context.- Parameters:
name- the name of the propertyvalue- the value of the property- Since:
- 2.3.10
- See Also:
-
removeProperty
Removes the property with the given name.- Parameters:
name- the of the property to be removed- Since:
- 2.3.10
-
getProperties
String[] getProperties()Returns an array of property names existing in this context.- Since:
- 2.3.10
-
logDebug
Log a message with DEBUG level- Specified by:
logDebugin interfaceBaseContext- Parameters:
message- The message that is to be logged- Since:
- 3.1.158
-
logInfo
Log a message with INFO level- Specified by:
logInfoin interfaceBaseContext- Parameters:
message- The message that is to be logged- Since:
- 3.0.1
-
logWarning
Log a message with WARNING level- Specified by:
logWarningin interfaceBaseContext- Parameters:
message- The message that is to be logged- Since:
- 3.0.1
-
logError
Log a message with ERROR level- Specified by:
logErrorin interfaceBaseContext- Parameters:
message- The message that is to be logged- Since:
- 3.0.1
-
logError
Log a message with ERROR level and theerrorthat caused it.- Specified by:
logErrorin interfaceBaseContext- Parameters:
message- The message that is to be loggedex- TheThrowablethat caused the error- Since:
- 3.0.155
-