optional forestName parameter on DocumentManager.search() #1196
Description
This task requires declaring a new interface method and passing a new parameter down the call path.
The expectation for this parameter arises from a similar search() overload in QueryManager:
The steps of this task:
- In the DocumentManager interface, add a new search() overload method that takes all of the existing parameters but with an additional String forestName parameter as the last parameter:
Provide JavaDoc for this new interface method by copying the JavaDoc for an existing search() overload and adding documentation for the forestName parameter that's equivalent to the documentation of the forestName parameter on the similar QueryManager.search() method.
- In the DocumentManagerImpl class, modify the private search() method to take an additional String forestName parameter as the last parameter:
Add the @OverRide implementation of the new search() overload method after the last existing @OverRide search() overload method and before the private search() method, returning the result of a call that passes all parameters through to the private search() method.
Modify all calls from the existing @OverRide search() overload methods to the private search() method to pass a final null value as the forestName parameter.
At current line 541, modify the call to getBulkDocuments() to pass the forestName parameter after the null value:
- In the RESTServices interface, modify the getBulkDocuments() interface method to add a String forestName parameter as the last parameter:
- In the OkHttpServices class, modify the @OverRide getBulkDocuments() implementation method to add a String forestName parameter as the last parameter:
At current line 957, modify the call to getBulkDocumentsImpl() to add the forestName parameter as the last parameter:
Modify the getBulkDocumentsImpl() method to add an additional String forestName parameter as the last parameter:
At current line 1093, replace the final null value with the forestName parameter: