RESTWS-923: Filter out retired forms in /forms endpoint #592
Conversation
| String retiredQueryParam = context.getParameter("retired"); | ||
| Boolean retired = null; | ||
| if (retiredQueryParam != null) { | ||
| retired = Boolean.parseBoolean(retiredQueryParam); |
There was a problem hiding this comment.
For retired, use context.getIncludeAll()
There was a problem hiding this comment.
This would include voided/retired in the result set
According to the implementation,
-
If
retiredis null (retiredrequest parameter is not provided) then all forms retired and non-retired are returned. -
If
retiredis not null and evaluates totrue, only retired forms are retrieved. *? -
If
retiredis not null and evaluates tofalse, only non-retired forms are retrieved.
There was a problem hiding this comment.
What i mean is that a REST call which has ?includeAll=false would exclude retired forms if your code just used context.getIncludeAll()
…xt.getIncludeAll for when retired forms are to be included in response
| @@ -194,7 +197,11 @@ protected NeedsPaging<Form> doGetAll(RequestContext context) throws ResponseExce | |||
| */ | |||
| @Override | |||
| protected NeedsPaging<Form> doSearch(RequestContext context) { | |||
| return new NeedsPaging<Form>(Context.getFormService().getForms(context.getParameter("q"), false), context); | |||
| String fuzzyName = context.getParameter("q"); | |||
There was a problem hiding this comment.
You do not even need these variables. You can just directly use the context calls in the getForms API
There was a problem hiding this comment.
True, but to be readable and easy to understand at a glance I thought of extracting the to variables.
|
It would also be great if you added a test for this. But nevertheless, i will merge it. :) |
Description of what I changed
Issue I worked on
see https://issues.openmrs.org/browse/RESTWS-923
Checklist: I completed these to help reviewers :)
[x ] My IDE is configured to follow the code style of this project.
No? Unsure? -> configure your IDE, format the code and add the changes with
git add . && git commit --amendI have added tests to cover my changes. (If you refactored
existing code that was well tested you do not have to add tests)
No? -> write tests and add them to this commit
git add . && git commit --amend[ x] I ran
mvn clean packageright before creating this pull request andadded all formatting changes to my commit.
No? -> execute above command
[x ] All new and existing tests passed.
No? -> figure out why and add the fix to your commit. It is your responsibility to make sure your code works.
[x ] My pull request is based on the latest changes of the master branch.
No? Unsure? -> execute command
git pull --rebase upstream master