Class QueryReq

java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
com.netscape.cms.servlet.base.CMSServlet
com.netscape.cms.servlet.request.QueryReq
All Implemented Interfaces:
Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class QueryReq extends CMSServlet
Show paged list of requests matching search criteria.
See Also:
  • Field Details

  • Constructor Details

    • QueryReq

      public QueryReq()
      Constructor
  • Method Details

    • newCMSRequest

      public CMSRequest newCMSRequest()
      Description copied from class: CMSServlet
      Create a new CMSRequest object. This should be overriden by servlets implementing different types of request
      Overrides:
      newCMSRequest in class CMSServlet
      Returns:
      a new CMSRequest object
    • init

      public void init(javax.servlet.ServletConfig sc) throws javax.servlet.ServletException
      initialize the servlet. This servlet uses the template file "queryReq.template" to process the response.
      Specified by:
      init in interface javax.servlet.Servlet
      Overrides:
      init in class CMSServlet
      Parameters:
      sc - servlet configuration, read from the web.xml file
      Throws:
      javax.servlet.ServletException
    • getRequestType

      protected String getRequestType(String p)
    • getRequestState

      protected String getRequestState(String p)
    • validateAuthToken

      public void validateAuthToken(javax.servlet.http.HttpServletRequest request, IAuthToken authToken) throws EBaseException
      Throws:
      EBaseException
    • getFilter

      public String getFilter(javax.servlet.http.HttpServletRequest request)
    • process

      public void process(CMSRequest cmsReq) throws EBaseException
      Process the HTTP request.
      • http.param reqState request state (one of showAll, showWaiting, showInService, showCancelled, showRejected, showCompleted)
      • http.param reqType
      • http.param seqNumFromDown request ID to start at (decimal, or hex if when paging down seqNumFromDown starts with 0x)
      • http.param seqNumFromUp request ID to start at (decimal, or hex if when paging up seqNumFromUp starts with 0x)
      • http.param maxCount maximum number of records to show
      • http.param totalCount total number of records in set of pages
      • http.param direction "up", "down", "begin", or "end"
      Overrides:
      process in class CMSServlet
      Parameters:
      cmsReq - the object holding the request and response information
      Throws:
      EBaseException - if the servlet was unable to satisfactorily process the request
    • doSearch

      protected CMSTemplateParams doSearch(Locale l, String filter, int count, String direction, BigInteger top, BigInteger bottom)
      Perform search based on direction button pressed
      Parameters:
      filter - ldap filter indicating which VLV to search through. This can be 'all requests', 'pending', etc
      count - the number of requests to show per page
      direction - either 'begin', 'end', 'previous' or 'next' (defaults to end)
      top - the number of the request shown on at the top of the current page
      bottom - the number of the request shown on at the bottom of the current page
      Returns: