Uploaded image for project: 'Webservices REST Module'
  1. Webservices REST Module
  2. RESTWS-311

RESTWS should allow modules to add custom searches to existing resources

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Could
    • Resolution: Fixed
    • Affects Version/s: 2.0
    • Fix Version/s: 2.0
    • Complexity:
      High
    • Sprint:
      RESTWS Sprint - Feb 2013

      Description

      This is related to RESTWS-310. As described in that ticket, only one module can add a custom search to a resource (see Roger-Darius dialog 2012-11-27). This ticket seeks to remove that limitation.

      Can't we do something with a custom annotation something like @SearchHandler(resource,name=null,[required params],[optional params])? The "name" parameter is one way to deal with searches with duplicate signatures, it would identify this search with a known parameter (e.g. search) having the name value. Example:

      @SearchHandler(person,"FindMother",["q"],null) 
      responds to 
      GET .../person?q=whatever&search=FindMother 
      as an alternative to 
      @SearchHander(person,null,["FindMother"],null) 
      responds to 
      GET .../person?FindMother=whatever
      

      We might also need to do something about the way searches can return paginated or unpaginated lists.

        Gliffy Diagrams

          Attachments

            Issue Links

              Attachments-Category-Modification

                Activity

                  People

                  • Assignee:
                    raff Rafal Korytkowski
                    Reporter:
                    r.friedman Roger Friedman
                  • Votes:
                    0 Vote for this issue
                    Watchers:
                    5 Start watching this issue

                    Dates

                    • Created:
                      Updated:
                      Resolved:

                      Time Tracking

                      Estimated:
                      Original Estimate - 3 days
                      3d
                      Remaining:
                      Remaining Estimate - 0 minutes
                      0m
                      Logged:
                      Time Spent - 1 day Time Not Required
                      1d