Class 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 Detail

      • HelpService

        public HelpService​(TemplateService templateService,
                           BaseConfigProperties baseConfigProperties)
        Autowired constructor
        Parameters:
        templateService - Template service
        baseConfigProperties - 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