Package org.openxava.web.dwr

Class Descriptions

  • public class Descriptions
extends java.lang.Object
    DWR endpoint to fetch descriptions incrementally for @DescriptionsList. Keeps compatibility with server-side filtering/formatting used by descriptionsEditor.jsp
    Since:
    7.6
    Author:
    Javier Paniza

    • Constructor Summary

      Constructors 
      Constructor Description
      Descriptions()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected static void checkSecurity​(javax.servlet.http.HttpServletRequest request, java.lang.String application, java.lang.String module)  
      protected void cleanRequest()  
      protected static ModuleContext getContext​(javax.servlet.http.HttpServletRequest request)  
      java.lang.String getDescription​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String application, java.lang.String module, java.lang.String propertyKey, java.lang.String value)
      Returns the label (description) for a given key/value of a @DescriptionsList property.
      java.util.List<java.util.Map<java.lang.String,​java.lang.String>> getDescriptions​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String application, java.lang.String module, java.lang.String propertyKey, java.lang.String term, int limit, int offset)
      Returns up to "limit" suggestions filtered by "term" for the given property in the current view/module.
      protected void initRequest​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String application, java.lang.String module)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Descriptions

        public Descriptions()

    • Method Detail

      • initRequest

        protected void initRequest​(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response,
                           java.lang.String application,
                           java.lang.String module)

      • getDescriptions

        public java.util.List<java.util.Map<java.lang.String,​java.lang.String>> getDescriptions​(javax.servlet.http.HttpServletRequest request,
                                                                                              javax.servlet.http.HttpServletResponse response,
                                                                                              java.lang.String application,
                                                                                              java.lang.String module,
                                                                                              java.lang.String propertyKey,
                                                                                              java.lang.String term,
                                                                                              int limit,
                                                                                              int offset)
        Returns up to "limit" suggestions filtered by "term" for the given property in the current view/module.

      • getDescription

        public java.lang.String getDescription​(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response,
                                       java.lang.String application,
                                       java.lang.String module,
                                       java.lang.String propertyKey,
                                       java.lang.String value)
        Returns the label (description) for a given key/value of a @DescriptionsList property. Uses the same preconfigured calculator and formatter stored in session by the JSP.
        Since:
        7.6

      • getContext

        protected static ModuleContext getContext​(javax.servlet.http.HttpServletRequest request)

      • cleanRequest

        protected void cleanRequest()

      • checkSecurity

        protected static void checkSecurity​(javax.servlet.http.HttpServletRequest request,
                                    java.lang.String application,
                                    java.lang.String module)