Package uk.ac.warwick.dcs.sherlock.module.web.controllers

Class HelpController

  • @Controller
public class HelpController
extends java.lang.Object
    The controller that deals with the help pages (help centre, terms and privacy policy)

    • Constructor Summary

      Constructors 
      Constructor Description
      HelpController()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String index​(org.springframework.ui.Model model, javax.servlet.http.HttpServletRequest request)
      Handles requests to the help page
      java.lang.String privacy()
      Handles requests to the privacy page
      java.lang.String terms()
      Handles requests to the terms page

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • HelpController

        public HelpController()

    • Method Detail

      • index

        @RequestMapping("/help")
public java.lang.String index​(org.springframework.ui.Model model,
                              javax.servlet.http.HttpServletRequest request)
                       throws LoadingHelpFailed
        Handles requests to the help page
        Parameters:
        model - holder for model attributes (auto-filled by Spring)
        request - the http request information (auto-filled by Spring)
        Returns:
        the path to the help page
        Throws:
        LoadingHelpFailed - if the help.properties file for both the current locale and default failed to load

      • terms

        @RequestMapping("/terms")
public java.lang.String terms()
        Handles requests to the terms page
        Returns:
        the path to the terms page

      • privacy

        @RequestMapping("/privacy")
public java.lang.String privacy()
        Handles requests to the privacy page
        Returns:
        the path to the privacy page