Package de.espirit.firstspirit.access
Interface GenerationScriptContext
- All Superinterfaces:
BaseContext
,ProjectScriptContext
,ScriptContext
,SpecialistsBroker
- All Known Subinterfaces:
GenerationContext
Context for a script within the generation task.
- Since:
- 3.0.1
-
Nested Class Summary
Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.BaseContext
BaseContext.Env
-
Method Summary
Modifier and TypeMethodDescriptionProvides access to the generation context.The current generated languageThe current generated TemplateSetboolean
Preview or normal generationboolean
Generate current or releaseReturn the string representation of an object.Methods inherited from interface de.espirit.firstspirit.access.BaseContext
is
Methods inherited from interface de.espirit.firstspirit.access.project.ProjectScriptContext
getProject, getUserService
Methods inherited from interface de.espirit.firstspirit.access.ScriptContext
getConnection, getProperties, getProperty, logDebug, logError, logError, logInfo, logWarning, removeProperty, setProperty
Methods inherited from interface de.espirit.firstspirit.agency.SpecialistsBroker
requestSpecialist, requireSpecialist
-
Method Details
-
getGenerationContext
GenerationContext getGenerationContext()Provides access to the generation context.- Since:
- 4.0.17
-
getLanguage
Language getLanguage()The current generated language- Returns:
- the current generated language
- Since:
- 3.0.1
-
getTemplateSet
TemplateSet getTemplateSet()The current generated TemplateSet- Returns:
- The TemplateSet
- Since:
- 3.0.1
-
isRelease
boolean isRelease()Generate current or release- Returns:
- is release
- Since:
- 3.0.1
-
isPreview
boolean isPreview()Preview or normal generation- Returns:
- is preview
- Since:
- 3.0.1
-
toString
Return the string representation of an object. Same as $CMS_VALUE(object)$ during the generation.- Throws:
Exception
- arbitrary exception which occurs during conversion.- Since:
- 4.0.17
-