OpenMRS

Timestamp:

05/24/08 14:37:02 (8 months ago)

Author:

bwolfe

Message:

Merging api-refactoring to trunk [3595]:[4355]

Files:

• openmrs/trunk/src/api/org/openmrs/api/ObsService.java (modified) (9 diffs)

openmrs/trunk/src/api/org/openmrs/api/ObsService.java

@@ -28 +28 @@
-import org.openmrs.api.db.ObsDAO;
-import org.openmrs.util.OpenmrsConstants;
+import org.openmrs.util.OpenmrsConstants.PERSON_TYPE;
-import org.springframework.transaction.annotation.Transactional;
-
-/**
-provides methods for acting on Obs, ObsGroup, and 
-ComplexObs objects.
+deals with saving and getting Obs to/from the
+database
- * 
-
-
-
-
+
+
+
+
+
+
- * 
- * There are also a number of convenience methods for extracting obs
- * pertaining to certain Concepts, people, or encounters
-
+
+
+
+
+
- */
-@Transactional
-
-
+
+
+
+
+
+
-        public static final Integer PERSON = 1;
+        
+        /**
+         * @see org.openmrs.util.OpenmrsConstants
+         * @deprecated Use OpenmrsConstants#PERSON_TYPE.PATIENT
+         */
-        public static final Integer PATIENT = 2;
+        
+        /**
+         * @see org.openmrs.util.OpenmrsConstants
+         * @deprecated Use OpenmrsConstants.PERSON_TYPE.USER
+         */
-        public static final Integer USER = 4;
-
+        /**
+         * Set the given <code>dao</code> on this obs service. 
+         * The dao will act as the conduit through with all obs
+         * calls get to the database
+         * 
+         * @param dao specific ObsDAO to use for this service
+         */
-        public void setObsDAO(ObsDAO dao);
-
@@ -57 +85 @@
-         * @param Obs
-         * @throws APIException
-
-
+
+
+
-        public void createObs(Obs obs) throws APIException;
-
@@ -82 +111 @@
-         * @see #createObsGroup(Obs, List)
-         */
-{OpenmrsConstants.PRIV_ADD_OBS}
+OpenmrsConstants.PRIV_ADD_OBS
-        public void createObsGroup(Obs[] obs) throws APIException;
-
@@ -93 +122 @@
-         */
-        @Transactional(readOnly = true)
-{OpenmrsConstants.PRIV_VIEW_OBS}
+OpenmrsConstants.PRIV_VIEW_OBS
-        public Obs getObs(Integer obsId) throws APIException;
-
@@ -101 +130 @@
-         * @param Obs
-         * @throws APIException
-
-
+
+
+
-        public void updateObs(Obs obs) throws APIException;
+
+        /**
+         * Save the given obs to the database. This will move the
+         * contents of the given <code>obs</code> to the database. This
+         * acts as both the initial save and an update kind of save.
+         * The returned obs will be the same as the obs passed in. It is
+         * included for chaining.
+         * 
+         * If this is an initial save, the obsId on the given
+         * <code>obs</code> object will be updated to reflect the auto
+         * numbering from the database.  The obsId on the returned obs
+         * will also have this number.
+         * 
+         * If there is already an obsId on the given <code>obs</code> object,
+         * the given obs will be voided and a new row in the database will be
+         * created that has a new obs id.
+         * 
+         * @param obs the Obs to save to the database
+         * @param changeMessage String explaining why <code>obs</code> is being changed. If 
+         *              <code>obs</code> is a new obs, changeMessage is nullable, or if 
+         *              it is being updated, it would be required
+         * @return Obs that was saved to the database
+         * @throws APIException
+         */
+        @Authorized({OpenmrsConstants.PRIV_ADD_OBS, OpenmrsConstants.PRIV_EDIT_OBS})
+        public Obs saveObs(Obs obs, String changeMessage) throws APIException;
-
-        /**
@@ -112 +168 @@
-         * @throws APIException
-         */
-{OpenmrsConstants.PRIV_EDIT_OBS}
-void
+OpenmrsConstants.PRIV_EDIT_OBS
+Obs
-
-        /**
@@ -121 +177 @@
-         * @throws APIException
-         */
-
-
-
-
-
+
+
+
+
+
+
-         * 
-         * @param Obs
-         * @throws APIException
-see void
-
-{OpenmrsConstants.PRIV_DELETE_OBS}
+deprecated use #purge
+
+OpenmrsConstants.PRIV_DELETE_OBS
-        public void deleteObs(Obs obs) throws APIException;
-
-        /**
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        public List<MimeType> getMimeTypes() throws APIException;
+
+        /**
+         * Gets all mime types (including retired ones)
+         * 
+         * @return list of MimeTypes in the system
+         * @see #getAllMimeTypes(boolean)
+         * @throws APIException
+         */
+        @Authorized(OpenmrsConstants.PRIV_VIEW_MIME_TYPES)
+        public List<MimeType> getAllMimeTypes() throws APIException;
+        
+        /**
+         * Gets all mime types and disregards the retired ones
+         * if <code>includeRetired</code> is true
+         * 
+         * @param includeRetired true/false of whether to also return the retired ones
+         * @return list of MimeTypes lll
+         * @throws APIException
+         */
+        @Authorized(OpenmrsConstants.PRIV_VIEW_MIME_TYPES)
+        public List<MimeType> getAllMimeTypes(boolean includeRetired) throws APIException;
-
-        /**
@@ -151 +256 @@
-         */
-        @Transactional(readOnly = true)
+        @Authorized(OpenmrsConstants.PRIV_VIEW_MIME_TYPES)
-        public MimeType getMimeType(Integer mimeTypeId) throws APIException;
-
-        /**
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-         * @return
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        public Set<Obs> getObservations(Person who, boolean includeVoided);
-
-        /**
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-         * @return
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        public List<Obs> getLastNObservations(Integer n, Person who,
-                Concept question, boolean includeVoided);
-
-        /**
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-        /**
@@ -236 +409 @@
-         *        sort by obsDatetime
-         * @param personType
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        public Set<Obs> getObservations(Encounter whichEncounter);
-
-        /**
-
-
-
-
-
-
+
+
+
+
-        public List<Obs> getVoidedObservations();
-
-        /**
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-        public List<Obs> findObsByGroupId(Integer obsGroupId);
-        
-        /**
-
-
-
-
-
-
-
-
-
+
+
+
+
-        public List<Obs> getObservations(List<Concept> concepts, Date fromDate, Date toDate, boolean includeVoided);
-
-        /**
-
-
-
-
-
-
-
-
+
+
+
+
-        public List<Obs> getObservations(List<Concept> concepts, Date fromDate, Date toDate);
-
-        
-        /**
-
-
-
-
-
-
-
+
-         */
-        @Transactional(readOnly=true)
+        @Authorized(OpenmrsConstants.PRIV_VIEW_OBS)
-        public List<Obs> getObservations(Cohort patients, List<Concept> concepts, Date fromDate, Date toDate);
+        
-}