TRUNK-6250 get observations by visit privilege and documentation fix

openmrs · Jul 23, 2024 · 7ad3eb6 · 7ad3eb6
1 parent b66c022
commit 7ad3eb6
Showing 1 changed file with 16 additions and 2 deletions.
diff --git a/api/src/main/java/org/openmrs/api/ObsService.java b/api/src/main/java/org/openmrs/api/ObsService.java
@@ -501,23 +501,37 @@ public Integer getObservationCount(List<Person> whom, List<Encounter> encounters
 
 	/**
 	 * @see org.openmrs.api.ObsService#getObservations(java.util.List, java.util.List,
-	 *      java.util.List, java.util.List, List, List, java.util.List, java.util.List, java.lang.Integer,
+	 *      java.util.List, java.util.List, List, List, java.util.List, java.lang.Integer,
 	 *      java.lang.Integer, java.util.Date, java.util.Date, boolean, java.lang.String)
 	 *      
+	 * This method works exactly the same; it only adds visits to the search criteria.
+	 * It effectively surpasses the above method; the old one is however kept for backward
+	 * compatibility reasons.
+	 * 
+	 * @param visits List&lt;Visit&gt; to restrict obs to (optional)
+	 *      
 	 * @since 2.7.0
 	 */
+	@Authorized(PrivilegeConstants.GET_OBS)
 	public List<Obs> getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions,
 			List<Concept> answers, List<PERSON_TYPE> personTypes, List<Location> locations, List<String> sort,
 			List<Visit> visits, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate,
 			boolean includeVoidedObs, String accessionNumber) throws APIException;
 
 	/**
 	 * @see org.openmrs.api.ObsService#getObservationCount(java.util.List, java.util.List,
-	 *      java.util.List, java.util.List, java.util.List, java.util.List, java.util.List, java.lang.Integer,
+	 *      java.util.List, java.util.List, java.util.List, java.util.List, java.lang.Integer,
 	 *      java.util.Date, java.util.Date, boolean, java.lang.String)
 	 *      
+	 * This method works exactly the same; it only adds visits to the search criteria.
+	 * It effectively surpasses the above method; the old one is however kept for backward
+	 * compatibility reasons.
+	 * 
+	 * @param visits List&lt;Visit&gt; to restrict obs to (optional)
+	 *      
 	 * @since 2.7.0
 	 */
+	@Authorized(PrivilegeConstants.GET_OBS)
 	public Integer getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions,
 			List<Concept> answers, List<PERSON_TYPE> personTypes, List<Location> locations, List<Visit> visits,
 			Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)