Package com.almis.awe.service
Class HelpService
- java.lang.Object
-
- com.almis.awe.config.ServiceConfig
-
- com.almis.awe.service.HelpService
-
- All Implemented Interfaces:
org.springframework.beans.factory.Aware
,org.springframework.context.ApplicationContextAware
public class HelpService extends ServiceConfig
Context help generation service- Author:
- dgutierrez, pgarcia
-
-
Constructor Summary
Constructors Constructor Description HelpService(TemplateService templateService, BaseConfigProperties baseConfigProperties)
Autowired constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getApplicationHelp()
Generates context help for all applicationServiceData
getApplicationManual(String manualHeader)
Retrieve application manual headerString
getOptionHelp(String optionId)
Generates context help for the actual screen-
Methods inherited from class com.almis.awe.config.ServiceConfig
containsBean, getApplicationContext, getBean, getBean, getElements, getLocale, getLocale, getProperty, getProperty, getRequest, getSession, setApplicationContext
-
-
-
-
Constructor Detail
-
HelpService
public HelpService(TemplateService templateService, BaseConfigProperties baseConfigProperties)
Autowired constructor- Parameters:
templateService
- Template servicebaseConfigProperties
- Base configuration properties
-
-
Method Detail
-
getApplicationHelp
@Cacheable(value="helpTemplates", key="\'default\'") public String getApplicationHelp()
Generates context help for all application- Returns:
- Application help
-
getOptionHelp
@Cacheable(value="helpTemplates", key="#p0") public String getOptionHelp(String optionId)
Generates context help for the actual screen- Parameters:
optionId
- Option identifier- Returns:
- Option help
-
getApplicationManual
public ServiceData getApplicationManual(String manualHeader)
Retrieve application manual header- Parameters:
manualHeader
- Manual header- Returns:
- Application manual
-
-